Oracle® Outside In HTML Export Developer's Guide Release 8.4.0 Part Number E12884-03 |
|
|
View PDF |
HTML Export allows an OEM to translate almost any document, spreadsheet, presentation, or graphic into high quality HTML.
HTML Export's primary goal is producing faithful representations of source files using the HTML, GIF, JPEG and PNG formats. With a C API , the developer can set various options that affect the content and structure of the output.
There may be references to other Outside In Technology SDKs within this manual. To obtain complete documentation for any other Outside In product, see:
http://www.oracle.com/technetwork/indexes/documentation/index.html#middleware
and click on Outside In Technology.
This chapter includes the following sections:
The updated list of supported formats is linked from the page http://www.outsideinsdk.com/
. Look for the data sheet with the latest supported formats.
In Chapter 4, "Data Access Common Functions," DASaveTreeRecord has a new dwSpecType. IOTYPE_REDIRECT specifies that redirected I/O will be used to save the file.
The new value SCCUT_WP_EMAILHEADERNONE has been added to the SCCOPT_WPEMAILHEADEROUTPUT option. This will produce no email header fields.
IBM AIX 32-bit and HP-UX RISC 32-bit support has been added for the SCCOPT_RENDERING_PREFER_OIT option.
When automatic font color is selected in Microsoft Office (the default setting), the application renders the text as white if the text is on a dark background. The Outside In Technology now assumes the same behavior.
A new option, SCCOPT_SYSTEMFLAGS, allows you to control miscellaneous interactions between the developer and the Outside In Technology.
Two new options, SCCOPT_MAILHEADERVISIBLE and SCCOPT_MAILHEADERHIDDEN, allow you to control what email headers are rendered.
Support has been added for Microsoft Project Note field rich text.
The core rendering engine has been changed to apply the SMALLCAPS character attribute.
NSF support has been added for the Win x86-64 platform. Please see Section 2.1.1, "NSF Support" for more details.
A new function has been added: DAInitEx. It replaces DAInit and DAThreadInit and adds an option not to load or save the options file.
The following new sample applications have been added:
batch_process_hx demonstrates running HTML Export in a separate process on multiple input files.
extract_archive demonstrates using the DATree API to extract all nodes in an archive.
Support has been added for AutoCAD 2011 and 2012 files, using the OpenDesign Alliance's Teigha 3.05.00 libraries.
Support has been added for Hangul 2010 documents.
Scalable Vector Graphics (SVG) files are now identified and processed by the XML filter.
When saving email messages that have been created in HTML format, Outlook creates two message bodies, a plain text body and an RTF body that contains embedded HTML. Support has been added for the HTML embedded in the RTF.
Support has been added to extract and render MSGs and EMLs to which a digital signature has been applied.
A new option, SCCOPT_HTML_COND_COMMENT_MODE (SOAP equivalents: htmlCondCommentIE5On, htmlCondCommentIE6On, htmlCondCommentIE7On, htmlCondCommentIE8On, htmlCondCommentIE9On, htmlCondCommentAllOn), allows you to control which special comments targeted for particular versions of browsers or other products that are found in the HTML will be included in the output.
PDF files created by Acrobat 10 are now validated and processed.
Support has been added for the extraction of table data in a Microsoft Jet 3.x- or 4.x-based file. This means that for database files created in Access 95, 97, 2000, 2002, 2003, 2007, and 2010, the TABLES data can be extracted.
Support has been added for text extraction from Microsoft OneNote 2007 and 2010 files.
Support has been added for Outlook 2010 PST and OST files, including support for High Encryption in all versions of Outlook PST and OST files.
Support has been added for rendering Outlook MSG files: Note, Task, Appointment, Contact, and Journal.
Support has been added for two types of Office 2003 files: WordProcessingML (Word 2003), text only; and SpreadSheetML (Excel 2003), text only. The XML version of the binary format will be processed, skipping embedded objects and tagging properties.
Support has been added for IBM SmartSuite 9.8 files: Lotus WordPro, Lotus 1-2-3, and Lotus Freelance.
Support has been added for Apple iWork 09 files for Mac OSX: Pages 09 PDF Preview & Text, Numbers 09 PDF Preview & Text, and Keynote 09 PDF Preview & Text.
Support has been added for WordPerfect X5 files: Word Processor, Quattro Pro, and Presentations.
Support has been added for Adobe Creative Suite 5 files: Photoshop CS5, Illustrator CS5, and InDesign CS5.
Support has been added for the IBM AIX PPC (64-bit) OS version 7.1.
Support has been added for SUSE 11 on IBM Linux System z (64-bit).
Support has been added for SUSE Linux (Itanium 64), Enterprise Server 9, and support for Enterprise Server 8 has been dropped.
Certification on HP-UX PA-RISC 11 (32-bit) has been discontinued.
Support has been added for Red Hat Linux (x86 64-bit), Red Hat Enterprise Linux (RHEL) 6.
Certification on Windows 2000 has been discontinued.
The Embedded Object Names feature has been improved to take a three-tiered approach to presenting this string for embedded images. First, it will try to use the Alt String that the Microsoft Office product offers for the image, if present. Second, it will try to use the EmbeddedName String, if present. Third, it falls back to the default HTML Export naming scheme for images if the first two strings are not present.
A new function, EXExportStatus, has been added to determine if there were conversion problems during an export.
Support has been added for PDF input for Global Streams in JBIG2 Explicit masks.
Support has been added for viewing compressed PDF files.
The PDF filter has been updated to enable support for PDFs using AES 256-bit encryption.
Note:
Not all formats that use passwords are supported. Only Microsoft Office binary (97-2003) and Microsoft Office 2007, Lotus NSF, PDF (with RC4 encryption), Zip (with AES 128 & 256 bit, ZipCrypto) are currently supported.
Fonts embedded in PDF input files are now extracted and used to render text.
Transformation Server has been ported to Windows x86-64.
The basic architecture of Outside In technologies is the same across all supported platforms.
Filter/Module | Description |
---|---|
Input Filter |
The input filters form the base of the architecture. Each one reads a specific file format or set of related formats and sends the data to OIT through a standard set of function calls. There are more than 150 of these filters that read more than 500 distinct file formats. Filters are loaded on demand by the data access module. |
Export Filter |
Architecturally similar to input filters, export filters know how to write out a specific format based on information coming from the chunker module. The export filters generate HTML, GIF, JPEG, and PNG. |
Chunker |
The Chunker module is responsible for caching a certain amount of data from the filter and returning this data to the export filter. |
Export |
The Export module implements the export API and understands how to load and run individual export filters. |
Data Access |
The Data Access module implements a generic API for access to files. It understands how to identify and load the correct filter for all the supported file formats. The module delivers to the developer a generic handle to the requested file, which can then be used to run more specialized processes, such as the Export process. |
The following terms are used in this documentation.
Term | Definition |
---|---|
Developer |
Someone integrating this technology into another technology or application. Most likely this is you, the reader. |
Source File |
The file the developer wishes to export. |
Output File |
The file being written: HTML, CSS, JavaScript, GIF, JPEG, and PNG. |
Page |
A single text and its associated graphics to make a page of output. Pages have suggested lengths, but the actual length may be greater or smaller than the suggested value. Page sizes count only the bytes of visible text in the document, not markup. |
Data Access Module |
The core of Outside In Data Access, in the SCCDA library. |
Data Access Submodule (also referred to as "Submodule") |
This refers to any of the Outside In Data Access modules, including SCCEX (Export), but excluding SCCDA (Data Access). Note: HTML Export normally comes with only the SCCEX Submodule. |
Document Handle (also referred to as " |
A Document Handle is created when a file is opened using Data Access (see Chapter 4, "Data Access Common Functions"). Each Document Handle may have any number of Subhandles. |
Subhandle (also referred to as " |
Any of the handles created by a Submodule's |
Each Outside In product has an sdk directory, under which there is a subdirectory for each platform on which the product ships (for example, hx/sdk/hx_win-x86-32_sdk). Under each of these directories are the following three subdirectories:
docs - Contains both a PDF and HTML version of the product manual.
redist - Contains only the files that the customer is allowed to redistribute. These include all the compiled modules, filter support files, .xsd and .dtd files, cmmap000.bin, and third-party libraries, like freetype.
sdk - Contains the other subdirectories that used to be at the root-level of an sdk (common, lib (windows only), resource, samplefiles, and samplecode (previously samples). In addition, one new subdirectory has been added, demo, that holds all of the compiled sample apps and other files that are needed to demo the products. These are files that the customer should not redistribute (.cfg files, exportmaps, etc.).
In the root platform directory (for example, hx/sdk/hx_win-x86-32_sdk), there are two files:
README - Explains the contents of the sdk, and that makedemo must be run in order to use the sample applications.
makedemo (either .bat or .sh – platform-based) - This script will either copy (on Windows) or Symlink (on Unix) the contents of …/redist into …/sdk/demo, so that sample applications can then be run out of the demo directory.
If you load more than one OIT SDK, you must copy files from the secondary installations into the top-level OIT SDK directory as follows:
docs – copy all subdirectories named “[product name]guide” into this directory.
redist – copy all binaries into this directory.
sdk – this directory has several subdirectories: common, demo, lib, resource, samplecode, samplefiles. In each case, copy all of the files from the secondary installation into the top-level OIT SDK subdirectory of the same name. If the top-level OIT SDK directory lacks any directories found in the directory being copied from, just copy those directories over.
Here's a step-by-step overview of how to export a source file to HTML.
Call DAIniExt to initialize the Data Access technology. This function needs to be called only once per application. If using threading, then pass in the correct ThreadOption.
Set any options that require a NULL handle type (optional). Certain options need to be set before the desired source file is opened. These options are identified by requiring a NULL handle type. They include, but aren't limited to:
SCCOPT_FALLBACKFORMAT
SCCOPT_FIFLAGS
SCCOPT_TEMPDIR
SCCOPT_EX_CALLBACKS
SCCOPT_EX_UNICODECALLBACKSTR
SCCOPT_UNMAPPABLECHAR
Open the source file. DAOpenDocument is called to create a document handle that uniquely identifies the source file. This handle may be used in subsequent calls to the EXOpenExport function or the open function of any other Data Access Submodule, and will be used to close the file when access is complete. This allows the file to be accessed from multiple Data Access Submodules without reopening.
Set the Options. If you require option values other than the default settings, call DASetOption to set options. Note that options listed in the Options chapter as having "Handle Types" that accept VTHEXPORT may be set any time before EXRunExport is called. For more information on options and how to set them, see Section 4.7, "DASetOption."
Open a Handle to HTML Export. Using the document handle, EXOpenExport is called to obtain an export handle that identifies the file to the specific export product. This handle will be used in all subsequent calls to the specific export functions. The dwOutputId parameter of this function is used to specify that the output file type should be set to FI_HTML.
Make Any Required Calls to Annotation Functions. This is the point at which any calls to annotation functions (such as EXHiliteText, EXInsertText or EXHideText) should be made.
Export the File. EXRunExport is called to generate the output file(s) from the source file.
Close the Handle to HTML Export. EXCloseExport is called to terminate the export process for the file. After this function is called, the export handle will no longer be valid, but the document handle may still be used.
Close the Source File. DACloseDocument is called to close the source file. After calling this function, the document handle will no longer be valid.
Close HTML Export. DADeInit is called to de-initialize the Data Access technology.
The following notice must be included in the documentation, help system, or About box of any software that uses any of Oracle's executable code:
Outside In HTML Export © 1991, 2012 Oracle.
The following notice must be included in the documentation of any software that uses Oracle's TIF6 filter (this filter reads TIFF and JPEG formats):
The software is based in part on the work of the Independent JPEG Group.