Package Contents

To get started with the Export SDK, unzip the package to a directory on your machine.

TIP: The Export SDK packages for non-Windows platforms store the correct file permissions for the files in the SDK (for example, some files must be executable) . OpenText recommends that you unzip the SDK on the platform where you intend to use it. If you unzip the SDK on Windows and then copy the files to a non-Windows machine, the file permissions might be lost.

The Export SDK contains:

  • Libraries and executable files necessary for converting source documents into high-quality, well-formed XML (see Files Required for Redistribution).

  • The include files that define the functions and structures used by the application to establish an interface with Export (see the include directory for XML Export).

  • The Java API implemented in the com.verity.api.export package contained in the KeyView.jar file.

  • Several sample programs that demonstrate Export's functionality.

  • Sample images that can be used as navigation buttons and background textures in your output.

  • Template files that enable you to set conversion options without modifying at the API level. They can be used to generate a wide range of output, from highly-stylized user-defined XML to stripped-down, text-only output suitable for use with an indexing engine.

  • The predefined DTD, Verity.dtd, used to validate all XML output.

  • Sample style sheets: wp.xsl (for word processing documents), ss.xsl (for spreadsheets), and pg.xsl (for presentation graphics).

  • Sample files to test XML Export functionality.

Directory Structure

The following table describes the directories in the XML Export SDK.

Directory Description
PLATFORM\bin

Contains File Content Extraction libraries, supporting files, readers, and the formats_e.ini configuration file.

javaapi\ini

Contains the template files used with the Java API.

javaapi\javadoc

Contains the Javadoc for the Java API.

javaapi\sample

Contains the source files and sample programs for the Java API.

Release Notes Contains the Export SDK Release Notes.
testdocs

Contains sample word processing, spreadsheet, and presentation files that you can use to test XML Export's options. You might also find this directory useful when testing your own applications.

xmlexport\Guides

Contains the XML Export C Programming Guide and XML Export Java Programming Guide.

xmlexport\include

Contains the header files (adinfo.h, kvxml.h, kvcharset.h, kverrorcodes.h, and kvtypes.h) for the C API.

xmlexport\programs\cnv2xml

Contains the C source code files for a sample program that creates a single XML file. The executable for this sample program is in the bin directory.

xmlexport\programs\cnv2xmloop

Contains the C source code for a sample program that creates a single XML file out-of-process.

xmlexport\programs\ini

Contains the template files used to set the conversion options in the C API.

xmlexport\programs\metadata

Contains the C source code and supporting files for a sample program that creates a valid XML file containing only the document's metadata.

xmlexport\programs\pdfini

Contains the template file used to extract custom metadata from PDF documents.

xmlexport\programs\tempout

The default output directory for converted files. Contains the KeyView DTD, sample style sheets, and character entity files. These files are required for viewing the converted XML files.

xmlexport\programs\tstxtract

Contains the C source code and supporting files for a sample program that demonstrates the File Extraction interface.

xmlexport\programs\xmlcallback

Contains the C source code and supporting files for a sample program that demonstrates how user callbacks can dynamically shape the XML conversion.

xmlexport\programs\xmlini

Contains the C source code and supporting files for a sample program that uses template files to set the conversion options.