This section contains an alphabetized list of the Export tokens.
Tokens are special strings inserted into the
structure, TemplateInfo
class, and template files. They are placeholders for markup that appears in the $CHARSET
token marks the place in the <charset=$CHARSET>
.
Word documents are split into blocks by heading level. By default, each section of text between Heading Level 1 headings will be a single block.
See the template files for examples of how to use tokens.
Token |
Description |
---|---|
Inserts an anchor for a heading level ( |
|
Inserts the base URL for the |
|
Inserts the character set of the source document, if that information is ascertainable. Supported Formats lists the file formats for which character set information can be determined. |
|
Inserts the content of the metadata field specified by the
Supported Formats lists file formats that support metadata. |
|
Inserts endnotes from the current block at this point in the output stream. Currently implemented for Microsoft Word documents only. |
|
$ENDNOTEALL
|
Inserts all endnotes at this point in the output stream. Currently implemented for Microsoft Word documents only. |
Inserts the footer from the current block at this point in the output stream. |
|
Inserts footnotes from the current block at this point in the output stream. Currently implemented for Microsoft Word documents only. |
|
Inserts all footnotes at this point in the output stream. Currently implemented for Microsoft Word documents only. |
|
Inserts the header from the current block at this point in the output stream. |
|
Inserts the URL to the file containing the start of the generated |
|
Inserts the name of a metadata field. This token is used in conjunction with the $SUMMARY, $USERSUMMARY, and $CONTENT tokens to insert source document metadata into the
The section Supported Formats lists file formats that support metadata. |
|
Inserts the anchor to the next block. If this is the last block, a link to the first block is inserted. |
|
Inserts the anchor to the previous block. If the current block is the first block, a link to the last block is inserted. |
|
Inserts the path to the style sheet. |
|
Inserts the data from standard metadata fields using the markup provided in the The section Supported Formats lists file formats that support metadata. |
|
Inserts the data from a specified metadata field.
The section Supported Formats lists file formats that support metadata. |
|
Inserts the page number for each block generated as a result of |
|
Inserts the table of contents at this point in the current output stream. This token is typically embedded in |
|
Inserts the table of contents at this point for the current block. |
|
Inserts the beginning entry for the table of contents at this point in the current output stream. |
|
Inserts a table of contents entry at this point in the current output stream. |
|
Inserts a text entry without |
|
Inserts a partial table of contents entry at this point in the current output stream. |
|
Inserts the anchor for the top heading level (h1) for the current block. |
|
Triggers the callback function |
|
Inserts the data from every valid non-standard metadata field using the markup provided in the The section Supported Formats lists file formats that support metadata. |
|
Inserts the anchor to an extra file into the
The contents of the extra file is defined by |
|