KeyView 24.1

# 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.

## Set Conversion Options by Using the API

You set conversion options using the following methods on your instance of `XmlExport`:

- `setOptionInfo`
- `setTemplateInfo`
- `setTOCOptionInfo`

For more information about these methods and the options that you can set, refer to the Javadoc supplied with the XML Export SDK.

Alternatively, you can set conversion options by passing the path of an initialization file to the API using the `setIniFileName` method on your instance of `XmlExport`. For more information about initialization files, see Explore Conversion Options with the Sample Programs.

## Explore Conversion Options with the Sample Programs

To make it easier to explore the conversion options, XML Export includes some sample configurations in the form of initialization (`.ini`) files. These are read by the XmlTest sample program (you must supply the `.ini` file path as a command-line argument). The sample program reads the configuration, and converts your input file into XML using the options you set, by passing them into the API. This lets you try out conversion options without programming.

You can use a text editor to customize the configuration files. In general, a section name refers to the structure containing an option, and a parameter name matches an element of that structure. For example:

    [KVXMLOptions]
    eOutputCharSet=KVCS_SJIS
    bForceOutputCharSet=TRUE

This sets the `eOutputCharSet` and `bForceOutputCharSet` elements in the `KVXMLOptions` structure.

NOTE: To create valid XML, an initialization file must define at least two structures: `KVXMLTemplate` and `KVXMLOptions`. Additionally, 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.

### 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 1997-2023 Open Text
Version 24.1 | Last updated December 2023

Send documentation feedback

Close

Send documentation feedback

To send feedback using your default email client, open an email window.

Otherwise, send your feedback and the information below to MFI-swpdl.idoldocsfeedback@opentext.com.

We appreciate your feedback!

Product: IDOL KeyView 24.1

Topic Title: Set Conversion Options