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, web-ready HTML (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 HTML 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 HTML to stripped-down, text-only output suitable for use with an indexing engine.

  • Sample style sheet: WordStyle.css (for word processing documents).

  • Sample files to test HTML Export functionality.

Directory Structure

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

Directory Description
PLATFORM\bin

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

htmlexport\docs

Contains the converted version of the sample word processing, spreadsheet, and presentations files.

htmlexport\guide Contains the HTML Export C Programming Guide and HTML Export Java Programming Guide.
htmlexport\include

Contains the header files for HTML Export.

htmlexport\programs\callback

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

htmlexport\programs\cnv2html

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

htmlexport\programs\cnv2htmloop

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

htmlexport\programs\htmlini

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

htmlexport\programs\images

Contains the background graphics and navigation buttons used by the template files.

htmlexport\programs\ini

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

htmlexport\programs\io_samp

Contains the C source code and supporting files for a sample program that demonstrates how to input a stream by providing a simple wrapper around the ANSI C interface fread(), fopen(), and so on.

htmlexport\programs\pdfini

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

htmlexport\programs\tempout

The default output directory for converted files. Contains a sample style sheet.

htmlexport\programs\tstxtract

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

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 HTML Export's options. You might also find this directory useful when testing your own applications.