| Command |
Variable Name |
Parameter(s) |
Description |
BASE_URL
(Reserved) |
baseURL |
<URL> |
Base URL of planned destination. |
| COPY |
N/A
| <Source>,<Destination> |
Source and Destination need to include the full path specification from the DynaDoc location. |
| CSS_PATH |
cssPath |
<pathname> |
CSS files path |
| DOC_TYPE |
docType |
<Document Type> |
Document Type - can be used with a variable in a template or regular page text. |
| EXCLUDED_PAGES |
excludedPages |
<string of characters or digits> |
List of pages to be excluded. If a page definition in the script contains one of these characters the page will be excluded. This can be useful to create boilerplate script with optional pages that can be excluded. See the Page Definitions section for usage. |
| HEADER_BREAK |
headerBreak |
<Header Break> |
Header Break - can be used with a variable in a template or regular page text. Allows the insertion of line breaks in a header such as Product and Doc Type. Defaults to " " (space). |
| HTML_PATH |
htmlPath |
<pathname> |
HTML files path |
| HTML_VERSION |
htmlVersion |
<pathname> |
Alternate HTML folder (for creating multiple document versions in the same project folder). The value of htmlVersion is appended to the HTML folder name. |
| JS_PATH |
jsPath |
<pathname> |
JavsScript files path |
| IMG_PATH |
imgPath |
<pathname> |
Image files path |
| INCLUDE |
N/A |
<filename>,<level> |
Include an external script, and the base level for menu hierarchy. Can include a path (relative to DynaDoc location) and be used recursively. Order of search locations: projDir, rootDir, relative to Dynadoc location. An included file can be referenced using a variable name for the filename. To use a variable for the filename the variable name should be preceded by "@@". The variable and actual filename must be defined as a text substitution in the main SUBLIST. The main SUBLIST is defined as a standard SUBLIST (see the SUBLIST command below), but must be named <scriptName>.sub and be located in the project folder with the script. DynaDoc will resolve the variable name to the file name using the text substitution and then include that file if it exists. |
| INCLUDED_PAGES |
includedPages |
<string of characters or digits> |
List of pages that are to be included, defaults to vpxq$@abcis. If a page definition in the script contains one of these characters the page will be included. Page definitions without any character are included by default. See the Page Definitions section for usage. |
| LOCAL_CSS |
localCSS |
<pathname> |
Project specific CSS file |
| MENU_WIDTH |
menuWidth |
<number> |
Menu width in pixels |
| OUT_DIR |
outDir |
<foldername> |
Output folder (include trailing /) |
| OUT_PATH |
outPath |
<pathname> |
Output path (include trailing /) |
| PAGE_BREAK_LEVEL |
pageBreakLevel |
<level number> |
Page breaks will be added to all pages at this level and all higher levels in the hierarchy. Defaults to 1, the highest level. If set to 3, all pages on levels 1, 2 and 3 will print on a new page. To suppress all page breaks, set PAGE_BREAK_LEVEL to 0. PAGE_BREAK_LEVEL can be overridden on a page by page basis using the @ symbol in the script before the * in the menu level. Example script line to force page break: @*,Copyright,,copyright.htm,,, |
| PRINT_NAME |
printName |
<filename> |
Name of print file. Can be used for printing instructor and student versions. |
| PRINT_VIEW_NAME |
printViewName |
<filename> |
Name of print file for print-view pages. |
| PRODUCT |
product |
<Document Name> |
Document Name - can be used with a variable in a template or regular page text. |
| SUB |
Inline Text Substitution Definition |
<Text substitution placeholder name, text to substitute> |
When an include is found in the content that specifies a text substitution placeholder, the placeholder will be replaced with the text to substitute. The SUB command can be used with SUBLIST.
 SUB text substitutions are defined before page output generation and can be placed anywhere in the script, even at the end. All pages will use the same definition. See the VSUB command if you need to redefine a placeholder during script processing. |
| SUBLIST |
Text Substitution Definition File |
<Text substitution file name, placeholder prefix> |
If numerous text substitutions are to be used, they can be placed in a separate file. The SUBLIST command specifies the file to include, and a placeholder prefix that can be used to simplify input in the file. The substitution file format is text, with the first line blank. Each subsequent line should include the placeholder name followed by a comma and then the text to substitute. If the prefix is included in the SUBLIST command, it should not be included in the placeholders in substitution file, but must still be included in the placeholders in the content files. The SUBLIST command can be used with SUB.
SUBLIST text substitutions are defined before page output generation and can be placed anywhere in the script, even at the end. All pages will use the same definition. See the VSUBLIST command if you need to redefine a placeholder during script processing. |
| TEMPLATE_COVER |
templateCover |
<filename>,<filename>,<filename> |
Print Cover Page Template, print cover page content, and print cover page JavaScript (optional). |
| TEMPLATE_PRINT |
templatePrint |
<filename> |
Print Page Template |
| TEMPLATE_VIEW |
templateView |
<filename> |
View Page Template |
| TOCMENU_IMAGES |
TOCMenuImages |
<blank or 0> |
Add images to menu, default = yes, set to 0 to disable. |
| TOCPRINT_IMAGES |
TOCPrintImages |
<blank or 1> |
Add images to print TOC, default = no, set to 1 to enable. |
| TOCVIEW_IMAGES |
TOCViewImages |
<blank or 0> |
Add images to view TOC, default = yes, set to 0 to disable. |
| VALID_TEXT |
validText |
<string of numbers> |
Used to control which conditional text is included or excluded. VALID_TEXT numbers range from 0 - 9. If a number (#) is included in this list, the corresponding conditional text between <!--#--> and <!--/#--> will be displayed, and text between <!--x#--> and <!--/x#--> will NOT be displayed. See the corresponding tags in the section about Content Blocks. |
| VERSION |
version |
<Document Version> |
Document Version - can be used with a variable in a template or regular page text. |
| VID_PATH |
vidPath |
<pathname> |
Video files path |
| VSUB |
Inline Text Substitution Definition |
<Text substitution placeholder name, text to substitute> |
When an include is found in the content that specifies a text substitution placeholder, the placeholder will be replaced with the text to substitute. The SUB command can be used with SUBLIST.
VSUB text substitutions are defined during page output generation. They can be redefined at any time within the script and the same placeholder can have different values on different pages. This is valuable when a script is auto generated and a page is reused multiple times, but you want different values on each page, such as in a loop. The value is not available on pages in the script before the SUB definition is used. See the SUB command. |
| VSUBLIST |
Text Substitution Definition File |
<Text substitution file name, placeholder prefix> |
If numerous text substitutions are to be used, they can be placed in a separate file. The SUBLIST command specifies the file to include, and a placeholder prefix that can be used to simplify input in the file. The substitution file format is text, with the first line blank. Each subsequent line should include the placeholder name followed by a comma and then the text to substitute. If the prefix is included in the SUBLIST command, it should not be included in the placeholders in substitution file, but must still be included in the placeholders in the content files. The SUBLIST command can be used with SUB.
VSUBLIST text substitutions are defined during page output generation. They can be redefined at any time within the script and the same placeholder have different values on different pages. This is valuable when a script is auto generated and a page is reused multiple times, but you want different values on each page, such as in a loop. The value is not available on pages in the script before the SUB definition is used. See the SUBLIST command. |
DynaDoc variables, or text substitutions can be used for command parameters. The variable name or text substitution placeholder should be preceded by a single "$".
