# Export Tokens

This section contains an alphabetized list of the Export tokens.

Tokens are special strings inserted into the `KVXMLTemplate` structure, `Xml` `TemplateInfo` class, and template files. They are placeholders for markup that appears in the XML output. For example, the `$CHARSET` token marks the place in the XML output where the name of the source document's character set is inserted. It would be used in the tag `<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.

Export Tokens
Token | Description
--- | ---
`$ANCHOR` | Inserts an anchor for a heading level (`h2`-`h6`) for the current block.
`$BASE` | Inserts the base URL for the XML file. Use in the `<base href=xx>` tag.
`$CHARSET` | Inserts the character set of the source document, if that information is ascertainable. Document Readers lists the file formats for which character set information can be determined.
`$CONTENT` | Inserts the content of the metadata field specified by the `$NAME` token. This token is used in conjunction with the `$SUMMARY`, `$USERSUMMARY`, and `$NAME` tokens to insert source document metadata into the XML output. An example of this token's use is:
    pszUserSummary=<MetaData name="$NAME" content="$CONTENT">
Document Readers lists file formats that support metadata.
`$ENDNOTE` | 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.
`$FOOTER` | Inserts the footer from the current block at this point in the output stream.
`$FOOTNOTE` | Inserts footnotes from the current block at this point in the output stream. Currently implemented for Microsoft Word documents only.
`$FOOTNOTEALL` | Inserts all footnotes at this point in the output stream. Currently implemented for Microsoft Word documents only.
`$HEADER` | Inserts the header from the current block at this point in the output stream.
`$MAINURL` | Inserts the URL to the file containing the start of the generated XML, that is, the main output stream.
`$NAME` | 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 XML output. An example of this token's use is:
    pszUserSummary=<MetaData name="$NAME" content="$CONTENT">
The section Document Readers lists file formats that support metadata.
`$NEXT` | Inserts the anchor to the next block. If this is the last block, a link to the first block is inserted.
`$PREV` | Inserts the anchor to the previous block. If the current block is the first block, a link to the last block is inserted.
`$STYLESHEET` | Inserts the path to the style sheet.
`$SUMMARY` | Inserts the data from standard metadata fields using the markup provided in the `pszUserSummary` member of the structure `KVXMLTemplate`. Standard fields are enumerated from 0 to 33 in `KVSumType` in `kvtypes.h`. See the tokens $USERSUMMARY, $NAME, and $CONTENT. The section Document Readers lists file formats that support metadata.
`$SUMMARY` `NN``` | Inserts the data from a specified metadata field. `NN` is a number from 0 through 33 enumerated in the `KVSumType` structure in `kvtypes.h`. An example of this token's use is:
    pszMainTop= <title> $SUMMARY01 </head> <body>
The section Document Readers lists file formats that support metadata.
`$SPLITBLOCKNUMBER` | Inserts the page number for each block generated as a result of `bHardPageMakesNewBlock` or `lcbBlockSize`.
`$TOC` | Inserts the table of contents at this point in the current output stream. This token is typically embedded in `pszMainTop`.
`$TOCB` | Inserts the table of contents at this point for the current block.
`$TOCBE` | Inserts the beginning entry for the table of contents at this point in the current output stream.
`$TOCE` | Inserts a table of contents entry at this point in the current output stream.
`$TOCTE` | Inserts a text entry without XML markup at this point in the current output stream.
`$TOCPE` | Inserts a partial table of contents entry at this point in the current output stream. XML tags are removed; however, character entities are retained. This enables angle brackets to appear in the table of contents entries (for example, `<text>`). Without this token, `<text>` would be interpreted as a non-valid XML tag and would be ignored by the browser.
`$TOPANCHOR` | Inserts the anchor for the top heading level (h1) for the current block.
`$USERCB` | Triggers the callback function `UserCB()` and identifies the callback used in the function.
`$USERSUMMARY` | Inserts the data from every valid non-standard metadata field using the markup provided in the `pszUserSummary` member of the `KVXMLTemplate` structure. Non-standard metadata are any fields not listed from 0 to 33 in `KVSumType`, such as user-defined fields (for example, custom property fields in Word documents), or fields that are unique to a particular file type (for example, "Artist" or "Genre" fields in MP3 files). See the tokens $SUMMARY, $NAME, and $CONTENT. The section Document Readers lists file formats that support metadata.
`$XANCHOR` | Inserts the anchor to an extra file into the XML output. The contents of the extra file is defined by `pszXFile`, and the block generated by this token is defined by `pszXStartBlock` and `pszXEndBlock`.

© Copyright 2006-2020 Micro Focus or one of its affiliates | Send documentation feedback Close Send documentation feedback To open the configured email client on this computer, open an email window. Otherwise, copy the information below to a mail client, and then send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm