KVXMLTemplate
This structure defines the overall framework of the XML output. Members in this structure define the XML markup written at specific points in the output stream. The pointers contain XML markup that might include embedded KeyView-defined tokens. The XML markup contained in these strings should be well-formed. For the generated document to be valid, the markup must conform to the Verity DTD. The structure is initialized by calling the fpConvertStream()
or KVXMLConvertFile()
function. See fpConvertStream() or KVXMLConvertFile().
typedef struct tag_KVXMLTemplate { char *pszMainTop; char *pszMainBottom; char *pszFirstH1Start; char *pszFirstH1End; char *pszMiddleH1Start; char *pszMiddleH1End; char *pszLastH1Start; char *pszLastH1End; char *pszH[2..6]XML; char *pszTOCH[1..6]Start; char *pszTOC_H[1..6]; char *pszTOCH[1..6]End; char *pszXFile; char *pszXStartBlock; char *pszXEndBlock; char *pszStartBlock; char *pszEndBlock; BOOL bPutBlocksInSeparateFiles; BOOL bHardPageMakesNewBlock long lcbBlockSize; char *pszChunkTemplate; char *pszUserSummary; char *pszTOCH[1..6]LeafNode; } KVXMLTemplate;
Member Descriptions
The markup and tokens inserted at the beginning of the main XML file. Most of the sample template files feature |
|
pszMainBottom
|
The markup and tokens inserted at the end of the main XML file. |
The markup and tokens inserted at the beginning of the first created H1 XML block (that is, the block associated with the first H1 table of contents entry). |
|
The markup and tokens inserted at the end of the first created H1 XML block (that is, the block associated with the first H1 table of contents entry). |
|
The markup and tokens inserted at the beginning of those H1 XML blocks that are neither the first nor the last H1 blocks created (that is, blocks associated with all but the first and last H1 table of contents entries). |
|
The markup and tokens inserted at the end of those H1 XML blocks that are neither the first nor the last H1 blocks created (that is, blocks associated with all but the first and last H1 table of contents entries). |
|
The markup and tokens inserted at the beginning of the last created H1 XML block (that is, the block associated with the last H1 table of contents entry). |
|
The markup and tokens inserted at the end of the last created H1 XML block (that is, the block associated with the last H1 table of contents entry). |
|
pszH[2..6]XML
|
The markup and tokens inserted in an XML block for heading levels 2 through 6. |
The markup and tokens inserted at the beginning of a table of contents block for heading levels 1 through 6 entries. For example:
|
|
The markup and tokens required to process the table of contents entries for heading levels 1 through 6. For example:
If the table of contents heading contains special characters, such as an ampersand (&) or parentheses, you must use the |
|
The markup and tokens inserted at the end of a table of contents block for heading levels 1 through 6 entries. For example:
|
|
The markup and tokens generated and placed in an extra XML file. This file holds content from the source document. To process this file, you would use the |
|
The markup and tokens inserted at the beginning of each XML block generated by the |
|
The markup and tokens to include in the outoput output at the end of each XML block generated by the |
|
The markup and tokens inserted at the beginning of each block created as a result of |
|
The markup and tokens inserted at the end of each block created as a result of |
|
Set |
|
Set This option applies to word processing documents and spreadsheets only. |
|
The maximum size (in bytes) of heading level 1 XML output files. This number is used as a guideline and can be exceeded to break content at a logical location. This setting is not used when exporting spreadsheets. Setting |
|
If an H1 XML block is subdivided into separate files as a result of the size limitations specified in
|
|
The markup and tokens generated when the
|
|
The markup that replaces |
Discussion
A pointer to this structure is passed as an argument to fpConvertStream()
and KVXMLConvertFile()
. If the pointer to the structure is not NULL
, the values of the members specified in the structure are used. If the pointer to the structure is NULL
, the default values are used.