<oXygen/> User Guide

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.


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
XML Parser Options
XSLT Options
Debugger Settings
FO processors
Plugins
External Tools
Menu shortcut keys
File Types
Proxy Configuration
Results / Output
Print
Colors
Main Window
Main Menu
Main Toolbar
Project Panel
Model View 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
Creating New Documents
Opening, Saving and Closing Documents
Opening Documents
Opening and Saving Remote Documents via FTP/WebDAV
Saving Documents
Closing Documents
XInclude
Associate schema
Converting Between Grammar Languages
Creating Documents based on Templates
Creating New Templates
Sharing Templates
Editing Documents
Working with Unicode
Streamline with Tag-Insight
Creating DTDs
Working with XML Catalogs
Formatting and Indenting Documents (Pretty Print)
Using XPath Expressions
Using Check Spelling
Using Search and Replace
Using Search and Replace in Files Dialog
Debugging Your Documents
Checking XML Form
Validating Documents
Quick Document Browsing Using Bookmarks
5. Transforming Documents
Transformation Scenarios
Creating a Scenario
The default scenario
Import/Export Transformation Scenarios
Example Transformation Scenarios
PDF Output
PS Output
TXT Output
HTML Output
HTML Help Output
JavaHelp Output
XHTML Output
Configuring the extension paths for transformer processors.
6. XSLT Debugger
Overview
Layout
Source document view (XML)
Stylesheet document view (XSL)
Output document view
Control view
Working with Debugger
Getting Started
The Debug Process
Understanding Information Views
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 XML Catalog pane
3.9. The XML Parser Options pane
3.10. The JAXP XSLT Transformer option
3.11. Debugger Settings
3.12. The FO processors pane
3.13. Configure the external processors
3.14. The Plugins pane
3.15. Configure External Tools
3.16. The Menu shortcut keys pane
3.17. The File Types
3.18. The Proxy Configuration Dialog
3.19. The Results/Output option
3.20. The Printing Scale option
3.21. The Colors pane
3.22. The Main Interface
3.23. The Main Toolbar Buttons
3.24. The Project Toolbar
3.25. The Editor Panel
3.26. The Editor Document Tabs
3.27. The Editor Toolbar Buttons
3.28. The Editor Status Bar
3.29. The Message Panel
3.30. The Outliner Panel
3.31. The Main Interface
3.32. The Main Toolbar Buttons
3.33. The Editor Panel
3.34. The Navigation Panel
3.35. The Editor Status Bar
3.36. The Message Panel
4.1. The Create an XML Document Dialog - XML Schema Tab
4.2. The Create an XML Document Dialog - DTD Tab
4.3. The Create an XML Document Dialog - Relax NG Tab
4.4. The Create an XML Document Dialog - NRL Tab
4.5. Open URL dialog
4.6. The server certificate is not available
4.7. Security alert - untrusted certificate
4.8. Associate schema dialog
4.9. Convert an edited grammar
4.10. The Templates Dialog
4.11. Available Java Encodings Dialog
4.12. Tag-Insight Assistant
4.13. Check Spelling Dialog
4.14. Options Dialog
4.15. Find/Replace Dialog
4.16. Search/Replace in Files
4.17. Link to specification for XML Schema errors
5.1. The Configure Transformation Dialog
5.2. Edit cascade stylesheets list dialog
6.1. Debugger Mode Interface
6.2. Control Toolbar
6.3. The Context node view
6.4. The XPath watch view
6.5. The Breakpoints view
6.6. The Messages view
6.7. The Stack view
6.8. The Trace History View
6.9. The Templates view
6.10. The Node Set view
6.11. The Variables view

List of Tables

3.1. File Menu Options
3.2. Edit Menu Options
3.3. Find Menu Options
3.4. Perspective Menu Options
3.5. Options Menu Options
3.6. Plugins Menu Options
3.7. Tools Menu Options
3.8. Document Menu Options
3.9. Window 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 Model View Panel
3.17. Description of the Element Structure View
3.18. Description of the Annotation View
3.19. Description of Editor Toolbar Buttons
3.20. Description of Editor Space Menu
3.21. Message Panel Tab Menu
3.22. The Message Panel Menu
3.23. File Menu Options
3.24. Edit Menu Options
3.25. Insert Menu Options
3.26. Move Menu Options
3.27. Description of Main Toolbar Buttons
3.28. Description of Tree Editing Toolbar Buttons
3.29. Description of Editor Space Menu
3.30. Message Panel Tab Menu
3.31. The Message Panel Menu
3.32. Elements Information
3.33. Attributes Information
3.34. Entities Panel
3.35. All Elements Panel
6.1. Context node details
6.2. XWatch details
6.3. Breakpoints details
6.4. Messages details
6.5. Stack details
6.6. Trace History details
6.7. Templates details
6.8. Node set details
6.9. Variables details
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 Message
4.5. Validate XML Error Message