Contents - Index


HTML Templates

Docs2Web uses many HTML Templates to build the many different pages of the Doc2Web website.  This section explains all the available fields, tags, and purpose of each template.  These templates can certainly be built from scratch with the information available in this section; however, there is an easier way.  All of these templates will be automatically created for all groups if you browse all the possible pages as shown in the Website Map for every security group.  All of these templates will be created to contain most or all of the possible tags.  They are created as you browse the specific page that contains the different templates.  Once they are created, Docs2Web will not overwrite them.  The templates are created using the most basic HTML, so they should be easy to read and modify.  It is suggested to remove the tags or fields you do not want displayed first.  To start over, simply delete the template and Docs2Web will recreate it if you browse that page again.  The changes can be viewed by saving the template and refreshing the page that uses that HTML template.  The templates can be edited while the Web Server is running, since the Docs2Web application loads the templates as needed.  The look for your Docs2Web website can also be changed by modifying the HTML templates.

Refer to the Website Map for the general navigation of a Docs2Web website and what HTML Template each page uses.  Many of these templates have specific tags that are filled with information from the Docs2Manage database.  There are also a few global tags that are replaced with website information.  These global tags include:

[[#DllPathAndName]] - This is the summation of the "DLL Path", a forward slash, and the filename portion of the "Docs2Web Application Location"(for example: "d2w-cgi-bin/D2W.dll").  This is needed for every form section in the HTML to tell the web server's application location followed by the action the server will submit to the Docs2Web application.  An example of this in HTML code: 
<FORM ACTION="/[[#DllPathAndName]]/dssdosearch" METHOD="GET">
NOTE: In most case this tag should be preceded with a forward slash.

[[#HTTPPath]] - This is replaced with the "HTTP Path" and a forward slash (for example: "HTTP://127.0.0.1:6789/").  This tag is not used in any of the provided templates, since the website should be all HTTP or all HTTPS if you have an SSL certificate.

[[#HTTPSPath]] -  This is replaced with the "HTTPS Path" and a forward slash (for example: "HTTPS://127.0.0.1:6789/").  This tag is not used in any of the provided templates, since the website should be all HTTP or all HTTPS if you have an SSL certificate.

[[CurrentGroupName]] - This tag is replaced with the group name.  This would typically be used on the "Document Search Page" or pages below that in the Website Map on a website where "Search All Groups at Once" option is uncheck in the Configure Docs2Web program.

Group Specific Templates
Many of the HTML templates are considered group specific.  This means that when "Search All Groups at Once" option is unchecked in the Configure Docs2Web program, the template listed below that end with a "_???.htm" will be replaced with the zero-padded group number, which is based on the DOCGROUP_ID database field.  These templates will be created for every group by browsing through every page for every different group.  

HTML Templates
HeaderStartPP.htm- This is the HTML header page (contains the <HTML> tag) for pages that do not require or do not have group specific purpose.  The User Login Page and Error/Status Message Page never use group specific information.  They might be considered the Header for the company or organization.

FooterStartPP.htm- This is just like the HeaderStartPP.htm template, but is the HTML footer page (contains the </HTML> tag).

HeaderPP_???.htm- This is the HTML header page (contains the <HTML> tag) for pages that do have group specific purpose.  All the pages beside the User Login Page, Document Image Page, and Error/Status Message Page use this header.  A Header template will be created for every group in the Docs2Manage database.  This page can be made to give each group its own look or heading.

FooterPP_???.htm- This is just like the HeaderPP_???.htm template, but is the HTML footer page (contains the </HTML> tag).

LoginOnlyPP.htm- This template is a submission form section of the User Login Page.  This section provides (1) a method to log-in to the Docs2Web website and (2) request for a password hint.
Form:
Path is /trylogin
Method is GET or POST
Fields (case sensitive):
LoginName (type: text)- Input field where user can type in their user name to log-in to the website or request for the password hint
Password (type: text)- Input field where user can enter their password to log-in to the website.
Submit Buttons (case sensitive):
Two buttons both named "Submit".  The button that is used to request for a password hint should have the value and purpose "Display Password Hint" and the other is "Log-in".

ErrorTextMsgPP.htm- This template is the body of the Error/Status Message Page.  The tags should not be removed.
Tags:
[[#TheMessage]]- This is replaced with the actual error or status message.
[[#GoBackCaption]]- This is a Java script link to tell the user to return to the last page.  This tag is replaced with the message that reminds the user to go back to the last page.

ChangeGroupSectionPP.htm- This template is a submission form section that allows the user to change group if "Search All Groups at Once" option is uncheck in the Configure Docs2Web program and the user has rights to more than one group.  This template is to be used in the Document Search Page only.
Form:
path is /dssdochangegroups
Method is GET only
Fields (case sensitive):
ChangeGroups (type: select)- This drop-down field populates with the group names (and ID values) a user has rights to.
Submit Buttons (case sensitive):
DSSChangeGroups- Button should have a value of "Change Groups".  When this button is pressed, it will change the group to the new group the user has selected and reload the Document Search Page.

DSSSearchPP_???.htm- This template is a submission form section of the Document Search Page.  Fields in this form used for submitting search criteria are named by the name used in the database field and not by the friendly name as given in the Field Manager in Docs2Manage, but can be labeled as desired in the HTML template.
Form:
path is /dssdosearch
Method is GET only
Fields (case sensitive):
DocNumStart (type: hidden; default: 1)- This field tells the search to start with record 1.  This normally should not be changed.
DocNumEnd (type: hidden; default: 10)- This field tells the search to end with record 10.  This normally should not be changed, unless you change the DocNumIncre field.
DocNumIncre (type: hidden; default: 10)- This field is passed along to the search results and tells how many documents will be displayed per page.
DATESTART (type: text)- This field looks for documents greater than or equal to the provided date against the DOCMAIN.DATEOFDOC field.  Set the value of this field to [[DATESTART]] if you want the field to be filled in with the date of one year ago.  The value can also be set to a literal date like "01/01/2000".
DATEEND (type: text)- This field looks for documents less than or equal to the provided date against the DOCMAIN.DATEOFDOC database field.  Set the value of this field to [[DATEEND]] if you want the field to be filled in with the current date plus one day.
DOCENTITY (type: select or text)- This field looks for documents that fit the given criteria against the DOCMAIN.DOCENTITY field.  If the database field is defined as a Field Edit in Field Manager in Docs2Manage then the search is a contains search, and if the field is defined as a Drop-Down Edit field then the search is an exact match type search.  Docs2Web does not know whether the field is a select or text field in HTML, so Docs2Web relies on how the field is defined in Docs2Manage (Field Manager).
DOCFOLDER (type: select or text)- This field functions just like the "DOCENTITY" fields listed above, but against the DOCMAIN.DOCFOLDER database field.
DOCTYPE (type: select or text)- Same as above- DOCMAIN.DOCTYPE.
DOCSOURCE (type: select or text)- Same as above- DOCMAIN.DOCSOURCE.
IMPORTANCE (type: select or text)- Same as above- DOCMAIN.IMPORTANCE.
DOCREF (type: select or text)- Same as above- DOCMAIN.DOCREF.
DocKeywords (type: text)- This field performs a search like the keyword search in Docs2Manage against all text fields including Document Explorer folder names, OCR results, and all other text fields.  Multiple words can be search by separating the words with spaces.
DoOrSearch (type: checkbox)- When this field is "checked" (value: DoOrSearch) it makes the keyword search perform an "or" search.  If the field is not checked (or doesn't exist) then an "and" search is performed.
Submit Button:
The button name is "DSSSearch" and its value should be "Search".  This button sends the search criteria to the Docs2Web application.
Reset Button:
Does not submit any information, but does reset any drop-down fields back to the first value and clears any text edit fields.
Tags:
[[DATESTART]] or [[DATESTART1YEAR]]- This tag can be placed in the DATESTART text field to fill the that field with the current date less one year.
[[DATESTART2YEAR]]- This tag can be placed in the DATESTART text field to fill the that field with the current date less two years. Also, available: [[DATESTART3YEAR]], [[DATESTART5YEAR]], [[DATESTART10YEAR]], [[DATESTART25YEAR]]
[[DATEEND]]- This tag can be placed in the DATEEND text field to fill the that field with the current date plus one day.  One day is added to assure that the entire current date result are also included, since some databases consider a date as 12am.
[[DOCENTITYCombo]]- This tag tell the Docs2Web application to dynamically create a HTML drop-down field based on the values defined for DOCMAIN.DOCENTITY in Field Manager from Docs2Manage for the specific group the user is logged into.  The resulting drop-down is named "DOCENTITY" to match the name needed to perform the search against that field.
[[DOCFOLDERCombo]]- This tag is just like [[DOCENTITYCombo]], but against the DOCMAIN.DOCFOLDER database field and is named "DOCFOLDER".
[[DOCTYPECombo]]- Same as above.
[[DOCSOURCECombo]]- Same as above.
[[IMPORTANCECombo]]- Same as above.
[[DOCREFCombo]]- Same as above.

DSSResultCountPP.htm- This is used by the Search Results Page and the Document Pages Page.  This section surrounds the results table with current number of results range and the total result count.  This section also adds links to the next or previous set of results.
Tags:
[[#DocNumStart]]- This tag is replaced with the lower result range number for the current set of results.
[[#DocNumEnd]]- This tag is replaced with the upper result range number for the current set of results.
[[#DocNumCount]]- This tag is replaced with the total count of records for the current set of results.
[[#LINKPREVIOUS]]- This is replaced with a link to the prior set of results based on the current range of results.  If the current set of results is the first set, then the link is made inactive (not a link).
[[#LINKNEXT]]- This is replaced with a link to the next set of results based on the current range of results.  If the current set of results is the last set, then the link is made inactive (not a link).

DSSDoSearchHeaderPP_???.htm- This HTML template is the search result table's caption and defines the columns and captions for those columns defined for the Search Results Page.  The number of columns used in the row of column captions should match the number of columns in the data section of the search result in the DSSDoSearchPP_???.htm HTML template.
 
DSSDoSearchPP_???.htm- This HTML template is actually one table row that is filled with the actual result data.  This row is repeated for every row of data returned in the search.  The number of columns used in this table row should match the row used for column captions as defined in the DSSDoSearchHeaderPP_???.htm HTML template.
Tags:
[[#DOC_ID]]- This fills in with the current record's DOCMAIN.DOC_ID.  This is an important tag because the DOC_ID is needed to create thumbnails, links to view, save, or download the document as a PDF.  Please read more about creating these types of links in the Docs2Web Interface for Requesting Images or Files section in this help file.
[[#DATEOFDOC]]- This fills in with the current record's DOCMAIN.DATEOFDOC date field.
[[#DATEENTERED]]- This fills in with the current record's DOCMAIN.DATEENTERED date field.
[[#DOCSOURCE]]- This fills in with the current record's DOCMAIN.DOCENTITY field.
[[#DOCENTITY]]- Same as above.
[[#DOCFOLDER]]- Same as above.
[[#DOCTYPE]]- Same as above.
[[#IMPORTANCE]]- Same as above.
[[#DOCREF]]- Same as above.
[[#NOTES]]- Same as above.
[[#DOCGROUP_ID]]- Same as above.
[[#DOCTREENODE_ID]]- Same as above.
[[#FOLDERNAMESHORT]]- This is filled in the folder name the document is in from the Document Explorer in Docs2Manage.  NOTE: Docs2Web must query the database to retrieve the folder name for every record in the results.  This may slow performance slightly.
[[#FOLDERNAMELONG]]- This is filled with the entire path to the folder the document is in from the Document Explorer in Docs2Manage.  NOTE: Docs2Web must recursively query the database to retrieve the entire folder path for every record in the results.  This may slow performance.
[[#FOLDERNAMELONGCR]]- This is just like the [[#FOLDERNAMELONG]] tag, but includes a line break after every folder name, so the path is displayed on multiple lines.
[[#GROUPNAME]]- This is filled in the group name the document is in from.  NOTE: Docs2Web must query the database to retrieve the group name for every record in the results.  This may slow performance slightly.  If Docs2Web is configured to not Search All Group at Once, the results will all be from the same group.  The group name can be displayed by either modifying the HTML templates that belong to that group to display the group name or use the [[CurrentGroupName]] global tag, which only queries the database once per page.

DSSDocPagesHeaderPP_???.htm- This HTML template is the Document Pages Page table's caption and defines the columns and captions for those columns defined for the Document Pages Page.  The number of columns used in the row of column captions should match the number of columns in the data section of the Document Pages Page in the DSSDocPagesPP_???.htm, DSSDocPagesFilesPP_???.htm, and DSSDocPagesOLEPP_???.htm HTML templates.

DSSDocPagesPP_???.htm (for images)- This HTML template is actually one table row that fills in actual results data when the page record is image-based.  Docs2Web splits up different type document page records because image rows are capable of displaying thumbnails, which is not possible for stored files or OLE documents (Windows Documents).  This row is repeated for every page record for the selected document.  The number of columns used in this table row should match the row used for column captions as defined in the DSSDocPagesHeaderPP_???.htm HTML template.
Tags:
[[#DOC_ID]]- This tag fills in with the current page record's DOCPIC.DOC_ID.  This is an important tag, along with [[#DOCNUM]], because the DOC_ID (and DOCNUM) is needed to create page thumbnails, links to view, save, or download.  Please read more about creating these types of links in the Docs2Web Interface for Requesting Images or Files section of this help file.
[[#DOCNUM]]- This tag is very similar to [[#DOC_ID]], but is against the DOCPIC.DOCNUM field.  This field is also very useful in creating page specific links or thumbnails.  This tag can also be used a page number in the data grid.
[[#SRCFILENAME]]- This tag fills in with data from DOCPIC.SRCFILENAME, which can let the user see which type of file or image that specific page is.
[[#DOCNAME]]-This tag fills in with data from DOCPIC.DOCNAME.
[[#DOCNOTES]]-This tag fills in with data from DOCPIC.DOCNOTES.

DSSDocPagesFilesPP_???.htm (for files)- This HTML template is actually one table row that fills in actual results data when the page record is based on a file.  This type of record cannot have a dynamic thumbnail like an image page record.  However, unlike the OLE format listed in the DSSDocPagesOLEPP_???.htm HTML template, it does allow a link for the viewing of a file embedded in a standard browser as long as the computer which attempt to view the document has the proper software to open files like MS Word, MS Excel, Adobe Acrobat, or AutoCAD files.  

DSSDocPagesOLEPP_???.htm (OLE)- This HTML template is actually one table row that fills in actual results data when the page record is based on Windows OLE format.  This type of record cannot have a dynamic thumbnail like an image page record and can only be downloaded and not viewed in a browser like files. This format depends that the user must have an OLE Viewer, which can be downloaded freely from the Docs2Manage website.

DSSImageInHTMLPP.htm- This HTML template is actually a complete HTML page known as the Document Image Page used for viewing images in a majority of browsers with a viewable image, wrapped in HTML so other important information can be stated with the image.
Tags:
[[#ReqWidth]]- This is the requested width based on the "ReqWidth" parameter when the image was requested.  This is explained more in the Docs2Web Interface for Requesting Images or Files section in this help file. 
[[#NewWidth]]- This is the width of the image being returned from Docs2Web.  If this tag or the [[#NewHeight]], [[#OrigWidth]], or [[#OrigHeight]] tags are used in the DSSImageInHTML.htm HTML template, then Docs2Web must query the image record twice; once to retrieve the image information needed to fill the tags and another to actually return the image.  Because of this, use of any one of these tags can slow performance down.  If this information in not needed, do not use any of those 4 tags.
[[#NewHeight]]- This is the height of the image being returned from Docs2Web.
[[#OrigWidth]]- This is the width of the image in the Docs2Manage database regardless of the image being returned. 
[[#OrigHeight]]- This is the height of the image in the Docs2Manage database regardless of the image being returned. 
[[#DOC_ID]]- This fills in with the current record's DOCMAIN.DOC_ID.
[[#DATEOFDOC]]- This fills in with the current record's DOCMAIN.DATEOFDOC date field.
[[#DATEENTERED]]- This fills in with the current record's DOCMAIN.DATEENTERED date field.
[[#DOCSOURCE]]- This fills in with the current record's DOCMAIN.DOCENTITY field.
[[#DOCENTITY]]- Same as above.
[[#DOCFOLDER]]- Same as above.
[[#DOCTYPE]]- Same as above.
[[#IMPORTANCE]]- Same as above.
[[#DOCREF]]- Same as above.
[[#NOTES]]- Same as above.
[[#DOCGROUP_ID]]- Same as above.
[[#DOCTREENODE_ID]]- Same as above.
[[#FOLDERNAMESHORT]]- This is filled in the folder name the document is in from the Document Explorer in Docs2Manage.  NOTE: Docs2Web must query the database to retrieve the folder name for every record in the results.  This may slow performance slightly.
[[#FOLDERNAMELONG]]- This is filled with the entire path to the folder the document is in from the Document Explorer in Docs2Manage.  NOTE: Docs2Web must recursively query the database several times to retrieve the entire folder path.  This may slow performance.
[[#FOLDERNAMELONGCR]]- This is just like the [[#FOLDERNAMELONG]] tag, but include a line break after every folder name, so the path is displayed on multiple lines.
[[#GROUPNAME]]- This is filled in the group name the document is in from.  NOTE: Docs2Web must query the database to retrieve the group name.  This may slow performance slightly.  If Docs2Web is configured to not Search All Group at Once then the results will all be from the same group.  
[[#DOCNUM]]- This tag is very similar to [[#DOC_ID]], but is against the DOCPIC.DOCNUM field, which is considered to be the page number.
[[#SRCFILENAME]]- This tag fills in with data from DOCPIC.SRCFILENAME, which can let the user see which type of file or image that specific page is.
[[#DOCNAME]]-This tag fills in with data from DOCPIC.DOCNAME.
[[#DOCNOTES]]-This tag fills in with data from DOCPIC.DOCNOTES.