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
1.1
Architectural Overview
1.2
Definition of Terms
1.3
Directory Structure
1.3.1
Installing Multiple SDKs
1.4
How to Use HTML Export
2
Implementation Issues
2.1
Running in 24x7 Environments
2.2
Running in Multiple Threads or Processes
2.3
HTML Export Issues
2.3.1
Relative URLs in Templates
2.3.1.1
Guarantee the References Are Good
2.3.1.2
Use Absolute URLs
2.3.1.3
Generate Complete URLs Using {## insert oem=}
2.3.1.4
Use CGI and the <base> tag
2.3.1.5
Have HX copy the files using {## copy}
2.3.2
Browser Caching
2.3.3
Errors Returned by HTML Export
2.3.4
CSS Considerations
2.3.4.1
Customizing CSS Styles
2.3.4.2
Style Names Used by HTML Export
2.3.4.3
Overriding HTML Export's Styles
2.3.4.4
pragma.cssfile and {## link}
2.3.5
XHTML
2.3.6
Archive Support
2.3.6.1
Using Redirected IO with Archive Files
2.3.6.2
Temporary File Creation
2.3.6.3
Empty Directories in Archive Files
2.3.6.4
Finding the Total Number of Files in an Archive
2.3.7
Positional Frames Support
2.3.8
Limitations of Multimedia File Support
3
Templates
3.1
What Is a Template?
3.2
The Included Sample Templates
3.3
The Document Tree and Its Elements
3.3.1
Leaf Elements
3.3.2
Repeatable Elements
3.3.3
Element Definitions
3.3.4
Default Nodes
3.4
Macro Reference
3.4.1
Units: {## unit}, {## header}, and {## footer}
3.4.2
Insert Element: {## insert}
3.4.3
Conditional: {## if}, {## elseif}, and {## else}
3.4.4
Loop: {## repeat}
3.4.5
Linking with Structured Breaking: {## link}
3.4.6
Linking with Content Size Breaking: {## anchor}
3.4.7
Comment Put in the Output File: {## ignore}
3.4.8
Comment Not Put in the Output File: {## comment}
3.4.9
Including Other Templates: {## include}
3.4.10
Setting Options Within the Template: {## option}
3.4.11
Copying Files: {## copy} (HTML Export Only)
3.4.12
Deprecated Template Macros (HTML Export Only)
3.5
Breaking Documents by Structure
3.5.1
Indexes and Structure-Based Breaking
3.6
Units - Breaking Documents by Content Size
3.6.1
A Sample Size Breaking Template
3.6.2
Templates Without {## unit} Macros
3.6.3
Indexes and Size-Based Breaking
3.7
Using Grids to Navigate Spreadsheet and Database Files
3.7.1
Grid Support When Tables Are Not Available
3.8
Choosing a Template
3.9
Unicode Templates
4
Template Tutorials
4.1
Template Comments
4.2
Tutorial 1: simple
4.3
Tutorial 2: toc1
4.4
Tutorial 3: toc2
4.5
Tutorial 4: unit
4.6
Tutorial 5: misc
4.7
Tutorial 6: grids1
4.8
Tutorial 7: grids2
4.9
Tutorial 8: internal
Part II Using the C/C++ API
5
Windows Implementation Details
5.1
Installation
5.1.1
NSF Support
5.2
Libraries and Structure
5.2.1
API DLLs
5.2.2
Support DLLs
5.2.3
Engine Libraries
5.2.4
Filter and Export Filter Libraries
5.2.5
Premier Graphics Filters
5.2.6
Additional Files
5.3
The Basics
5.3.1
What You Need in Your Source Code
5.3.2
Options and Information Storage
5.3.3
Structure Alignment
5.3.4
Character Sets
5.3.5
Runtime Considerations
5.4
Default Font Aliases
5.5
Changing Resources
6
UNIX Implementation Details
6.1
Installation
6.1.1
NSF Support
6.2
Libraries and Structure
6.2.1
API Libraries
6.2.2
Support Libraries
6.2.3
Engine Libraries
6.2.4
Filter and Export Filter Libraries
6.2.5
Premier Graphics Filters
6.2.6
Additional Files
6.3
The Basics
6.3.1
What You Need in Your Source Code
6.3.2
Information Storage
6.4
Character Sets
6.5
Runtime Considerations
6.5.1
X Server Requirement
6.5.2
OLE2 Objects
6.5.3
Machine-Dependent Graphics Context
6.5.4
Signal Handling
6.5.5
Runtime Search Path and $ORIGIN
6.6
Environment Variables
6.7
Default Font Aliases
6.8
Changing Resources
6.9
HP-UX Compiling and Linking
6.9.1
HP-UX on RISC
6.9.2
HP-UX on RISC (64 bit)
6.9.3
HP-UX on Itanium (64 bit)
6.10
IBM AIX Compiling and Linking
6.10.1
IBM AIX (32-bit pSeries)
6.10.2
IBM AIX PPC (64-bit)
6.11
Linux Compiling and Linking
6.11.1
Library Compatibility
6.11.1.1
Motif Libraries
6.11.1.2
GLIBC and Compiler Versions
6.11.1.3
Other Libraries
6.11.2
Compiling and Linking
6.11.2.1
Linux 32-bit, including Linux PPC
6.11.2.2
Linux 64-bit
6.11.2.3
Linux zSeries
6.12
Oracle Solaris Compiling and Linking
6.12.1
Oracle Solaris SPARC
6.12.2
Oracle Solaris (SPARC) 64
6.12.3
Oracle Solaris x86
6.12.4
Oracle Solaris x64
6.12.5
Oracle Solaris X Server Display Memory Issue
6.13
z/OS Compiling and Linking
7
Data Access Common Functions
7.1
Deprecated Functions
7.2
DAInitEx
7.3
DADeInit
7.4
DAOpenDocument
7.4.1
IOSPECLINKEDOBJECT Structure
7.4.2
IOSPECARCHIVEOBJECT Structure
7.5
DACloseDocument
7.6
DARetrieveDocHandle
7.7
DASetOption
7.8
DASetFileSpecOption
7.9
DAGetOption
7.10
DAGetFileId
7.11
DAGetFileIdEx
7.12
DAGetErrorString
7.13
DAGetTreeCount
7.14
DAGetTreeRecord
7.14.1
SCCDATREENODE Structure
7.15
DAOpenTreeRecord
7.16
DASaveTreeRecord
7.17
DACloseTreeRecord
7.18
DASetStatCallback
7.19
DASetFileAccessCallback
8
Export Functions
8.1
General Functions
8.1.1
EXOpenExport
8.1.2
EXCALLBACKPROC
8.1.3
EXCloseExport
8.1.4
EXRunExport
8.1.5
EXExportStatus
8.2
Annotation Functions
8.2.1
EXHiliteText
8.2.1.1
HTML Export Usage Notes
8.2.2
EXInsertText
8.2.3
EXHideText
8.2.3.1
EXANNOHIDETEXT Structure
9
Redirected IO
9.1
Using Redirected IO
9.2
Opening Files
9.3
IOClose
9.4
IORead
9.5
IOWrite
9.6
IOSeek
9.7
IOTell
9.8
IOGetInfo
9.8.1
IOGENSECONDARY and IOGENSECONDARYW Structures
9.8.2
File Types That Cause IOGETINFO_GENSECONDARY
9.9
IOSEEK64PROC / IOTELL64PROC
9.9.1
IOSeek64
9.9.2
IOTell64
10
Callbacks
10.1
EX_CALLBACK_ID_CREATENEWFILE
10.1.1
EXURLFILEIOCALLBACKDATA / EXURLFILEIOCALLBACKDATAW Structures
10.2
EX_CALLBACK_ID_NEWFILEINFO
10.3
EX_CALLBACK_ID_ALTLINK
10.4
EX_CALLBACK_ID_CUSTOMELEMENTLIST
10.5
EX_CALLBACK_ID_ENTERARCHIVE
10.6
EX_CALLBACK_ID_GRAPHICEXPORTFAILURE
10.7
EX_CALLBACK_ID_LEAVEARCHIVE
10.8
EX_CALLBACK_ID_OEMOUTPUT
10.9
EX_CALLBACK_ID_OEMOUTPUT_VER2
10.10
EX_CALLBACK_ID_PROCESSELEMENTSTR
10.11
EX_CALLBACK_ID_PROCESSELEMENTSTR_VER2
10.12
EX_CALLBACK_ID_PROCESSLINK
10.12.1
Links That Reference Objects Using a Relative Path (HTML Export)
10.13
EX_CALLBACK_ID_REFLINK
11
Sample Applications
11.1
Building the Samples on a Windows System
11.2
An Overview of the Sample Applications
11.2.1
batch_process_hx
11.2.2
*sample
11.2.3
export (Windows Only)
11.2.3.1
The export Main Window
11.2.4
exsimple
11.2.5
exredir
11.2.6
extract_archive
11.2.7
hxanno
11.3
Accessing the SDK via a Java Wrapper
11.3.1
The ExJava Wrapper API
11.3.2
The C-Based Exporter Application
11.3.3
Compiling the Executables
11.3.4
The ExportTest Sample Application
11.3.5
An Example Conversion Using the ExJava Wrapper
12
HTML Export C/C++ Options
12.1
Character Mapping
12.1.1
SCCOPT_DEFAULTINPUTCHARSET
12.1.2
SCCOPT_EX_CHARBYTEORDER
12.1.3
SCCOPT_EX_OUTPUTCHARACTERSET
12.1.4
SCCOPT_UNMAPPABLECHAR
12.2
Output
12.2.1
SCCOPT_EX_CHANGETRACKING
12.2.2
SCCOPT_EX_COLLAPSEWHITESPACE
12.2.3
SCCOPT_EX_EXTRACTEMBEDDEDFILES
12.2.4
SCCOPT_EX_FLAVOR
12.2.5
SCCOPT_EX_NOSOURCEFORMATTING
12.2.6
SCCOPT_EX_SHOWHIDDENSSDATA
12.2.7
SCCOPT_EX_SHOWHIDDENTEXT
12.2.8
SCCOPT_EX_SIMPLESTYLENAMES
12.2.9
SCCOPT_RENDERING_PREFER_OIT
12.3
Input Handling
12.3.1
SCCOPT_FALLBACKFORMAT
12.3.2
SCCOPT_FIFLAGS
12.3.3
SCCOPT_FORMATFLAGS
12.3.4
SCCOPT_SYSTEMFLAGS
12.3.5
SCCOPT_IGNORE_PASSWORD
12.3.6
SCCOPT_LOTUSNOTESDIRECTORY
12.3.7
SCCOPT_PARSEXMPMETADATA
12.3.8
SCCOPT_PDF_FILTER_REORDER_BIDI
12.3.9
SCCOPT_TIMEZONE
12.3.10
SCCOPT_HTML_COND_COMMENT_MODE
12.3.11
SCCOPT_PDF_FILTER_DROPHYPHENS
12.3.12
SCCOPT_ARCFULLPATH
12.3.13
SCCOPT_GENERATEEXCELREVISIONS
12.3.14
SCCOPT_PDF_FILTER_MAX_EMBEDDED_OBJECTS
12.3.15
SCCOPT_PDF_FILTER_MAX_VECTOR_PATHS
12.3.16
SCCOPT_PDF_FILTER_WORD_DELIM_FRACTION
12.4
Layout
12.4.1
SCCOPT_EX_FALLBACKFONT
12.4.1.1
SCCUTFALLBACKFONT Structure
12.4.2
SCCOPT_EX_FONTFLAGS
12.4.3
SCCOPT_EX_GENBULLETSANDNUMS
12.4.4
SCCOPT_EX_GRIDADVANCE
12.4.5
SCCOPT_EX_GRIDCOLS
12.4.6
SCCOPT_EX_GRIDROWS
12.4.7
SCCOPT_EX_GRIDWRAP
12.4.8
SCCOPT_EX_JAVASCRIPTTABS
12.4.9
SCCOPT_EX_PAGESIZE
12.4.10
SCCOPT_EX_PREVENTGRAPHICOVERLAP
12.4.11
SCCOPT_EX_TEMPLATE
12.4.11.1
Using DASetOption to Specify the Template
12.4.11.2
Using DASetFileSpecOption to Specify the Template
12.5
Compression
12.5.1
SCCOPT_FILTERJPG
12.5.2
SCCOPT_FILTERLZW
12.6
Graphics
12.6.1
SCCOPT_GIF_INTERLACED
12.6.2
SCCOPT_GRAPHIC_HEIGHTLIMIT
12.6.3
SCCOPT_GRAPHIC_OUTPUTDPI
12.6.4
SCCOPT_GRAPHIC_SIZELIMIT
12.6.5
SCCOPT_GRAPHIC_SIZEMETHOD
12.6.6
SCCOPT_GRAPHIC_TRANSPARENCYCOLOR
12.6.7
SCCOPT_GRAPHIC_TYPE
12.6.8
SCCOPT_GRAPHIC_WIDTHLIMIT
12.6.9
SCCOPT_JPEG_QUALITY
12.6.10
SCCOPT_RENDER_ENABLEALPHABLENDING
12.7
Spreadsheet and Database File Rendering
12.7.1
SCCOPT_EX_SHOWSPREADSHEETBORDER
12.7.2
SCCOPT_EX_SSDBBORDER
12.7.3
SCCOPT_EX_SSDBROWCOLHEADINGS
12.8
Page Rendering
12.8.1
SCCOPT_WPEMAILHEADEROUTPUT
12.8.2
SCCOPT_MAILHEADERVISIBLE
12.8.3
SCCOPT_MAILHEADERHIDDEN
12.9
Font Rendering
12.9.1
SCCOPT_DEFAULTPRINTFONT
12.9.1.1
SCCVWFONTSPEC Structure
12.9.2
SCCOPT_PRINTFONTALIAS
12.9.2.1
SCCVWFONTALIAS Structure
12.9.3
SCCOPT_STROKE_TEXT
12.10
Callbacks
12.10.1
SCCOPT_EX_CALLBACKS
12.10.2
SCCOPT_EX_UNICODECALLBACKSTR
12.11
File System
12.11.1
SCCOPT_IO_BUFFERSIZE
12.11.1.1
SCCBUFFEROPTIONS Structure
12.11.2
SCCOPT_TEMPDIR
12.11.2.1
SCCUTTEMPDIRSPEC Structure
12.11.3
SCCOPT_DOCUMENTMEMORYMODE
12.11.4
SCCOPT_REDIRECTTEMPFILE
12.12
Template-Only Options
12.12.1
EX_LINKTARGET
12.12.2
EX_LINKTARGETOVERRIDE
12.13
Old Options
12.13.1
Discontinued Options
12.13.1.1
SCCOPT_GIF_SPLASHPALETTE
12.13.2
SCCOPT_EX_COMPLIANCEFLAGS
12.13.3
Option Name Changes
12.13.4
#define Name Changes
Part III Using the Java API
13
Introduction to the Java API
13.1
Requirements
13.2
Getting Started
13.2.1
Configure the Environment
13.2.2
Generate Code
13.2.2.1
Create an Exporter Object
13.2.2.2
Configure the Output
13.2.2.3
Set the Source and Primary Destination Files
13.2.2.4
Set the Output Type
13.2.2.5
Provide a Callback Handler
13.2.2.6
Run the Export
14
HTML Export Java Classes
14.1
Annotation Class
14.2
ArchiveNode Class
14.3
Callback Class
14.3.1
createNewFile
14.3.1.1
CreateNewFileResponse Class
14.3.2
newFileInfo
14.3.3
openFile
14.3.3.1
OpenFileResponse Class
14.3.4
createTempFile
14.3.4.1
CreateTempFileResponseClass
14.4
ColorInfo Class
14.5
Exporter Interface
14.5.1
Annotatable Interface
14.5.2
Document Interface
14.5.3
SeekableByteChannel6 Interface
14.5.4
OptionsCache Class
14.5.4.1
BorderMode
14.5.4.2
CollapseWhiteSpace
14.5.4.3
DefaultInputCharacterSet
14.5.4.4
DefaultRenderFont
14.5.4.5
DocumentMemoryMode
14.5.4.6
DropPDFHyphens
14.5.4.7
EmailHeaders
14.5.4.8
EnableAlphaBlending
14.5.4.9
ExtractEmbeddedFiles
14.5.4.10
FallbackFormat
14.5.4.11
FontAliasList
14.5.4.12
GenerateBulletsAndNumbering
14.5.4.13
GenerateJavascriptTabs
14.5.4.14
GraphicHeightLimit
14.5.4.15
GraphicOutputDPI
14.5.4.16
GraphicSizeLimit
14.5.4.17
GraphicSizeMethod
14.5.4.18
GraphicWidthLimit
14.5.4.19
GridWrap
14.5.4.20
HTMLFlavor
14.5.4.21
HTMLOutputFormatting
14.5.4.22
IECondCommentMode
14.5.4.23
IgnorePassword
14.5.4.24
InterlacedGIFs
14.5.4.25
InternalRendering
14.5.4.26
ISODateTimes
14.5.4.27
JPEGQuality
14.5.4.28
LotusNotesDirectory
14.5.4.29
OutputChangeTracking
14.5.4.30
OutputCharacterSet
14.5.4.31
OutputGraphicType
14.5.4.32
PageBreakLimit
14.5.4.33
ParseXMPMetadata
14.5.4.34
PDFInputMaxEmbeddedObjects
14.5.4.35
PDFInputMaxVectorPaths
14.5.4.36
PDFReorderBiDi
14.5.4.37
PDFWordSpacingFactor
14.5.4.38
PerformExtendedFI
14.5.4.39
PreventGraphicOverlap
14.5.4.40
RenderEmbeddedFonts
14.5.4.41
ShowArchiveFullPath
14.5.4.42
ShowColumnHeadings
14.5.4.43
ShowHiddenSpreadSheetData
14.5.4.44
ShowHiddenText
14.5.4.45
SimpleStyleNames
14.5.4.46
StrictFile
14.5.4.47
SuppressFontAttributes
14.5.4.48
TimeZoneOffset
14.5.4.49
TransparencyColor
14.5.4.50
UnicodeByteOrder
14.5.4.51
UnmappableCharacter
14.6
ExportStatus Class
14.7
FileFormat Class
14.8
FontAliases Class
14.9
FontInfo Class
14.10
FontList Class
14.11
GridWrapInfo Class
14.12
HighlightTextAnnotation Class
14.13
MailHeaders Class
14.14
Option Interface
14.15
OutsideIn Class
14.16
OutsideInException Class
Part IV Using the .NET API
15
Introduction to the .NET API
15.1
Requirements
15.2
Getting Started
15.2.1
Configuring your Environment
15.2.2
Generate Code
15.2.2.1
Create an Exporter Object
15.2.2.2
Configure the Output
15.2.2.3
Set the Source and Primary Destination Files
15.2.2.4
Set the Output Type
15.2.2.5
Provide a Callback Handler
15.2.2.6
Run the Export
15.2.3
Redirected I/O Support in .NET
16
HTML Export .NET Classes
16.1
Annotation Class
16.2
ArchiveNode Class
16.3
Callback Class
16.3.1
OpenFile
16.3.1.1
OpenFileResponse Class
16.3.2
CreateNewFile
16.3.2.1
CreateNewFileResponse Class
16.3.3
NewFileInfo
16.3.4
CreateTempFile
16.3.4.1
CreateTempFileResponse Class
16.4
ColorInfo Class
16.5
Exporter Interface
16.5.1
lAnnotatable Interface
16.5.2
Document Interface
16.5.3
OptionsCache Class
16.5.3.1
BorderMode
16.5.3.2
CollapseWhiteSpace
16.5.3.3
DefaultInputCharacterSet
16.5.3.4
DefaultRenderFont
16.5.3.5
DocumentMemoryMode
16.5.3.6
DropPDFHyphens
16.5.3.7
EmailHeaders
16.5.3.8
ExtractEmbeddedFiles
16.5.3.9
FallbackFormat
16.5.3.10
FontAliasList
16.5.3.11
GenerateBulletsAndNumbering
16.5.3.12
GenerateJavascriptTabs
16.5.3.13
GraphicHeightLimit
16.5.3.14
GraphicOutputDPI
16.5.3.15
GraphicSizeLimit
16.5.3.16
GraphicSizeMethod
16.5.3.17
GraphicWidthLimit
16.5.3.18
GridWrap
16.5.3.19
HTMLFlavor
16.5.3.20
HTMLOutputFormatting
16.5.3.21
IECondCommentMode
16.5.3.22
IgnorePassword
16.5.3.23
InterlacedGIFs
16.5.3.24
ISODateTimes
16.5.3.25
JPEGQuality
16.5.3.26
LotusNotesDirectory
16.5.3.27
OutputChangeTracking
16.5.3.28
OutputCharacterSet
16.5.3.29
OutputGraphicType
16.5.3.30
PageBreakLimit
16.5.3.31
ParseXMPMetadata
16.5.3.32
PDFInputMaxEmbeddedObjects
16.5.3.33
PDFInputMaxVectorPaths
16.5.3.34
PDFReorderBiDi
16.5.3.35
PDFWordSpacingFactor
16.5.3.36
PerformExtendedFI
16.5.3.37
PreventGraphicOverlap
16.5.3.38
RenderEmbeddedFonts
16.5.3.39
ShowArchiveFullPath
16.5.3.40
ShowColumnHeadings
16.5.3.41
ShowHiddenSpreadSheetData
16.5.3.42
ShowHiddenText
16.5.3.43
SimpleStyleNames
16.5.3.44
StrictFile
16.5.3.45
SuppressFontAttributes
16.5.3.46
TimeZoneOffset
16.5.3.47
TransparencyColor
16.5.3.48
UnicodeByteOrder
16.5.3.49
UnmappableCharacter
16.6
ExportStatus Class
16.7
FileFormat Class
16.8
FontAliases Class
16.9
FontInfo Class
16.10
FontList Class
16.11
GridWrapInfo Class
16.12
HighlightTextAnnotation Class
16.13
MailHeaders Class
16.14
Option Interface
16.15
OutsideIn Class
16.16
OutsideInConfig Class
16.17
OutsideInVersion Class
16.18
OutsideInCastException Class
16.19
OutsideInException Class
Scripting on this page enhances content navigation, but does not change the content in any way.