Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents
• Conventions

Introduction

• What's New in Release 8.3.5
• Architectural Overview
• Definition of Terms
• Directory Structure
• How to Use HTML Export
• Copyright Information

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

UNIX Implementation Details

• Installation
• 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
• Sun Solaris Compiling and Linking
  • Solaris SPARC
  • Sun Solaris (SPARC) 64
  • Solaris x86
  • Solaris x64
  • Solaris X Server Display Memory Issue
• z/OS Compiling and Linking

Data Access Common Functions

• DAInit
• DAThreadInit
• DADeInit
• DAOpenDocument
  • IOSPECLINKEDOBJECT Structure
  • IOSPECARCHIVEOBJECT Structure
• DACloseDocument
• DARetrieveDocHandle
• DASetOption
• DASetFileSpecOption
• DAGetOption
• DAGetFileId
• DAGetFileIdEx
• DAGetErrorString
• DAGetTreeCount
• DAGetTreeRecord
  • SCCDATREENODE Structure
• DAOpenTreeRecord
• DASaveTreeRecord
• DACloseTreeRecord
• DASetStatCallback
• DASetFileAccessCallback

Export Functions

• General Functions
  • EXOpenExport
  • EXCALLBACKPROC
  • EXCloseExport
  • EXRunExport
• Annotation Functions
  • EXHiliteText
    • HTML Export Usage Notes
  • EXInsertText
  • EXHideText
    • EXANNOHIDETEXT Structure

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

Callbacks

• Callbacks Used In HTML Export
  • 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

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}
  • XML and HTML Export
    • The Sample XML Template
  • XHTML and Well-Formed HTML
  • 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

Sample Applications

• Building the Samples on a Windows System
• An Overview of the Sample Applications
  • *sample
  • export (Windows Only)
    • The export Main Window
  • exsimple
  • exredir
  • 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

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

Template Tutorials

• Tutorial 1: simple
• Tutorial 2: toc1
• Tutorial 3: toc2
• Tutorial 4: unit
• Tutorial 5: misc
• Tutorial 6: grids1
• Tutorial 7: grids2
• Tutorial 8: xml
• Tutorial 9: internal

Copyrights and Licensing

• Outside In HTML Export Licensing

HTML Export Options

• 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_COMPLIANCEFLAGS
    • 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_IGNORE_PASSWORD
    • SCCOPT_LOTUSNOTESDIRECTORY
    • SCCOPT_PARSEXMPMETADATA
    • SCCOPT_TIMEZONE
  • Layout
    • SCCOPT_EX_FALLBACKFONT
    • 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
  • 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
  • Spreadsheet and Database File Rendering
    • SCCOPT_EX_SHOWSPREADSHEETBORDER
    • SCCOPT_EX_SSDBBORDER
    • SCCOPT_EX_SSDBROWCOLHEADINGS
  • Page Rendering
    • SCCOPT_WPEMAILHEADEROUTPUT
  • Font Rendering
    • SCCOPT_DEFAULTPRINTFONT
    • SCCOPT_PRINTFONTALIAS
  • Callbacks
    • SCCOPT_EX_CALLBACKS
    • SCCOPT_EX_UNICODECALLBACKSTR
  • File System
    • SCCOPT_IO_BUFFERSIZE
    • SCCOPT_TEMPDIR
    • SCCOPT_DOCUMENTMEMORYMODE
    • SCCOPT_REDIRECTTEMPFILE
  • Template-Only Options
    • EX_LINKTARGET
    • EX_LINKTARGETOVERRIDE
  • Old Options
    • Discontinued Options
    • Option Name Changes
    • #define Name Changes
• HTML Export SOAP Options
  • How Options Work
  • Character Mapping
    • defaultInputCharset
    • characterByteOrder
    • outputCharacterSet
    • unmappableCharacter
  • Output
    • altlink
    • showChangeTracking
    • collapseWhiteSpace
    • compliance
    • extractEmbeddedFiles
    • flavor
    • noSourceFormatting
    • showHiddenSpreadsheetData
    • showHiddenText
    • simpleStyleNames
    • preferOITRendering
  • Input Handling
    • fallbackFormat
    • extendedTestForText
    • ignorePassword
    • parseXMPMetaData
    • skipLinkedImages
    • timezone
  • Layout
    • fallbackFont
    • fontFlags
    • genBulletsAndNums
    • gridAdvance
    • gridCols
    • gridRows
    • gridWrap
    • javaScriptTabs
    • pageSize
    • preventGraphicOverlap
    • template
  • Compression
    • allowJPEG
    • allowLZW
  • Graphics
    • graphicGifInterlaced
    • graphicHeightLimit
    • graphicOutputDPI
    • graphicSizeLimit
    • graphicSizeMethod
    • graphicTransparencyColor
    • graphicType
    • graphicWidthLimit
    • graphicJpegQuality
  • Spreadsheet and Database File Rendering
    • showSpreadsheetBorder
    • spreadsheetBorders
    • showSpreadsheetHeadings
  • Page Rendering
    • emailHeaderOutput
  • Font Rendering
    • defaultFont
    • fontAlias
  • File System
    • fileAccess
    • readBufferSize
    • memoryMappedInputSize
    • tempBufferSize

Index