Table of Contents

Oracle Outside In HTML Export Developer's Guide

• Title and Copyright Information
• Preface
  • Audience
  • Documentation Accessibility
  • Related Documents
  • Conventions
• 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.4.1 Installing Multiple SDKs
    • 1.5 How to Use HTML Export
    • 1.6 Copyright Information
      • 1.6.1 Outside In HTML Export Licensing
  • 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.2 Browser Caching
      • 2.3.3 Errors Returned by HTML Export
      • 2.3.4 CSS Considerations
      • 2.3.5 XHTML
      • 2.3.6 Archive Support
      • 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.2 Compiling and Linking
    • 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.2 EXInsertText
      • 8.2.3 EXHideText
  • 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 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.2.1 batch_process_hx
      • 11.2.2 *sample
      • 11.2.3 export (Windows Only)
      • 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 Options
    • 12.1 HTML Export C/C++ Options
      • 12.1.1 Character Mapping
      • 12.1.2 Output
      • 12.1.3 Input Handling
      • 12.1.4 Layout
      • 12.1.5 Compression
      • 12.1.6 Graphics
      • 12.1.7 Spreadsheet and Database File Rendering
      • 12.1.8 Page Rendering
      • 12.1.9 Font Rendering
      • 12.1.10 Callbacks
      • 12.1.11 File System
      • 12.1.12 Template-Only Options
      • 12.1.13 Old Options
• 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
  • 14 HTML Export Java Classes
    • 14.1 Annotation Class
    • 14.2 Callback Class
      • 14.2.1 createNewFile
      • 14.2.2 newFileInfo
    • 14.3 ColorInfo Class
    • 14.4 Exporter Interface
      • 14.4.1 Document Interface
      • 14.4.2 OptionsCache Class
    • 14.5 ExportStatus Class
    • 14.6 FileFormat Class
    • 14.7 FontAliases Class
    • 14.8 FontInfo Class
    • 14.9 FontList Class
    • 14.10 GridWrapInfo Class
    • 14.11 HighlightTextAnnotation Class
    • 14.12 MailHeaders Class
    • 14.13 OutsideIn
    • 14.14 OutsideInException Class
    • 14.15 TreeRecord 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
  • 16 HTML Export .NET Functions
    • 16.1 Annotation Class
    • 16.2 Callback Class
      • 16.2.1 CreateNewFile
      • 16.2.2 NewFileInfo
    • 16.3 ColorInfo Class
    • 16.4 Exporter Interface
      • 16.4.1 Document Interface
      • 16.4.2 OptionsCache Class
    • 16.5 ExportStatus Class
    • 16.6 FileFormat Class
    • 16.7 FontAliases Class
    • 16.8 FontInfo Class
    • 16.9 FontList Class
    • 16.10 GridWrapInfo Class
    • 16.11 HighlightTextAnnotation Class
    • 16.12 MailHeaders Class
    • 16.13 OutsideIn Class
    • 16.14 OutsideInException Class
    • 16.15 TreeRecord Class