Go to main content
1/23
Contents
Title and Copyright Information
Preface
Audience
Related Documents
Conventions
Part I Getting Started with HTML Export
1
Introduction
What's New in this Release
Architectural Overview
Definition of Terms
Directory Structure
Installing Multiple SDKs
How to Use HTML Export
2
Implementation Issues
Running in 24x7 Environments
Running in Multiple Threads or Processes
HTML Export Issues
Relative URLs in Templates
Guarantee the References Are Good
Use Absolute URLs
Generate Complete URLs Using {## insert oem=}
Use CGI and the <base> tag
Have HX copy the files using {## copy}
Browser Caching
Errors Returned by HTML Export
CSS Considerations
Customizing CSS Styles
Style Names Used by HTML Export
Overriding HTML Export's Styles
pragma.cssfile and {## link}
XHTML
Archive Support
Using Redirected IO with Archive Files
Temporary File Creation
Empty Directories in Archive Files
Finding the Total Number of Files in an Archive
Positional Frames Support
Limitations of Multimedia File Support
3
Templates
What Is a Template?
The Included Sample Templates
The Document Tree and Its Elements
Leaf Elements
Repeatable Elements
Element Definitions
Default Nodes
Macro Reference
Units: {## unit}, {## header}, and {## footer}
Insert Element: {## insert}
Conditional: {## if}, {## elseif}, and {## else}
Loop: {## repeat}
Linking with Structured Breaking: {## link}
Linking with Content Size Breaking: {## anchor}
Comment Put in the Output File: {## ignore}
Comment Not Put in the Output File: {## comment}
Including Other Templates: {## include}
Setting Options Within the Template: {## option}
Copying Files: {## copy} (HTML Export Only)
Deprecated Template Macros (HTML Export Only)
Breaking Documents by Structure
Indexes and Structure-Based Breaking
Units - Breaking Documents by Content Size
A Sample Size Breaking Template
Templates Without {## unit} Macros
Indexes and Size-Based Breaking
Using Grids to Navigate Spreadsheet and Database Files
Grid Support When Tables Are Not Available
Choosing a Template
Unicode Templates
4
Template Tutorials
Template Comments
Tutorial 1: simple
Tutorial 2: toc1
Tutorial 3: toc2
Tutorial 4: unit
Tutorial 5: misc
Tutorial 6: grids1
Tutorial 7: grids2
Tutorial 8: internal
Part II Using the C/C++ API
5
Windows Implementation Details
Installation
NSF Support
Libraries and Structure
API DLLs
Support DLLs
Engine Libraries
Filter and Export Filter Libraries
Premier Graphics Filters
Additional Files
The Basics
What You Need in Your Source Code
Options and Information Storage
Structure Alignment
Character Sets
Runtime Considerations
Default Font Aliases
Changing Resources
6
UNIX Implementation Details
Installation
NSF Support
Libraries and Structure
API Libraries
Support Libraries
Engine Libraries
Filter and Export Filter Libraries
Premier Graphics Filters
Additional Files
The Basics
What You Need in Your Source Code
Information Storage
Character Sets
Runtime Considerations
X Server Requirement
OLE2 Objects
Machine-Dependent Graphics Context
Signal Handling
Runtime Search Path and $ORIGIN
Environment Variables
Default Font Aliases
Changing Resources
HP-UX Compiling and Linking
HP-UX on RISC
HP-UX on RISC (64 bit)
HP-UX on Itanium (64 bit)
IBM AIX Compiling and Linking
IBM AIX (32-bit pSeries)
IBM AIX PPC (64-bit)
Linux Compiling and Linking
Library Compatibility
Motif Libraries
GLIBC and Compiler Versions
Other Libraries
Compiling and Linking
Linux 32-bit, including Linux PPC
Linux 64-bit
Linux zSeries
Oracle Solaris Compiling and Linking
Oracle Solaris SPARC
Oracle Solaris (SPARC) 64
Oracle Solaris x86
Oracle Solaris x64
Oracle Solaris X Server Display Memory Issue
z/OS Compiling and Linking
7
Data Access Common Functions
Deprecated Functions
DAInitEx
DADeInit
DAOpenDocument
IOSPECLINKEDOBJECT Structure
IOSPECARCHIVEOBJECT Structure
DACloseDocument
DARetrieveDocHandle
DASetOption
DASetFileSpecOption
DAGetOption
DAGetFileId
DAGetFileIdEx
DAGetErrorString
DAGetTreeCount
DAGetTreeRecord
SCCDATREENODE Structure
DAOpenTreeRecord
DASaveTreeRecord
DACloseTreeRecord
DASetStatCallback
DASetFileAccessCallback
8
Export Functions
General Functions
EXOpenExport
EXCALLBACKPROC
EXCloseExport
EXRunExport
EXExportStatus
Annotation Functions
EXHiliteText
HTML Export Usage Notes
EXInsertText
EXHideText
EXANNOHIDETEXT Structure
9
Redirected IO
Using Redirected IO
Opening Files
IOClose
IORead
IOWrite
IOSeek
IOTell
IOGetInfo
IOGENSECONDARY and IOGENSECONDARYW Structures
File Types That Cause IOGETINFO_GENSECONDARY
IOSEEK64PROC / IOTELL64PROC
IOSeek64
IOTell64
10
Callbacks
EX_CALLBACK_ID_CREATENEWFILE
EXURLFILEIOCALLBACKDATA / EXURLFILEIOCALLBACKDATAW Structures
EX_CALLBACK_ID_NEWFILEINFO
EX_CALLBACK_ID_ALTLINK
EX_CALLBACK_ID_CUSTOMELEMENTLIST
EX_CALLBACK_ID_ENTERARCHIVE
EX_CALLBACK_ID_GRAPHICEXPORTFAILURE
EX_CALLBACK_ID_LEAVEARCHIVE
EX_CALLBACK_ID_OEMOUTPUT
EX_CALLBACK_ID_OEMOUTPUT_VER2
EX_CALLBACK_ID_PROCESSELEMENTSTR
EX_CALLBACK_ID_PROCESSELEMENTSTR_VER2
EX_CALLBACK_ID_PROCESSLINK
Links That Reference Objects Using a Relative Path (HTML Export)
EX_CALLBACK_ID_REFLINK
11
Sample Applications
Building the Samples on a Windows System
An Overview of the Sample Applications
batch_process_hx
*sample
export (Windows Only)
The export Main Window
exsimple
exredir
extract_archive
hxanno
Accessing the SDK via a Java Wrapper
The ExJava Wrapper API
The C-Based Exporter Application
Compiling the Executables
The ExportTest Sample Application
An Example Conversion Using the ExJava Wrapper
12
HTML Export C/C++ Options
Character Mapping
SCCOPT_DEFAULTINPUTCHARSET
SCCOPT_EX_CHARBYTEORDER
SCCOPT_EX_OUTPUTCHARACTERSET
SCCOPT_UNMAPPABLECHAR
Output
SCCOPT_EX_CHANGETRACKING
SCCOPT_EX_COLLAPSEWHITESPACE
SCCOPT_EX_EXTRACTEMBEDDEDFILES
SCCOPT_EX_FLAVOR
SCCOPT_EX_NOSOURCEFORMATTING
SCCOPT_EX_SHOWHIDDENSSDATA
SCCOPT_EX_SHOWHIDDENTEXT
SCCOPT_EX_SIMPLESTYLENAMES
SCCOPT_RENDERING_PREFER_OIT
Input Handling
SCCOPT_FALLBACKFORMAT
SCCOPT_FIFLAGS
SCCOPT_FORMATFLAGS
SCCOPT_SYSTEMFLAGS
SCCOPT_IGNORE_PASSWORD
SCCOPT_LOTUSNOTESDIRECTORY
SCCOPT_PARSEXMPMETADATA
SCCOPT_PDF_FILTER_REORDER_BIDI
SCCOPT_TIMEZONE
SCCOPT_HTML_COND_COMMENT_MODE
SCCOPT_PDF_FILTER_DROPHYPHENS
SCCOPT_ARCFULLPATH
SCCOPT_GENERATEEXCELREVISIONS
SCCOPT_PDF_FILTER_MAX_EMBEDDED_OBJECTS
SCCOPT_PDF_FILTER_MAX_VECTOR_PATHS
SCCOPT_PDF_FILTER_WORD_DELIM_FRACTION
Layout
SCCOPT_EX_FALLBACKFONT
SCCUTFALLBACKFONT Structure
SCCOPT_EX_FONTFLAGS
SCCOPT_EX_GENBULLETSANDNUMS
SCCOPT_EX_GRIDADVANCE
SCCOPT_EX_GRIDCOLS
SCCOPT_EX_GRIDROWS
SCCOPT_EX_GRIDWRAP
SCCOPT_EX_JAVASCRIPTTABS
SCCOPT_EX_PAGESIZE
SCCOPT_EX_PREVENTGRAPHICOVERLAP
SCCOPT_EX_TEMPLATE
Using DASetOption to Specify the Template
Using DASetFileSpecOption to Specify the Template
Compression
SCCOPT_FILTERJPG
SCCOPT_FILTERLZW
Graphics
SCCOPT_GIF_INTERLACED
SCCOPT_GRAPHIC_HEIGHTLIMIT
SCCOPT_GRAPHIC_OUTPUTDPI
SCCOPT_GRAPHIC_SIZELIMIT
SCCOPT_GRAPHIC_SIZEMETHOD
SCCOPT_GRAPHIC_TRANSPARENCYCOLOR
SCCOPT_GRAPHIC_TYPE
SCCOPT_GRAPHIC_WIDTHLIMIT
SCCOPT_JPEG_QUALITY
SCCOPT_RENDER_ENABLEALPHABLENDING
Spreadsheet and Database File Rendering
SCCOPT_EX_SHOWSPREADSHEETBORDER
SCCOPT_EX_SSDBBORDER
SCCOPT_EX_SSDBROWCOLHEADINGS
Page Rendering
SCCOPT_WPEMAILHEADEROUTPUT
SCCOPT_MAILHEADERVISIBLE
SCCOPT_MAILHEADERHIDDEN
Font Rendering
SCCOPT_DEFAULTPRINTFONT
SCCVWFONTSPEC Structure
SCCOPT_PRINTFONTALIAS
SCCVWFONTALIAS Structure
SCCOPT_STROKE_TEXT
Callbacks
SCCOPT_EX_CALLBACKS
SCCOPT_EX_UNICODECALLBACKSTR
File System
SCCOPT_IO_BUFFERSIZE
SCCBUFFEROPTIONS Structure
SCCOPT_TEMPDIR
SCCUTTEMPDIRSPEC Structure
SCCOPT_DOCUMENTMEMORYMODE
SCCOPT_REDIRECTTEMPFILE
Template-Only Options
EX_LINKTARGET
EX_LINKTARGETOVERRIDE
Old Options
Discontinued Options
SCCOPT_GIF_SPLASHPALETTE
SCCOPT_EX_COMPLIANCEFLAGS
Option Name Changes
#define Name Changes
Part III Using the Java API
13
Introduction to the Java API
Requirements
Getting Started
Configure the Environment
Generate Code
Create an Exporter Object
Configure the Output
Set the Source and Primary Destination Files
Set the Output Type
Provide a Callback Handler
Run the Export
14
HTML Export Java Classes
Annotation Class
ArchiveNode Class
Callback Class
createNewFile
CreateNewFileResponse Class
newFileInfo
openFile
OpenFileResponse Class
createTempFile
CreateTempFileResponseClass
ColorInfo Class
Exporter Interface
Annotatable Interface
Document Interface
SeekableByteChannel6 Interface
OptionsCache Class
BorderMode
CollapseWhiteSpace
DefaultInputCharacterSet
DefaultRenderFont
DocumentMemoryMode
DropPDFHyphens
EmailHeaders
EnableAlphaBlending
ExtractEmbeddedFiles
FallbackFormat
FontAliasList
GenerateBulletsAndNumbering
GenerateJavascriptTabs
GraphicHeightLimit
GraphicOutputDPI
GraphicSizeLimit
GraphicSizeMethod
GraphicWidthLimit
GridWrap
HTMLFlavor
HTMLOutputFormatting
IECondCommentMode
IgnorePassword
InterlacedGIFs
InternalRendering
ISODateTimes
JPEGQuality
LotusNotesDirectory
OutputChangeTracking
OutputCharacterSet
OutputGraphicType
PageBreakLimit
ParseXMPMetadata
PDFInputMaxEmbeddedObjects
PDFInputMaxVectorPaths
PDFReorderBiDi
PDFWordSpacingFactor
PerformExtendedFI
PreventGraphicOverlap
RenderEmbeddedFonts
ShowArchiveFullPath
ShowColumnHeadings
ShowHiddenSpreadSheetData
ShowHiddenText
SimpleStyleNames
StrictFile
SuppressFontAttributes
TimeZoneOffset
TransparencyColor
UnicodeByteOrder
UnmappableCharacter
ExportStatus Class
FileFormat Class
FontAliases Class
FontInfo Class
FontList Class
GridWrapInfo Class
HighlightTextAnnotation Class
MailHeaders Class
Option Interface
OutsideIn Class
OutsideInException Class
Part IV Using the .NET API
15
Introduction to the .NET API
Requirements
Getting Started
Configuring your Environment
Generate Code
Create an Exporter Object
Configure the Output
Set the Source and Primary Destination Files
Set the Output Type
Provide a Callback Handler
Run the Export
Redirected I/O Support in .NET
16
HTML Export .NET Classes
Annotation Class
ArchiveNode Class
Callback Class
OpenFile
OpenFileResponse Class
CreateNewFile
CreateNewFileResponse Class
NewFileInfo
CreateTempFile
CreateTempFileResponse Class
ColorInfo Class
Exporter Interface
lAnnotatable Interface
Document Interface
OptionsCache Class
BorderMode
CollapseWhiteSpace
DefaultInputCharacterSet
DefaultRenderFont
DocumentMemoryMode
DropPDFHyphens
EmailHeaders
ExtractEmbeddedFiles
FallbackFormat
FontAliasList
GenerateBulletsAndNumbering
GenerateJavascriptTabs
GraphicHeightLimit
GraphicOutputDPI
GraphicSizeLimit
GraphicSizeMethod
GraphicWidthLimit
GridWrap
HTMLFlavor
HTMLOutputFormatting
IECondCommentMode
IgnorePassword
InterlacedGIFs
ISODateTimes
JPEGQuality
LotusNotesDirectory
OutputChangeTracking
OutputCharacterSet
OutputGraphicType
PageBreakLimit
ParseXMPMetadata
PDFInputMaxEmbeddedObjects
PDFInputMaxVectorPaths
PDFReorderBiDi
PDFWordSpacingFactor
PerformExtendedFI
PreventGraphicOverlap
RenderEmbeddedFonts
ShowArchiveFullPath
ShowColumnHeadings
ShowHiddenSpreadSheetData
ShowHiddenText
SimpleStyleNames
StrictFile
SuppressFontAttributes
TimeZoneOffset
TransparencyColor
UnicodeByteOrder
UnmappableCharacter
ExportStatus Class
FileFormat Class
FontAliases Class
FontInfo Class
FontList Class
GridWrapInfo Class
HighlightTextAnnotation Class
MailHeaders Class
Option Interface
OutsideIn Class
OutsideInConfig Class
OutsideInVersion Class
OutsideInCastException Class
OutsideInException Class
Scripting on this page enhances content navigation, but does not change the content in any way.