Templates
There are two templates - one for the viewing version and one for the print versions. Each template is an HMTL page that embodies the structure and layout of the document, but does not have content. The templates contain tags that are placeholders and are replaced with content or other information during document creation. The use and placement of tags is entirely up to the author and how the results will look depends upon where the tag is placed in the template and any CSS applied.
The following tags are available:
Tag |
Purpose |
<!--##BREADCRUMB_STRING##--> |
Breadcrumb that lists the document path to the page included links to higher levels within the path to the current page |
<!--##CONTENT_1##--> |
Primary content block, usually the main focus of each page |
<!--##CONTENT_2##--> |
Secondary content block, usually used as sidebar text |
<!--##CSS_PATH##--> |
Allows document-based path to CSS files |
<!--##DOC_TYPE##--> |
Document Type, typically displayed as a heading at the top of each page, examples include Operator's Manual or Maintenance Manual |
<!--##EDIT_LINK##--> |
Can be replaced with a link on the html page to allow editing of the htm file using ckeditor or other web-based editor |
<!--##HEADER_BREAK##--> |
Header Break, typically used to force a line break between Product and Doc Type in a header. Defaults to " " (space). |
<!--##HTML_PATH##--> |
Allows document-based path to HTML files |
<!--##IMG_PATH##--> |
Allows document-based path to images |
<!--##JAVASCRIPT##--> |
Allows page based JavaScript |
<!--##JS_PATH##--> |
Allows document-based path to JavaScript |
<!--##LOCAL_CSS##--> |
Allows document-based CSS |
<!--##MENU##--> |
Navigation Menu |
<!--##NEXT##--> |
Next Page button and title (the default button image name is arrow_right_48.png, and arrow_right_dim_48.png for the last page) |
<!--##PAGE_URL##--> |
The URL of the current page, starting from the base URL |
<!--##PREVIOUS##--> |
Previous Page button and title (the default button image name is arrow_left_48.png, and arrow_left_dim_48.png for the first page) |
<!--##PRODUCT##--> |
Document Name, typically displayed as a heading at the top of each page |
<!--##TITLE##--> |
Page title, shows up in the browser tab of the page being viewed |
<!--##VERSION##--> |
Document Version, typically displayed in the footer of each page |
<!--##VID_PATH##--> |
Allows document-based path to videos |
|