oXygen User Manual for Eclipse

SyncRO Soft Ltd.

Contributor: 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
Named User license installation
How floating (concurrent) 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
<oXygen/> XQuery Debugger Perspective
4. Editing documents
Working with Unicode
Opening and saving Unicode documents
Opening and closing documents
Creating new documents
Saving documents
Closing documents
Creating and sharing new document templates
Viewing file properties
Editing XML documents
Associate a schema to a document
Streamline with Content Completion
Debugging XML documents
Document navigation
Grouping documents in XML projects
Including document parts with XInclude
Working with XML Catalogs
Converting between schema languages
Formatting and indenting documents (pretty print)
Viewing status information
XML editor specific actions
Editing XML Schema schemas
Special content completion features
XML Schema diagram
Create an XML Schema from a relational database table
XML Schema Instance Generator
Flatten an XML Schema
XML Schema regular expressions builder
Generating HTML documentation for an XML Schema
XML Schema editor specific actions
Search References and Declarations
Editing Relax NG schemas
Relax NG schema diagram
Relax NG editor specific actions
Search References and Declarations
Editing XSLT stylesheets
Validating XSLT stylesheets
Content Completion in XSLT stylesheets
The XSLT Input View
The Stylesheet Templates view
Finding XSLT references and declarations
XSLT refactoring actions
Editing XQuery documents
Generating HTML Documentation for an XQuery Document
Editing CSS stylesheets
Validating CSS stylesheets
Content Completion in CSS stylesheets
Folding in CSS stylesheets
Formatting and indenting CSS stylesheets (pretty print)
Other CSS editing actions
Scratch Buffer
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 transformations
PDF Output
PS Output
TXT Output
HTML Output
HTML Help Output
JavaHelp Output
XHTML Output
Supported XSLT processors
Configuring custom XSLT processors
Configuring the XSLT processor extensions paths
6. Querying documents
Running XPath expressions
What is XPath
<oXygen/>'s XPath toolbar
Working with XQuery
What is XQuery
Syntax Highlight and Content Completion
XQuery Validation
Other XQuery editing actions
Transforming XML Documents Using XQuery
How to configure eXist support in <oXygen/>
How to configure Berkeley DB XML support in <oXygen/>
How to configure TigerLogic support in <oXygen/>
How to configure X-Hive/DB support in <oXygen/>
How to configure MarkLogic support in <oXygen/>
7. Debugging XSLT stylesheets and XQuery documents
Overview
Layout
Control Toolbar
Information views
Multiple output documents in XSLT 2.0
Working with the XSLT/XQuery Debugger
Steps in a typical debug process
Using breakpoints
Viewing processing information
Determining what XSL/XQuery expression generated particular output
8. Profiling XSLT stylesheets and XQuery documents
Overview
Viewing profiling information
Invocation tree view
Hotspots view
Working with XSLT/XQuery profiler
9. Importing data
Introduction
Import from database
Import table content as XML document
Convert table structure to XML Schema
Import from MS Excel files
Import from HTML files
Import from text files
10. Composing Web Service calls
Overview
Composing a SOAP request
Testing remote WSDL files
The UDDI Registry browser
Generate WSDL documentation
11. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
12. Configuring the editor
Reset options
Preferences
Global
Editor
CSS Validator
XML
Database
HTTP / FTP / Proxy Configuration
Certificates
Scenarios Management
View
Syntax Highlight
Elements by Prefix
Automatically importing the preferences from the other distribution
Importing/Exporting <oXygen/> preferences
13. Common problems

List of Figures

2.1. Registration Dialog
2.2. Floating license number exceeded
3.1. <oXygen/> XML perspective
3.2. The Outline view
3.3. The Text view
3.4. The Browser view
3.5. The XPath view
3.6. <oXygen/> XSLT Debugger perspective
3.7. <oXygen/> XQuery 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. The Properties view
4.11. Content completion driven by a Docbook DTD
4.12. Associate schema dialog
4.13. Content Completion Assistant
4.14. Content Completion assistant - element values in Relax NG documents
4.15. Schema annotations displayed at Content Completion
4.16. The Model View
4.17. The Element Structure panel
4.18. The Annotation panel
4.19. The Attributes panel
4.20. The External validation dialog
4.21. Automatic validation of the edited document
4.22. External validation toolbar
4.23. Folding of the XML Elements
4.24. The Outliner view
4.25. Popup menu of the Outline tree
4.26. Content Completion list over a document with no schema
4.27. The New wizard
4.28. The XML Project wizard - step 1
4.29. The XML Project wizard - step 2
4.30. Convert an edited schema
4.31. The Console view messages
4.32. Rename Prefix Dialog
4.33. Example of coloring XML tags by prefix
4.34. Schematron support in XML Schema content completion
4.35. XML Schema editor - full model view
4.36. Edit attributes of current XML Schema element
4.37. Logical Model View for XML Schema
4.38. Schema components view for XML Schema
4.39. The Generate Sample XML Files dialog
4.40. The Generate Sample XML Files dialog
4.41. XML Schema regular expressions builder dialog
4.42. The XML Schema documentation dialog
4.43. Relax NG schema editor - full model view
4.44. Logical Model View for a Relax NG schema
4.45. Schema components view for Relax NG
4.46. External validation toolbar
4.47. Namespace prefixes in the content completion window
4.48. Content Completion in the match attribute
4.49. Content Completion in the select attribute
4.50. Content Completion in the test attribute
4.51. Content Completion in the test attribute
4.52. Content Completion in attribute value templates
4.53. XSLT input view
4.54. XSLT Input drag and drop popup menu
4.55. XSLT Input drag and drop result
4.56. The Stylesheet Templates view
4.57. The XQuery Documentation dialog
4.58. Content Completion in CSS stylesheets
4.59. Folding in CSS stylesheets
5.1. The Configure Transformation Dialog - XSLT Tab
5.2. The Configure Transformation Dialog - FO Processor Tab
5.3. The Configure Transformation Dialog - Output Tab
5.4. Configure parameters dialog
5.5. Edit additional XSL stylesheets list dialog
5.6. The XSLT/XQuery Extension Edit Dialog
6.1. Content Completion in the XPath console
6.2. XQuery Content Completion
6.3. XQuery Validation
7.1. Debugger Mode Interface
7.2. Control Toolbar
7.3. Multiple output documents in XSLT 2.0
7.4. The Context node view
7.5. The XPath watch view
7.6. The Breakpoints view
7.7. The Break conditions view
7.8. The Messages view
7.9. The Stack view
7.10. The Trace History View
7.11. The Templates view
7.12. The Node Set view
7.13. The Variables view
7.14. 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 database table Dialog
9.3. Import from Database Criteria Dialog
9.4. Select database table
9.5. Select Excel Sheet
9.6. Import HTML file - step 1
9.7. Import HTML - step 2
9.8. Select text file Dialog
9.9. Import Text Criteria Dialog
9.10. Presentation Names
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
10.6. WSDL Documentation dialog
11.1. Canonicalization settings dialog
11.2. Signature settings dialog
11.3. Verifying signature dialog
12.1. Eclipse Preferences dialog - restricted version
12.2. The Global preferences panel
12.3. <oXygen/> XML Editor License dialog
12.4. The Editor preferences panel
12.5. The Format preferences panel
12.6. The XML format preferences panel
12.7. The CSS format preferences panel
12.8. The Save preferences panel
12.9. The Code Templates preferences panel
12.10. The Default Schema Association preferences panel
12.11. The Schema mapping dialog
12.12. The Content Completion Features preferences panel
12.13. The Content Completion XSL/XPath preferences panel
12.14. Schema diagram preferences panel
12.15. Spell check preferences panel
12.16. Document checking preferences panel
12.17. Custom validation preferences panel
12.18. CSS Validator preferences panel
12.19. The XML Catalog preferences panel
12.20. The XML Parser preferences panel
12.21. The XSLT preferences panel
12.22. The Saxon 6 XSLT preferences panel
12.23. The Saxon 8 XSLT preferences panel
12.24. The XSLTProc preferences panel
12.25. The MSXML preferences panel
12.26. The MSXML.NET preferences panel
12.27. The XQuery preferences panel
12.28. The Saxon XQuery preferences panel
12.29. The eXist preferences panel
12.30. The Berkeley DB XML preferences panel
12.31. The X-Hive/DB preferences panel
12.32. The MarkLogic preferences panel
12.33. The TigerLogic preferences panel
12.34. The Debugger preferences panel
12.35. The Profiler preferences panel
12.36. The FO Processors preferences panel
12.37. The external FO processor configuration dialog
12.38. The XPath preferences panel
12.39. Configuration of custom transformation engines
12.40. Parameters of a custom transformation engine
12.41. The JDBC Drivers preferences panel
12.42. The JDBC Drivers dialog
12.43. The Database import preferences panel
12.44. The Proxy Configuration preferences panel
12.45. The Certificates preferences panel
12.46. The Scenarios Management preferences panel
12.47. The View preferences panel
12.48. The Colors preferences panel
12.49. The Elements by Prefix preferences panel

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. Check XML Form Error Message
4.2. Validate document error message
4.3. The XSL code template called Template-Match-Mode
6.1. XPath Utilization with DocBook DTD