upCast 5.5

User Manual and Reference

Christian Roth

infinity-loop GmbH

Stefan Hermann

infinity-loop GmbH

Information in this document is subject to change without any prior notice. The software described in this document is furnished under a license agreement. The software may be used or copied only in accordance with the terms of the license agreement.

All product names identified throughout this document are trademarks or registered trademarks of their respective owners.

No part of this publication may be reproduced in any form or distributed in any form by any means, in whole or in part, without the prior written permission of infinity-loop GmbH.

Changed content (compared to the previous release) is marked with a beige sidebar on the right.

New content (compared to the previous release) is marked with a green sidebar.

Revision History
Revision 12003-03-22cr
initial version
Revision 22003-04-15cr
updated to UpcastEngine class
Revision 32003-09-06cr
changed 'span' to 'inline'
Revision 42003-10-14cr
updated for 4.0.2 release
Revision 52003-11-16cr
updated for custom encodings and use of stdfonts.config
Revision 62004-03-16cr
updated for changes in 5.0
Revision 72004-06-18cr
updated for changes in 5.1
Revision 82004-07-28cr
updated for changes in 5.2
Revision 92005-05-14cr
updated for changes in 5.3.0
Revision 102005-07-04cr
updated for changes in 5.3.2: stdfonts.config
Revision 112005-11-01cr
updated for changes in 5.4.0
Revision 122008-04-04cr
updated for changes in 5.5.1

Table of Contents

1. Introduction
1. Document Conversion
2. The name: upCast
2. Product Overview
1. Features
2. Architecture & Concepts
2.1. Modules
2.2. Filter Concept
3. Getting started
1. Installation
1.1. Windows 95/98/2000/NT/XP
1.2. Mac OS X
1.3. Unix/Linux/Solaris
2. Running the application
2.1. Windows 95/98/2000/NT/XP
2.2. Mac OS X
2.3. Unix/Linux/Solaris
3. Supplying a License file
3.1. Importing a license
3.2. File based licensing
3.3. JAR based licensing
4. Using upCast
1. Quick Tour: upCast in seven steps
2. Basic operations
2.1. Choosing an import filter
2.2. Configuring an import filter
2.3. Choosing the source file
2.4. Adding an Export Filter
2.5. Configuring an Export Filter
2.6. Removing an Export Filter
2.7. Choosing the destination folder
2.8. Specifying a separate destination folder for images
2.9. The conversion process
2.10. Aborting a running conversion
3. Working with Configurations
3.1. What is a configuration?
3.2. Saving a configuration
3.3. Opening a configuration
3.4. A special configuration: preferences.plist
4. Logging
5. Magic Folders and Locations
5. Filter Reference
1. Document Preprocessing
1.1. WordLink
2. Import Filters
2.1. (none)
2.2. RTF 1.6
2.3. Batch Processor
3. Export Filters
3.1. XML (upCast DTD)
3.2. XHTML 1.0 (strict)
3.3. XHTML 1.0 (transitional)
3.4. External CSS2
3.5. XML Validator
3.6. Commandline Processor
3.7. XSLT Processor
3.8. DocBook 4.2
3.9. XML (Raw)
3.10. Unicode Translator
6. Menu Reference
1. File
2. Extras
3. Help
7. Configuration File Format Reference
1. General format description
2. Export Filter Preferences
3. Preference Keys Reference
8. BCF Reference
1. Using the built-in batch processor
2. General BCF file structure
3. Element Reference
4. Examples
9. upCast API Reference
1. Concepts
2. Using the API
3. General programming steps
3.1. Setup
3.2. The UpcastEngine object
3.3. Importing a document
3.4. Exporting a document
3.5. Setting global parameters
3.6. Error Handling
3.7. Cleanup
4. Method reference
5. Parameter reference
5.1. Global parameters
5.2. Import Filter parameters
5.3. Export Filter parameters
10. upCast Commandline Interface
1. Reference
2. Example
3. Commandfile syntax
11. upCast Simplified Commandline Interface
1. Reference
2. Example
12. Export Filter API
13. Inline Processor API
14. Section Processor API
15. RTF Conversion Technical Information
1. General
2. Bookmark Handling
3. Calculated fields
3.1. Simple fields (flat fields)
3.2. Nested fields (hierarchical fields, expressions)
4. The hidden element
5. Overview: Supported RTF Symbols
16. upCast DTD
17. Support file formats
1. stdfonts.config
1.1. Properties and Values
1.2. Options
1.3. File structure
1.4. Matching Algorithm
2. Custom Encodings
2.1. How it works
2.2. Associating a Font with an Encoding
2.3. File format
3. Unicode translation map
4. CSS property unit table
5. XML Catalog
5.1. upCast Catalog support
5.2. How-To: Adding new local DTDs
A. System Requirements
1. General
2. Windows 95/98/2000/NT/XP
3. Mac OS X
4. Unix/Linux/Solaris
B. Technical Support
C. Copyright, Licenses, Legal, Acknowledgements