Skip Headers
Oracle® Outside In HTML Export Developer's Guide
Release 8.4.0
Part Number E12884-03
Home
Index
Contact Us
Next
View PDF
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
Conventions
1
Introduction
1.1
What's New in Release 8.4.0
1.2
Architectural Overview
1.3
Definition of Terms
1.4
Directory Structure
1.4.1
Installing Multiple SDKs
1.5
How to Use HTML Export
1.6
Copyright Information
2
Windows Implementation Details
2.1
Installation
2.1.1
NSF Support
2.2
Libraries and Structure
2.2.1
API DLLs
2.2.2
Support DLLs
2.2.3
Engine Libraries
2.2.4
Filter and Export Filter Libraries
2.2.5
Premier Graphics Filters
2.2.6
Additional Files
2.3
The Basics
2.3.1
What You Need in Your Source Code
2.3.2
Options and Information Storage
2.3.3
Structure Alignment
2.3.4
Character Sets
2.3.5
Runtime Considerations
2.4
Default Font Aliases
2.5
Changing Resources
3
UNIX Implementation Details
3.1
Installation
3.1.1
NSF Support
3.2
Libraries and Structure
3.2.1
API Libraries
3.2.2
Support Libraries
3.2.3
Engine Libraries
3.2.4
Filter and Export Filter Libraries
3.2.5
Premier Graphics Filters
3.2.6
Additional Files
3.3
The Basics
3.3.1
What You Need in Your Source Code
3.3.2
Information Storage
3.4
Character Sets
3.5
Runtime Considerations
3.5.1
X Server Requirement
3.5.2
OLE2 Objects
3.5.3
Machine-Dependent Graphics Context
3.5.4
Signal Handling
3.5.5
Runtime Search Path and $ORIGIN
3.6
Environment Variables
3.7
Default Font Aliases
3.8
Changing Resources
3.9
HP-UX Compiling and Linking
3.9.1
HP-UX on RISC
3.9.2
HP-UX on RISC (64 bit)
3.9.3
HP-UX on Itanium (64 bit)
3.10
IBM AIX Compiling and Linking
3.10.1
IBM AIX (32-bit pSeries)
3.10.2
IBM AIX PPC (64-bit)
3.11
Linux Compiling and Linking
3.11.1
Library Compatibility
3.11.1.1
Motif Libraries
3.11.1.2
GLIBC and Compiler Versions
3.11.1.3
Other Libraries
3.11.2
Compiling and Linking
3.11.2.1
Linux 32-bit, including Linux PPC
3.11.2.2
Linux 64-bit
3.11.2.3
Linux zSeries
3.12
Oracle Solaris Compiling and Linking
3.12.1
Oracle Solaris SPARC
3.12.2
Oracle Solaris (SPARC) 64
3.12.3
Oracle Solaris x86
3.12.4
Oracle Solaris x64
3.12.5
Oracle Solaris X Server Display Memory Issue
3.13
z/OS Compiling and Linking
4
Data Access Common Functions
4.1
Deprecated Functions
4.2
DAInitEx
4.3
DADeInit
4.4
DAOpenDocument
4.4.1
IOSPECLINKEDOBJECT Structure
4.4.2
IOSPECARCHIVEOBJECT Structure
4.5
DACloseDocument
4.6
DARetrieveDocHandle
4.7
DASetOption
4.8
DASetFileSpecOption
4.9
DAGetOption
4.10
DAGetFileId
4.11
DAGetFileIdEx
4.12
DAGetErrorString
4.13
DAGetTreeCount
4.14
DAGetTreeRecord
4.14.1
SCCDATREENODE Structure
4.15
DAOpenTreeRecord
4.16
DASaveTreeRecord
4.17
DACloseTreeRecord
4.18
DASetStatCallback
4.19
DASetFileAccessCallback
5
Export Functions
5.1
General Functions
5.1.1
EXOpenExport
5.1.2
EXCALLBACKPROC
5.1.3
EXCloseExport
5.1.4
EXRunExport
5.1.5
EXExportStatus
5.2
Annotation Functions
5.2.1
EXHiliteText
5.2.1.1
HTML Export Usage Notes
5.2.2
EXInsertText
5.2.3
EXHideText
5.2.3.1
EXANNOHIDETEXT Structure
6
Redirected IO
6.1
Using Redirected IO
6.2
Opening Files
6.3
IOClose
6.4
IORead
6.5
IOWrite
6.6
IOSeek
6.7
IOTell
6.8
IOGetInfo
6.8.1
IOGENSECONDARY and IOGENSECONDARYW Structures
6.8.2
File Types That Cause IOGETINFO_GENSECONDARY
6.9
IOSEEK64PROC / IOTELL64PROC
6.9.1
IOSeek64
6.9.2
IOTell64
7
Callbacks
7.1
Callbacks Used In HTML Export
7.1.1
EX_CALLBACK_ID_CREATENEWFILE
7.1.1.1
EXURLFILEIOCALLBACKDATA / EXURLFILEIOCALLBACKDATAW Structures
7.1.2
EX_CALLBACK_ID_NEWFILEINFO
7.1.3
EX_CALLBACK_ID_ALTLINK
7.1.4
EX_CALLBACK_ID_CUSTOMELEMENTLIST
7.1.5
EX_CALLBACK_ID_ENTERARCHIVE
7.1.6
EX_CALLBACK_ID_GRAPHICEXPORTFAILURE
7.1.7
EX_CALLBACK_ID_LEAVEARCHIVE
7.1.8
EX_CALLBACK_ID_OEMOUTPUT
7.1.9
EX_CALLBACK_ID_OEMOUTPUT_VER2
7.1.10
EX_CALLBACK_ID_PROCESSELEMENTSTR
7.1.11
EX_CALLBACK_ID_PROCESSELEMENTSTR_VER2
7.1.12
EX_CALLBACK_ID_PROCESSLINK
7.1.12.1
Links That Reference Objects Using a Relative Path (HTML Export)
7.1.13
EX_CALLBACK_ID_REFLINK
8
Implementation Issues
8.1
Running in 24x7 Environments
8.2
Running in Multiple Threads or Processes
8.3
HTML Export Issues
8.3.1
Relative URLs in Templates
8.3.1.1
Guarantee the References Are Good
8.3.1.2
Use Absolute URLs
8.3.1.3
Generate Complete URLs Using {## insert oem=}
8.3.1.4
Use CGI and the <base> tag
8.3.1.5
Have HX copy the files using {## copy}
8.3.2
Browser Caching
8.3.3
Errors Returned by HTML Export
8.3.4
CSS Considerations
8.3.4.1
Customizing CSS Styles
8.3.4.2
Style Names Used by HTML Export
8.3.4.3
Overriding HTML Export's Styles
8.3.4.4
pragma.cssfile and {## link}
8.3.5
XML and HTML Export
8.3.5.1
The Sample XML Template
8.3.6
XHTML and Well-Formed HTML
8.3.7
Archive Support
8.3.7.1
Using Redirected IO with Archive Files
8.3.7.2
Temporary File Creation
8.3.7.3
Empty Directories in Archive Files
8.3.7.4
Finding the Total Number of Files in an Archive
8.3.8
Positional Frames Support
8.3.9
Limitations of Multimedia File Support
9
Sample Applications
9.1
Building the Samples on a Windows System
9.2
An Overview of the Sample Applications
9.2.1
batch_process_hx
9.2.2
*sample
9.2.3
export (Windows Only)
9.2.3.1
The export Main Window
9.2.4
exsimple
9.2.5
exredir
9.2.6
extract_archive
9.2.7
hxanno
9.3
Accessing the SDK via a Java Wrapper
9.3.1
The ExJava Wrapper API
9.3.2
The C-Based Exporter Application
9.3.3
Compiling the Executables
9.3.4
The ExportTest Sample Application
9.3.5
An Example Conversion Using the ExJava Wrapper
10
Templates
10.1
What Is a Template?
10.2
The Included Sample Templates
10.3
The Document Tree and Its Elements
10.3.1
Leaf Elements
10.3.2
Repeatable Elements
10.3.3
Element Definitions
10.3.4
Default Nodes
10.4
Macro Reference
10.4.1
Units: {## unit}, {## header}, and {## footer}
10.4.2
Insert Element: {## insert}
10.4.3
Conditional: {## if}, {## elseif}, and {## else}
10.4.4
Loop: {## repeat}
10.4.5
Linking with Structured Breaking: {## link}
10.4.6
Linking with Content Size Breaking: {## anchor}
10.4.7
Comment Put in the Output File: {## ignore}
10.4.8
Comment Not Put in the Output File: {## comment}
10.4.9
Including Other Templates: {## include}
10.4.10
Setting Options Within the Template: {## option}
10.4.11
Copying Files: {## copy} (HTML Export Only)
10.4.12
Deprecated Template Macros (HTML Export Only)
10.5
Breaking Documents by Structure
10.5.1
Indexes and Structure-Based Breaking
10.6
Units - Breaking Documents by Content Size
10.6.1
A Sample Size Breaking Template
10.6.2
Templates Without {## unit} Macros
10.6.3
Indexes and Size-Based Breaking
10.7
Using Grids to Navigate Spreadsheet and Database Files
10.7.1
Grid Support When Tables Are Not Available
10.8
Choosing a Template
10.9
Unicode Templates
11
Template Tutorials
11.1
Template Comments
11.2
Tutorial 1: simple
11.3
Tutorial 2: toc1
11.4
Tutorial 3: toc2
11.5
Tutorial 4: unit
11.6
Tutorial 5: misc
11.7
Tutorial 6: grids1
11.8
Tutorial 7: grids2
11.9
Tutorial 8: xml
11.10
Tutorial 9: internal
A
Copyrights and Licensing
A.1
Outside In HTML Export Licensing
B
HTML Export Options
B.1
HTML Export C/C++ Options
B.1.1
Character Mapping
B.1.1.1
SCCOPT_DEFAULTINPUTCHARSET
B.1.1.2
SCCOPT_EX_CHARBYTEORDER
B.1.1.3
SCCOPT_EX_OUTPUTCHARACTERSET
B.1.1.4
SCCOPT_UNMAPPABLECHAR
B.1.2
Output
B.1.2.1
SCCOPT_EX_CHANGETRACKING
B.1.2.2
SCCOPT_EX_COLLAPSEWHITESPACE
B.1.2.3
SCCOPT_EX_COMPLIANCEFLAGS
B.1.2.4
SCCOPT_EX_EXTRACTEMBEDDEDFILES
B.1.2.5
SCCOPT_EX_FLAVOR
B.1.2.6
SCCOPT_EX_NOSOURCEFORMATTING
B.1.2.7
SCCOPT_EX_SHOWHIDDENSSDATA
B.1.2.8
SCCOPT_EX_SHOWHIDDENTEXT
B.1.2.9
SCCOPT_EX_SIMPLESTYLENAMES
B.1.2.10
SCCOPT_RENDERING_PREFER_OIT
B.1.3
Input Handling
B.1.3.1
SCCOPT_FALLBACKFORMAT
B.1.3.2
SCCOPT_FIFLAGS
B.1.3.3
SCCOPT_FORMATFLAGS
B.1.3.4
SCCOPT_SYSTEMFLAGS
B.1.3.5
SCCOPT_IGNORE_PASSWORD
B.1.3.6
SCCOPT_LOTUSNOTESDIRECTORY
B.1.3.7
SCCOPT_PARSEXMPMETADATA
B.1.3.8
SCCOPT_PDF_FILTER_REORDER_BIDI
B.1.3.9
SCCOPT_TIMEZONE
B.1.3.10
SCCOPT_HTML_COND_COMMENT_MODE
B.1.4
Layout
B.1.4.1
SCCOPT_EX_FALLBACKFONT
B.1.4.2
SCCOPT_EX_FONTFLAGS
B.1.4.3
SCCOPT_EX_GENBULLETSANDNUMS
B.1.4.4
SCCOPT_EX_GRIDADVANCE
B.1.4.5
SCCOPT_EX_GRIDCOLS
B.1.4.6
SCCOPT_EX_GRIDROWS
B.1.4.7
SCCOPT_EX_GRIDWRAP
B.1.4.8
SCCOPT_EX_JAVASCRIPTTABS
B.1.4.9
SCCOPT_EX_PAGESIZE
B.1.4.10
SCCOPT_EX_PREVENTGRAPHICOVERLAP
B.1.4.11
SCCOPT_EX_TEMPLATE
B.1.5
Compression
B.1.5.1
SCCOPT_FILTERJPG
B.1.5.2
SCCOPT_FILTERLZW
B.1.6
Graphics
B.1.6.1
SCCOPT_GIF_INTERLACED
B.1.6.2
SCCOPT_GRAPHIC_HEIGHTLIMIT
B.1.6.3
SCCOPT_GRAPHIC_OUTPUTDPI
B.1.6.4
SCCOPT_GRAPHIC_SIZELIMIT
B.1.6.5
SCCOPT_GRAPHIC_SIZEMETHOD
B.1.6.6
SCCOPT_GRAPHIC_TRANSPARENCYCOLOR
B.1.6.7
SCCOPT_GRAPHIC_TYPE
B.1.6.8
SCCOPT_GRAPHIC_WIDTHLIMIT
B.1.6.9
SCCOPT_JPEG_QUALITY
B.1.7
Spreadsheet and Database File Rendering
B.1.7.1
SCCOPT_EX_SHOWSPREADSHEETBORDER
B.1.7.2
SCCOPT_EX_SSDBBORDER
B.1.7.3
SCCOPT_EX_SSDBROWCOLHEADINGS
B.1.8
Page Rendering
B.1.8.1
SCCOPT_WPEMAILHEADEROUTPUT
B.1.8.2
SCCOPT_MAILHEADERVISIBLE
B.1.8.3
SCCOPT_MAILHEADERHIDDEN
B.1.9
Font Rendering
B.1.9.1
SCCOPT_DEFAULTPRINTFONT
B.1.9.2
SCCOPT_PRINTFONTALIAS
B.1.10
Callbacks
B.1.10.1
SCCOPT_EX_CALLBACKS
B.1.10.2
SCCOPT_EX_UNICODECALLBACKSTR
B.1.11
File System
B.1.11.1
SCCOPT_IO_BUFFERSIZE
B.1.11.2
SCCOPT_TEMPDIR
B.1.11.3
SCCOPT_DOCUMENTMEMORYMODE
B.1.11.4
SCCOPT_REDIRECTTEMPFILE
B.1.12
Template-Only Options
B.1.12.1
EX_LINKTARGET
B.1.12.2
EX_LINKTARGETOVERRIDE
B.1.13
Old Options
B.1.13.1
Discontinued Options
B.1.13.2
Option Name Changes
B.1.13.3
#define Name Changes
B.2
HTML Export SOAP Options
B.2.1
How Options Work
B.2.2
Character Mapping
B.2.2.1
defaultInputCharset
B.2.2.2
characterByteOrder
B.2.2.3
outputCharacterSet
B.2.2.4
unmappableCharacter
B.2.3
Output
B.2.3.1
altlink
B.2.3.2
showChangeTracking
B.2.3.3
collapseWhiteSpace
B.2.3.4
compliance
B.2.3.5
extractEmbeddedFiles
B.2.3.6
flavor
B.2.3.7
noSourceFormatting
B.2.3.8
showHiddenSpreadsheetData
B.2.3.9
showHiddenText
B.2.3.10
simpleStyleNames
B.2.3.11
preferOITRendering
B.2.4
Input Handling
B.2.4.1
fallbackFormat
B.2.4.2
extendedTestForText
B.2.4.3
ignorePassword
B.2.4.4
parseXMPMetaData
B.2.4.5
reorderBIDI
B.2.4.6
skipLinkedImages
B.2.4.7
timezone
B.2.4.8
htmlCondCommentIE5On
B.2.4.9
htmlCondCommentIE6On
B.2.4.10
htmlCondCommentIE7On
B.2.4.11
htmlCondCommentIE8On
B.2.4.12
htmlCondCommentIE9On
B.2.4.13
htmlCondCommentAllOn
B.2.5
Layout
B.2.5.1
fallbackFont
B.2.5.2
fontFlags
B.2.5.3
genBulletsAndNums
B.2.5.4
gridAdvance
B.2.5.5
gridCols
B.2.5.6
gridRows
B.2.5.7
gridWrap
B.2.5.8
javaScriptTabs
B.2.5.9
pageSize
B.2.5.10
preventGraphicOverlap
B.2.5.11
template
B.2.6
Compression
B.2.6.1
allowJPEG
B.2.6.2
allowLZW
B.2.7
Graphics
B.2.7.1
graphicGifInterlaced
B.2.7.2
graphicHeightLimit
B.2.7.3
graphicOutputDPI
B.2.7.4
graphicSizeLimit
B.2.7.5
graphicSizeMethod
B.2.7.6
graphicTransparencyColor
B.2.7.7
graphicType
B.2.7.8
graphicWidthLimit
B.2.7.9
graphicJpegQuality
B.2.8
Spreadsheet and Database File Rendering
B.2.8.1
showSpreadsheetBorder
B.2.8.2
spreadsheetBorders
B.2.8.3
showSpreadsheetHeadings
B.2.9
Page Rendering
B.2.9.1
emailHeaderOutput
B.2.10
Font Rendering
B.2.10.1
defaultFont
B.2.10.2
fontAlias
B.2.11
File System
B.2.11.1
fileAccess
B.2.11.2
readBufferSize
B.2.11.3
memoryMappedInputSize
B.2.11.4
tempBufferSize
Index