oXygen User Manual for Eclipse

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 stylesheets. 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 and Benefits
About the <oXygen/> User Manual
2. Installation
Installation Requirements
Platform Requirements
Operating System, Tools and Environment Requirements
Installation Instructions
Starting <oXygen/> plugin
Obtaining and Installing an <oXygen/> License
How floating licenses work
Upgrading <oXygen/>
Uninstalling the <oXygen/> plugin
Performance problems
Large documents
3. Getting started
Supported types of documents
Getting help
Perspectives
<oXygen/> XML perspective
<oXygen/> XSLT Debugger Perspective
4. Editing documents
Working with Unicode
Opening and closing documents
Creating new documents
Saving documents
Opening existing documents
Closing documents
Creating and sharing new document templates
Viewing file properties
Editing XML documents
Associate a schema to a document
Streamline with Tag-Insight
Debugging XML documents
Document navigation
Grouping documents in XML projects
Including document parts with XInclude
Working with XML Catalogs
Converting between schema languages
Generating HTML documentation for a XML Schema
Formatting and Indenting Documents (Pretty Print)
Schema diagram
Introduction
XML Schema diagram
Relax NG schema diagram
XML editor specific actions
Select actions
Source actions
XML document actions
XML Refactoring actions
XML Schema actions
5. Transforming documents
Output formats
Transformation scenario
Built-in transformation scenarios
Defining a new transformation scenario
Exporting and importing the transformation scenarios
XSL-FO processors
Common DocBook transformations
PDF Output
PS Output
TXT Output
HTML Output
HTML Help Output
JavaHelp Output
XHTML Output
Supported XSLT processors
Configuring the XSLT processor extensions paths
6. Querying documents
Running XPath expressions
What is XPath
<oXygen/>'s XPath console
Working with XQuery
What is XQuery
Syntax Highlight and Content Completion
XQuery Validation
Transforming XML Documents Using XQuery
7. Debugging XSLT stylesheets
Overview
Layout
Control Toolbar
Information views
Working with the XSLT Debugger
Steps in a typical debug process
Using breakpoints
Viewing processing information
Determining what template generated particular output
8. Profiling XSLT stylesheets
Overview
Viewing profiling information
Invocation tree view
Hotspots view
Working with XSLT profiler
9. Importing data
Introduction
Import from text files
Import from MS Excel files
Import from Database Data
Import from HTML files
10. Composing Web Service calls
Overview
Composing a SOAP request
11. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
12. Configuring the editor
Preferences
Global
Editor
XML
XSLT/FO
Database
Proxy Configuration
Certificates
Scenarios Management
Colors
Automatically importing the preferences from the other distribution
Importing/Exporting <oXygen/> preferences
Reset options

List of Figures

2.1. Registration Dialog
3.1. <oXygen/> XML perspective
3.2. <oXygen/> XSLT Debugger perspective
4.1. The New wizard
4.2. The Create an XML Document - XML Schema Tab
4.3. The Create an XML Document - DTD Tab
4.4. The Create an XML Document - Relax NG Tab
4.5. The Create an XML Document - NRL Tab
4.6. The New from Templates wizard
4.7. The Templates dialog
4.8. The Templates dialog
4.9. The Templates dialog
4.10. Tag-Insight driven by a Docbook DTD
4.11. Associate schema dialog
4.12. Tag-Insight Assistant
4.13. Schema annotations displayed at Tag Insight
4.14. The Model View
4.15. The Element Structure View.
4.16. The Annotation View
4.17. The Attributes View
4.18. The External validation dialog
4.19. Folding of the XML Elements
4.20. The Outliner Panel
4.21. Tag-Insight list over a document with no schema
4.22. The New wizard
4.23. The XML Project wizard - step 1
4.24. The XML Project wizard - step 2
4.25. Convert an edited schema
4.26. The XML Schema documentation dialog
4.27. XML Schema editor - diagram and source
4.28. Logical Model View for XML Schema
4.29. Full Model View
4.30. Logical Model View
4.31. Rename Prefix Dialog
5.1. The Configure Transformation Dialog
5.2. Configure parameters dialog
5.3. Edit additional XSL stylesheets list dialog
6.1. XQuery Tag Insight
6.2. XQuery Validation
7.1. Debugger Mode Interface
7.2. Control Toolbar
7.3. The Context node view
7.4. The XPath watch view
7.5. The Breakpoints view
7.6. The Break conditions view
7.7. The Messages view
7.8. The Stack view
7.9. The Trace History View
7.10. The Templates view
7.11. The Node Set view
7.12. The Variables view
7.13. Output to Source Mapping
8.1. Invocation tree view
8.2. Hotspots view
8.3. Source backmapping
9.1. The Import wizards of <oXygen/> plugin
9.2. Select text file Dialog
9.3. Import Text Criteria Dialog
9.4. Presentation Names
9.5. Select Excel Sheet
9.6. Select database table Dialog
9.7. Import from Database Criteria Dialog
9.8. Import HTML file - step 1
9.9. Import HTML - step 2
10.1. Content completion for WSDL documents
10.2. Validating a WSDL file
10.3. WSDL SOAP Analyser
10.4. WSDL File Opener
10.5. UDDI Registry Browser dialog
11.1. Canonicalization settings dialog
11.2. Signature settings dialog
11.3. Verifying signature dialog
12.1. The Global preferences
12.2. <oXygen/> XML Editor License dialog
12.3. The Aspect pane
12.4. The Format pane
12.5. The Save pane
12.6. The Code templates pane
12.7. The Default Schema Association pane
12.8. Schema mapping dialog
12.9. The Tag Insight Features pane
12.10. The Tag Insight XSL pane
12.11. Schema diagram configuration panel
12.12. The XML Catalog pane
12.13. The XML Parser Options pane
12.14. XSLT options
12.15. XSLT Saxon Options
12.16. XSLT Extensions options
12.17. Debugger Settings
12.18. Profiler Settings
12.19. The FO processors pane
12.20. Configure the external processors
12.21. The XPath pane
12.22. XQuery pane
12.23. Database import configuration panel
12.24. JDBC Drivers pane
12.25. The JDBC Drivers dialog
12.26. The Proxy Configuration Dialog
12.27. Certificates
12.28. The Scenarios Management pane
12.29. The Colors pane

List of Tables

7.1. XWatch details
7.2. Breakpoints details
7.3. Break conditions details
7.4. Messages details
7.5. Stack details
7.6. Trace History details
7.7. Templates details
7.8. Variables details

List of Examples

2.1. Example of Eclipse start command
4.1. The XSL code template called Template-Match-Mode
4.2. Check XML Form Error Message
4.3. Validate document Error Message
6.1. XPath Utilization with DocBook DTD