Oracle Outside In HTML Export Developer's Guide
Contents
Title and Copyright Information
Preface
Part I Getting Started with HTML Export
1 Introduction
- 1.1 What's New in this Release
- 1.2 Architectural Overview
- 1.3 Definition of Terms
- 1.4 Directory Structure
- 1.5 How to Use HTML Export
- 1.6 Copyright Information
2 Implementation Issues
- 2.1 Running in 24x7 Environments
- 2.2 Running in Multiple Threads or Processes
- 2.3 HTML Export Issues
3 Templates
- 3.1 What Is a Template?
- 3.2 The Included Sample Templates
- 3.3 The Document Tree and Its Elements
- 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.6 Units - Breaking Documents by Content Size
- 3.7 Using Grids to Navigate Spreadsheet and Database Files
- 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.2 Libraries and Structure
- 5.3 The Basics
- 5.4 Default Font Aliases
- 5.5 Changing Resources
6 UNIX Implementation Details
- 6.1 Installation
- 6.2 Libraries and Structure
- 6.3 The Basics
- 6.4 Character Sets
- 6.5 Runtime Considerations
- 6.6 Environment Variables
- 6.7 Default Font Aliases
- 6.8 Changing Resources
- 6.9 HP-UX Compiling and Linking
- 6.10 IBM AIX Compiling and Linking
- 6.11 Linux Compiling and Linking
- 6.12 Oracle Solaris Compiling and Linking
- 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.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.15 DAOpenTreeRecord
- 7.16 DASaveTreeRecord
- 7.17 DACloseTreeRecord
- 7.18 DASetStatCallback
- 7.19 DASetFileAccessCallback
8 Export Functions
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.9 IOSEEK64PROC / IOTELL64PROC
10 Callbacks
- 10.1 Callbacks Used In HTML Export
- 10.1.1 EX_CALLBACK_ID_CREATENEWFILE
- 10.1.2 EX_CALLBACK_ID_NEWFILEINFO
- 10.1.3 EX_CALLBACK_ID_ALTLINK
- 10.1.4 EX_CALLBACK_ID_CUSTOMELEMENTLIST
- 10.1.5 EX_CALLBACK_ID_ENTERARCHIVE
- 10.1.6 EX_CALLBACK_ID_GRAPHICEXPORTFAILURE
- 10.1.7 EX_CALLBACK_ID_LEAVEARCHIVE
- 10.1.8 EX_CALLBACK_ID_OEMOUTPUT
- 10.1.9 EX_CALLBACK_ID_OEMOUTPUT_VER2
- 10.1.10 EX_CALLBACK_ID_PROCESSELEMENTSTR
- 10.1.11 EX_CALLBACK_ID_PROCESSELEMENTSTR_VER2
- 10.1.12 EX_CALLBACK_ID_PROCESSLINK
- 10.1.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.3 Accessing the SDK via a Java Wrapper
12 HTML Export C/C++ Options
- 12.1 Character Mapping
- 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.4 Layout
- 12.4.1 SCCOPT_EX_FALLBACKFONT
- 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.5 Compression
- 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.8 Page Rendering
- 12.9 Font Rendering
- 12.10 Callbacks
- 12.11 File System
- 12.12 Template-Only Options
- 12.13 Old Options
Part III Using the Java API
13 Introduction to the Java API
14 HTML Export Java Classes
- 14.1 Annotation Class
- 14.2 ArchiveNode Class
- 14.3 Callback Class
- 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 PDFReorderBiDi
- 14.5.4.35 PerformExtendedFI
- 14.5.4.36 PreventGraphicOverlap
- 14.5.4.37 RenderEmbeddedFonts
- 14.5.4.38 ShowArchiveFullPath
- 14.5.4.39 ShowColumnHeadings
- 14.5.4.40 ShowHiddenSpreadSheetData
- 14.5.4.41 ShowHiddenText
- 14.5.4.42 SimpleStyleNames
- 14.5.4.43 StrictFile
- 14.5.4.44 SuppressFontAttributes
- 14.5.4.45 TimeZoneOffset
- 14.5.4.46 TransparencyColor
- 14.5.4.47 UnicodeByteOrder
- 14.5.4.48 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 OutsideIn
- 14.15 OutsideInException Class
Part IV Using the .NET API
15 Introduction to the .NET API
- 15.1 Requirements
- 15.2 Getting Started
16 HTML Export .NET Functions
- 16.1 Annotation Class
- 16.2 ArchiveNode Class
- 16.3 Callback 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 PDFReorderBiDi
- 16.5.3.33 PerformExtendedFI
- 16.5.3.34 PreventGraphicOverlap
- 16.5.3.35 RenderEmbeddedFonts
- 16.5.3.36 ShowArchiveFullPath
- 16.5.3.37 ShowColumnHeadings
- 16.5.3.38 ShowHiddenSpreadSheetData
- 16.5.3.39 ShowHiddenText
- 16.5.3.40 SimpleStyleNames
- 16.5.3.41 StrictFile
- 16.5.3.42 SuppressFontAttributes
- 16.5.3.43 TimeZoneOffset
- 16.5.3.44 TransparencyColor
- 16.5.3.45 UnicodeByteOrder
- 16.5.3.46 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 OutsideIn Class
- 16.15 OutsideInException Class