The oXygen User Guide

SyncRO Soft Ltd.

Sean Wheller

Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this book, and SyncRO Soft Ltd., was aware of a trademark claim, the designations have been printed in caps or initial caps. While every precaution has been taken in the preparation of this book, the publisher assumes no responsibility for errors or omissions, or for damages resulting from the use of the information contained herein.

Third party software components are distributed in the oXygen installation packages, including the Java Runtime Environment (JRE), DocBook DTD and style sheets. This product includes software developed by the Apache Software Foundation (http://www.apache.org): the Apache FOP, Xerces XML Parser and Xalan XSLT. These products are not the property of SyncRO Soft Ltd.. To the best knowledge of SyncRO Soft Ltd. owners of the aforesaid products granted permission to copy, distribute and/or modify the software and its documents under the terms of the Apache Software License, Version 1.1. Other packages are used under the GNU Lesser General Public License. Users are advised that the JRE is provided as a free software, but in accordance with the licensing requirements of Sun Microsystems. Users are advised that SyncRO Soft Ltd. assumes no responsibility for errors or omissions, or for damages resulting from the use of oXygen and the aforesaid third party software. Nor does SyncRO Soft Ltd. assume any responsibility for licensing of the aforesaid software, should the relevant vendors change their terms. By using oXygen the user accepts responsibility to maintain any licenses required by SyncRO Soft Ltd. or third party vendors. Unless SyncRO Soft Ltd. declares in writing that the oXygen license is inclusive of third party licensing.

Revision History
Revision 2.0.24 June 2003
Beta
Revision 2.028 March 2003
Release

Table of Contents

1. Introduction
Features and Benefits
What's new in oXygen XML Editor 2.0.2
About the oXygen Handbook
2. Installation
Installation Requirements
Platform Requirements
Operating System, Tools and Environment Requirements
Installation Instructions
Starting oXygen
Obtaining and Installing an oXygen License
Upgrading oXygen
Uninstalling oXygen
Preferences
Global
File Types
Proxy Configuration
Editor
Print
External FO processors
External Tools
Plugins
XML Catalog
XML Parser Features
Code Insight
Colors
Memory Management
3. Getting Started
Main Window
Main Menu
Main Toolbar
Project Panel
Editor Panel
Message Panel
Tree View Window
Main Menu
Main Toolbar
Tree Editing Toolbar
Editor Panel
Message Panel
Information Panel
Entities Panel
All Elements Panel
4. Editing Documents
Editing Preferences
Syntax Highlighting
Editing Font
Editor Formatting Preferences
Printing Scale
Code-Insight Configuration
Working with Documents
Creating New Documents
Opening, Saving and Closing Documents
Creating Documents based on Templates
Creating New Templates
Sharing Templates
Editing Documents
Debugging Your Documents
5. Transforming Documents
Transformation Configuration Options
Creating a Scenario
Example Transformation Configurations
PDF Output
PS Output
TXT Output
HTML Output
HTML Help Output
JavaHelp Output
XHTML Output
A. Appendix
Accelerator Shortcut Keys
The Main Editor
The Tree View Editor
Unicode Character Encoding
References

List of Figures

2.1. The Proxy Configuration Dialog
2.2. The Editor option
2.3. The Printing Scale option
3.1. The Main Interface
3.2. The Main Toolbar Buttons
3.3. The Project Toolbar
3.4. The Editor Panel
3.5. The Editor Document Tabs
3.6. The Editor Toolbar Buttons
3.7. The Editor Status Bar
3.8. The Message Panel
3.9. The Main Interface
3.10. The Main Toolbar Buttons
3.11. The Editor Panel
3.12. The Navigation Panel
3.13. The Editor Status Bar
3.14. The Message Panel
4.1. The Editing Font Dialog
4.2. The Editor option
4.3. The Printing Scale option
4.4. Code-Insight - Features option
4.5. Code-Insight - XML option
4.6. Code-Insight - XSL option
4.7. The Create an XML Document Dialog - XML Schema Tab
4.8. The Create an XML Document Dialog - DTD Tab
4.9. The Templates Dialog
4.10. Available Java Encodings Dialog
4.11. Code-Insight Assistant
4.12. Check Spelling Dialog
4.13. Options Dialog
4.14. Find/Replace Dialog
4.15. Search/Replace in Files
5.1. The Configure Transformation Dialog

List of Tables

3.1. File Menu Options
3.2. Edit Menu Options
3.3. Find Menu Options
3.4. Tree View Menu Options
3.5. Options Menu Options
3.6. Plugins Menu Options
3.7. External Tools Menu Options
3.8. Window Menu Options
3.9. XML Menu Options
3.10. Help Menu Options
3.11. Description of Main Toolbar Buttons
3.12. Description of Project Panel
3.13. Description of Project Toolbar Buttons
3.14. Description of Project View
3.15. Description of Project Menu
3.16. Description of Editor Toolbar Buttons
3.17. Description of Editor Space Menu
3.18. Message Panel Tab Menu
3.19. The Message Panel Menu
3.20. File Menu Options
3.21. Edit Menu Options
3.22. Insert Menu Options
3.23. Move Menu Options
3.24. Description of Main Toolbar Buttons
3.25. Description of Tree Editing Toolbar Buttons
3.26. Description of Editor Space Menu
3.27. Message Panel Tab Menu
3.28. The Message Panel Menu
3.29. Elements Information
3.30. Attributes Information
3.31. Entities Panel
3.32. All Elements Panel
A.1. Unicode to Java Name Matrix

List of Examples

2.1. Example Startup Script (Windows)
4.1. XPath Utilization with DocBook DTD
4.2. Check XML Form Error Message
4.3. Validate XML Error Message