KVHTMLTemplateEx
This structure defines the overall framework of the HTML output. Members in this structure define the HTML markup written at specific points in the output stream. The pointers contain HTML markup that might include embedded KeyView tokens. See Export Tokens for more information on tokens. The structure is initialized by calling the fpConvertStream()
or KVHTMLConvertFile()
function. See fpConvertStream() or KVHTMLConvertFile().
typedef struct tag_KVHTMLTemplateEx { char *pszMainTop; char *pszMainBottom; char *pszFirstH1Start; char *pszFirstH1End; char *pszMiddleH1Start; char *pszMiddleH1End; char *pszLastH1Start; char *pszLastH1End; char *pszH[2..6]HTML; char *pszTOCH[1..6]Start; char *pszTOC_H[1..6]; char *pszTOCH[1..6]End; char *pszXFile; char *pszStartBlock; char *pszEndBlock; BOOL bPutBlocksInSeparateFiles; BOOL bHardPageMakesNewBlock long lcbBlockSize; char *pszChunkTemplate; char *pszTableHTML; BOOL bTableHTMLForSpreadsheetOnly; char *pszUserSummary; char *pszXStartBlock; char *pszXEndBlock; char *pszTOCH[1..6]LeafNode; } KVHTMLTemplateEx;
Member Descriptions
The markup and tokens inserted at the beginning of the main HTML file. Most of the template files feature The default is |
|
The markup and tokens inserted at the end of the main HTML file. This member should at least contain the The default is |
|
The markup and tokens inserted at the beginning of the first created H1 HTML block (that is, the block associated with the first H1 table of contents entry). The default is |
|
The markup and tokens inserted at the end of the first created H1 HTML block (that is, the block associated with the first H1 table of contents entry). The default is |
|
The markup and tokens inserted at the beginning of those H1 HTML 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 default is |
|
The markup and tokens inserted at the end of those H1 HTML 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 default is |
|
The markup and tokens inserted at the beginning of the last created H1 HTML block (that is, the block associated with the last H1 table of contents entry). The default is |
|
The markup and tokens inserted at the end of the last created H1 HTML block (that is, the block associated with the last H1 table of contents entry). The default is |
|
The markup and tokens inserted in an HTML block for heading levels 2 through 6. The default is |
|
The markup and tokens inserted at the beginning of a table of contents block for heading levels 1 through 6 entries. For example:
The default is |
|
The markup and tokens required to process the table of contents entries for heading levels 1 through 6. For example:
The default is |
|
The markup and tokens inserted at the end of a table of contents block for heading levels 1 through 6 entries. For example:
The default is |
|
The markup and tokens generated and placed in an extra HTML file. This file holds content from the source document. For example, it could contain the table of contents (using the For example, if the extra file contains the table of contents in frame-based HTML, set
See Export Tokens for more information on Export tokens. The default is |
|
The markup and tokens inserted at the beginning of each block created as a result of The default is |
|
The markup and tokens inserted at the end of each block created as a result of the of The default is |
|
Set The default is |
|
Set This option applies to word processing documents and spreadsheets only. Page boundaries in PDF documents are considered page breaks. The default is |
|
The maximum size (in bytes) of heading level 1 HTML 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. To use The default is 0. This means that the size is undefined and unlimited. |
|
If a heading level 1 HTML block is subdivided into separate files because the block exceeds the size limitations specified in The page number can be included in the table of contents entry by inserting the
The default is |
|
Specifies the markup (no tokens) inserted at the beginning of each table created during the conversion process. If you set For example, to center the table, set the background color to teal, and set the border width to 13, use:
The default is |
|
If set to The default is |
|
The markup and tokens generated when the tokens
The default is |
|
The markup and tokens inserted at the beginning of each HTML block generated by the The default is |
|
The markup and tokens inserted at the end of each HTML block generated by the The default is |
|
The markup that replaces The default is |
Discussion
A pointer to this structure is passed as an argument to fpConvertStream()
and KVHTMLConvertFile()
. 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.