Open topic with navigation

# Set Conversion Options

Conversion options are parameters that determine the content, structure, and appearance of the XML output. For example, you can specify

- the markup inserted at the beginning and end of specific XML blocks

- whether a heading is included in the table of contents
- the output character set
- the resolution at which graphics are converted

You can set the conversion options either in the API or in the template files. Regardless of the method used to set the options, the values are ultimately passed to the API and used to populate the following classes:

- `XmlHeadingInfo`
- `XmlOptionInfo`
- `XmlTemplateInfo`
- `XmlTOCOptionInfo`

## Set Conversion Options by Using the API

Use the following classes to set conversion options:

- `XmlHeadingInfo`
- `XmlOptionInfo`
- `XmlTemplateInfo`
- `XmlTOCOptionInfo`

There are methods to get or set the corresponding objects in the `XmlExport` instance. In the `XmlExport` class, the following methods are available:

- `getOptionInfo/setOptionInfo`
- `getTemplateInfo/setTemplateInfo`
- `getTOCOptionInfo/setTOCOptionInfo`

In the `XmlTOCOptionInfo` class, the following methods are available:

- `getXmlHeadingInfo`
- `setXmlHeadingInfo`

## Set Conversion Options by Using the Template Files

XML Export includes templates in the form of initialization files (`.ini`). The templates provide a quick and easy way to modify the conversion options without programming at the API level. However, the template files do not give you complete control of the conversion process. To control some features, you must use the API directly.

You can use a text editor to fully customize the template files. For example, to change the output character set from the default `KVCS_UNKNOWN` to `KVCS_SJIS` in the `default.ini` template, make the change shown in bold below:

    [KVXMLOptions]
    OutputCharSet=KVCS_SJIS
    bUseDocumentColors=TRUE

To create valid XML, a template file must contain two sections: `KVXMLTemplateEx` and `KVXMLOptionsEx.`

NOTE:

If you enter markup in the template files that is not compliant with XML standards, XML Export inserts the markup into the output file unchanged. This might result in a malformed XML file.

An application must then read the template file and write the data to the appropriate Export class. In the sample program `XmlTest`, a template file is supplied as a command-line argument (see XmlTest). In a Java application, the template file is passed using the `setIniFileName` method.

    objXmlExport.setIniFileName(iniFile);

### Templates

The template files for the Java API implementation are in the directory `install``\javaapi\ini\html`, where `install` is the path name of the Export installation directory.

The following templates are provided for the Java implementation.

Template | Description
--- | ---
Callback (`xml1filecallback.ini`) | Based on the single file template (`xml1file.ini`). Implements a user callback named "`UserCB_End_Block` " at the bottom of the main XML file.
Single file with table of contents (`xml1filetoc.ini`) | Creates a single XML file. Creates a table of contents at the top of the XML document. Uses the `Verity.dtd`. Uses an XSL style sheet (`wp.xsl`). Forces the output character set to UTF-8. Lists all metadata (Title, Subject, Author, Comments, Created, Modified, Last Saved By, and Revision Number). Uses the name of the worksheets for spreadsheets. Uses the slide titles for presentations. If no titles are available in the source document, it uses "slide 1," "slide 2," "slide 3," and so on.
XML one file (`xml1file.ini`) | Creates a single XML file. Does not define an XSL style sheet. A default XSL style sheet that is appropriate to the source document type is used. The defaults supplied are `wp.xsl` (for word processing documents), `ss.xsl` (for spreadsheets), `pg.xsl` (for presentations). Forces the output character set to UTF-8. Maintains the source document's fonts and styles. Does not create a table of contents.

© Copyright 2006-2019 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 web mail client, and send this email to swpdl.idoldocsfeedback@microfocus.com. We appreciate your feedback! Product: Topic Title: Help Topic: Feedback:

_FT_HTML5_bannerTitle.htm