| Function |
Syntax |
Explanation |
| Style |
[s STYLENAME CONTENT] |
The [s] command allows you to utilize styles. Styles are defined in the Style Dialog. Styles may be nested (in other words, one Style may invoke another Style, and so forth.) CONTENT appears in the style where (or, if) the [b] tag is found within the style. STYLENAME is an alpha-numeric string with no spaces. CONTENT is any block of text up to the closing ] in the statement. If the style does not use the [b] tag, then if CONTENT is supplied, it is ignored. If the style does use the [b] tag, but CONTENT is not supplied, the [b] tag will be replaced with nothing. |
| Body |
[b] |
This inserts the CONTENT parameter inside a style. May only be used inside a Style Definition at the Style Dialog level (not within the Page Dialog). The CONTENT is parsed for deeper level style information. See also the [raw] tag, below. |
| Images and Animations |
[p IMAGEFILE] |
The [p] command allows you to specify images and animations by name. The documentation system will determine the WIDTH and HEIGHT and fill in a blank ALT tag so that the HTML IMG tag is properly formatted in all cases. If you provide an ALT="" string, it will replace the empty ALT tag. Similarly, if you would like to include ALIGN or BORDER keywords and their associated parameters, do so just as you would for the HTML IMG tag and they will appear in the final HTML source. JPEG and GIF images may be used with this command. |
| Index |
[i TERMSTRING] |
This creates an indexed entry that will be linked to the page, and precise location on the page, where the [i] command is used. TERMSTRING may be one word, or a phrase. It will be sorted into the index in alphabetical order based upon the first word or words in the string. |
| Table of Contents |
[h LEVEL TERMSTRING] |
There are eight levels of Table of Contents entries. TOC entries are automatically included in the Index as well. [h] commands also invoke special pairs of styles that we supply pre-formatted, but you can change them to meet your needs and preferences. One member of the pair (the h member) formats the entry in the actual table of contents, the other member (the lh member) formats the entry on the page where it is used as a heading. These are the (h1 and lh1) through (h8 and lh8) style pairs. LEVEL may be 1 to 8, and TERMSTRING is a word or phrase. |
| Set a Text Register |
[sreg NAME CONTENT] |
This command sets a register that may be invoked using the reg command anywhere in the document after is has been defined. If defined in the Flags area of the Page Dialog, the content of this register is set prior to the invocation of the Page Style that is in scope, which means you can use the command's state in the contenxt of such things as HTML TITLE and METATAG scopes. If defined within the page itself, or within a style used on a page, the value is not available until after it has been defined in the text flow. |
| Set a Page-Local Text Register |
[lsreg NAME CONTENT] |
This command sets a register that may be invoked using the [reg] command anywhere on the page where it is has been defined. Once the page is completed, the register is discarded. This is very useful in styles that need to change in one way or more depending on the page they are used within. If defined in the Flags area of the Page Dialog, the content of this register is set prior to the invocation of the Page Style that is in scope, which means you can use the command's state in the contenxt of such things as HTML TITLE and METATAG scopes. If defined within the page itself, or within a style used on a page, the value is not available until after it has been defined in the text flow. |
| Use a Text Register |
[reg NAME] |
This allows you to insert text into Pages and Styles that was set using either the [sreg] or the [lsreg] commands. |
| Use a Repeat Count |
[rp #|REGISTER CONTENT] |
This allows you to repeat blocks of text using either a number, or a number stored in a text register which was set using either the [sreg] or the [lsreg] commands. The text represented by CONTENT will be repeated the number of times specified by #, or the number inside REGISTER. |
| Logical Flag |
[set NAME STATE] |
This command lets you set a TRUE or FALSE condition, available globally in the document after it is defined, that may be used with the [if] and [ifn] commands, defined below. If defined in the Flags area of the Page Dialog, the content of this register is set prior to the invocation of the Page Style that is in scope, which means you can use the command's state in the contenxt of such things as HTML TITLE and METATAG scopes. If defined within the page itself, or within a style used on a page, the value is not available until after it has been defined in the text flow. |
| Page-Local Logical Flags |
[lset NAME STATE] |
This command lets you set a TRUE or FALSE condition, available on the same page in the document where it is defined, that may be used with the [if] and [ifn] commands, defined below. Once the page is completed, the flag is discarded. If defined in the Flags area of the Page Dialog, the content of this register is set prior to the invocation of the Page Style that is in scope, which means you can use the command's state in the contenxt of such things as HTML TITLE and METATAG scopes. If defined within the page itself, or within a style used on a page, the value is not available until after it has been defined in the text flow. |
| If Conditional |
[if NAME CONTENT] |
In the case of a logical register ([set] and [lset]), this will generate the CONTENT portion of the statement if the flag NAME is TRUE. This also works for text registers. In the case of a text register ([sreg] and [lsreg]), it will generate the content if the register has been set to any value. If the text register has not yet been set (or it is local and has not been defined for the page yet or at all) then the result is FALSE and the CONTENT will not be generated. |
| If Not Conditional |
[ifn NAME CONTENT] |
In the case of a logical register ([set] and [lset]), this will generate the CONTENT portion of the statement if the flag NAME is FALSE or is undefined (that's the same as FALSE.) This also works for text registers. In the case of a text register ([sreg] and [lsreg]), it will generate the content if the register has not been set to any value. If the text register has been set (or it is local and has been set for this page) then the result is TRUE and the CONTENT will not be generated. |
| If LABEL Conditional |
[ifl LABEL CONTENT] |
This will generate the CONTENT portion of the statement if the label (in the Pages Dialog) of the page being processed matches LABEL. If the label of the page does not match LABEL then the result is FALSE and the CONTENT will not be generated. |
| If Not LABEL Conditional |
[ifnl LABEL CONTENT] |
This will generate the CONTENT portion of the statement if the label (in the Pages Dialog) of the page being processed does not match LABEL. If the label of the page does match LABEL then the result is FALSE and the CONTENT will not be generated. |
| If USERFIELD Conditional |
[ifu USERFIELD CONTENT] |
This will generate the CONTENT portion of the statement if the userfield (in the Pages Dialog) of the page being processed matches USERFIELD. If the userfield of the page does not match USERFIELD then the result is FALSE and the CONTENT will not be generated. |
| If Not USERFIELD Conditional |
[ifnu USERFIELD CONTENT] |
This will generate the CONTENT portion of the statement if the userfield (in the Pages Dialog) of the page being processed does not match USERFIELD. If the userfield of the page does match USERFIELD then the result is FALSE and the CONTENT will not be generated. |
| If MANUAL Conditional |
[ifm MANUAL CONTENT] |
This will generate the CONTENT portion of the statement if the manual field of the page being processed (manual, in the Pages dialog) matches MANUAL. If the manual of the page does not match MANUAL then the result is FALSE and the CONTENT will not be generated. |
| If Not MANUAL Conditional |
[ifnm MANUAL CONTENT] |
This will generate the CONTENT portion of the statement if the manual field of the page being processed (manual, in the Pages dialog) does not matche MANUAL. If the manual of the page does match MANUAL then the result is FALSE and the CONTENT will not be generated. |
| Document Version |
[version] |
This inserts the version number as defined in the Manual Dialog. Insertion may occur anywhere in a Style or a Page. |
| Document Revision |
[revision] |
This inserts the revision number as defined in the Manual Dialog. Insertion may occur anywhere in a Style or a Page. |
| Index Filename Insertion |
[index] |
This inserts the filename of the index page. Insertion may occur anywhere in a Style or a Page. |
| Glossary Filename Insertion |
[glossary] |
This inserts the filename of the glossary page. Insertion may occur anywhere in a Style or a Page. |
| Page Number Insertion |
[pagenumber] |
This inserts the current page number. Insertion may occur anywhere in a Style or a Page. |
| Parent Filename Insertion |
[parent] |
This inserts the filename of the Parent page as defined in the Page Dialog. Insertion may occur anywhere in a Style or a Page. |
| Previous Page Filename Insertion |
[prevpage] |
This inserts the filename of the previous page as ordered in the Page Dialog using the SeqNumber setting, unless the ForcePrev control in the Page Dialog contains a filename, in which case it will insert that instead. Insertion may occur anywhere in a Style or a Page. |
| Next Page Filename Insertion |
[postpage] |
This inserts the filename of the next page as ordered in the Page Dialog using the SeqNumber setting, unless the ForceNext control in the Page Dialog contains a filename, in which case it will insert that instead. Insertion may occur anywhere in a Style or a Page. |
| Hotlink |
[hl TARGET LINKEDTEXT] |
The [hl] command is a more efficient way of inserting most links. The HTML syntax for an anchor requires quotation marks and other characters that decrease the efficiency of creating links quite a bit. If your actual link URL's do not contain spaces, then you can use the [hl] command instead of the less efficient HTML sequence:
<a href="TARGET">LINKEDTEXT</a>
[hl TARGET LINKEDTEXT]
You should consider removing all spaces from your URL's; as some operating systems do not handle spaces in URL's and filenames well (or at all.) For instance, Microsoft Windows has a number of problems with filenames that have spaces - many of Window's filesystem handling routines interpret spaces as indicating the end of a filename. If you wish to separate words that make up a URL, we suggest the use of the underline character. Thus:
My Filename.html
...becomes...
My_Filename.html
Using this approach eliminates all operating system issues, which ensures that your URL's will always work as you intended them to, no matter what kind of HTML browser is doing the viewing, or what editor is being used to work with them.
|
| [ character escape |
\[ |
This allows you to insert the "[" character without having it interpreted as a command in the meta language. |
| ] character escape |
\] |
This allows you to insert the "]" character without having it interpreted as a command in the meta language.
NOTE: Watch out for constructions that end containing text with a backslash; for instance, if you were to include a path in a style, like this:
[s mystyle c:\mypath\]
Then the trailing "\" on the path would cause the closing "]" to be ignored. In order to get around this, insert a space after the path (or any character other than a backslash) like this:
[s mystyle c:\mypath\ ]
|
| Raw |
[raw] |
This inserts the CONTENT parameter inside a style. May only be used inside a Style Definition at the Style Dialog level (not within the Page Dialog). This differs from the [b] tag in that the CONTENT parameter is not parsed for additional style information. |
