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 3.09 January 2004
Revision 2.0.311 August 2003
Beta
Revision 2.0.24 June 2003
Beta
Revision 2.028 March 2003
Release

Table of Contents

1. Introduction
Key Features
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/>
Memory Management
3. Getting Started
Preferences
Global
Editor
XML Catalog
Menu shortcut keys
File Types
FO processors
External Tools
Results / Output
Plugins
XML Parser Options
JAXP XSLT Transformer
Print
Proxy Configuration
Colors
Main Window
Main Menu
Main Toolbar
Project Panel
Editor Panel
Message Panel
Outliner 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
Tag-Insight Configuration
Working with Documents
Creating New Documents
Opening, Saving and Closing Documents
Converting Between Grammar Languages
Creating Documents based on Templates
Creating New Templates
Sharing Templates
Editing Documents
Debugging Your Documents
5. Transforming Documents
Transformation Scenarios
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. Registration Dialog
3.1. The Global preferences
3.2. The Aspect pane
3.3. The Format pane
3.4. The Save pane
3.5. The Tag Insight Features pane
3.6. The Tag Insight Default pane
3.7. The Tag Insight XSL pane
3.8. The File Types
3.9. The Results/Output option
3.10. The JAXP XSLT Transformer option
3.11. The Printing Scale option
3.12. The Proxy Configuration Dialog
3.13. The Main Interface
3.14. The Main Toolbar Buttons
3.15. The Project Toolbar
3.16. The Editor Panel
3.17. The Editor Document Tabs
3.18. The Editor Toolbar Buttons
3.19. The Editor Status Bar
3.20. The Message Panel
3.21. The Outliner Panel
3.22. The Main Interface
3.23. The Main Toolbar Buttons
3.24. The Editor Panel
3.25. The Navigation Panel
3.26. The Editor Status Bar
3.27. The Message Panel
4.1. The Editing Font Dialog
4.2. The Editor option
4.3. The Printing Scale option
4.4. Tag-Insight - Features option
4.5. Tag-Insight - XML option
4.6. Tag-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 Create an XML Document Dialog - Relax NG Tab
4.10. The Create an XML Document Dialog - NRL Tab
4.11. Open URL dialog
4.12. The server certificate is not available
4.13. Security alert - untrusted certificate
4.14. Convert an edited grammar
4.15. The Templates Dialog
4.16. Available Java Encodings Dialog
4.17. Tag-Insight Assistant
4.18. Check Spelling Dialog
4.19. Options Dialog
4.20. Find/Replace Dialog
4.21. Search/Replace in Files
4.22. Link to specification for XML Schema errors
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. Description of Outline Toolbar Buttons
3.21. File Menu Options
3.22. Edit Menu Options
3.23. Insert Menu Options
3.24. Move Menu Options
3.25. Description of Main Toolbar Buttons
3.26. Description of Tree Editing Toolbar Buttons
3.27. Description of Editor Space Menu
3.28. Message Panel Tab Menu
3.29. The Message Panel Menu
3.30. Elements Information
3.31. Attributes Information
3.32. Entities Panel
3.33. All Elements Panel
A.1. Unicode to Java Name Matrix

List of Examples

2.1. Example Startup Script (Windows)
4.1. URLs that can be directly opened
4.2. Server URLs
4.3. XPath Utilization with DocBook DTD
4.4. Check XML Form Error MessageMessage d'erreur vérifier la forme XML
4.5. Validate XML Error Message