oXygen XML Editor 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
Operating System
Tools
Environment Prerequisites
Installation Instructions
Starting <oXygen/> plugin
Obtaining and registering a license key
Named User license installation
How floating (concurrent) licenses work
How to install the <oXygen/> license server as a Windows service
How to release a floating license
Unregistering the license key
Upgrading the <oXygen/> application
Uninstalling the <oXygen/> plugin
Performance problems
Large documents
3. Getting started
Supported types of documents
Getting help
Perspectives
<oXygen/> XML perspective
Supported editor types
<oXygen/> XSLT Debugger Perspective
<oXygen/> XQuery Debugger Perspective
<oXygen/> Database perspective
4. Editing documents
Working with Unicode
Opening and saving Unicode documents
Opening and closing documents
Creating new documents
<oXygen/> plugin wizards
Creating Documents based on Templates
Saving documents
Opening and Saving Remote Documents via FTP/SFTP/WebDAV
Changing file permissions on a remote FTP server
WebDAV over HTTPS
Opening the current document in a Web browser
Closing documents
Creating and sharing new document templates
Creating a new document template
Sharing document templates
Viewing file properties
Editing XML documents
Associate a schema to a document
Setting a schema for the Content Completion
Setting a default schema
Adding a Processing Instruction
Learning document structure
Streamline with Content Completion
Code templates
Content Completion helper panels
The Model panel
The Element Structure panel
The Annotation panel
The Attributes panel
Correcting XML documents
Checking XML Form
Validating Documents
Marking Validation Errors
Caching the Schema Used for Validation
Validate As You Type
Custom validation of XML documents
Validation Scenario
Validation Actions in the User Interface
Document navigation
Folding of the XML elements
Outliner View
XML Document Overview
Modification Follow-up
Document Structure Change
The popup menu of the Outline tree
Document Tag Selection
Grid Editor
Layouts: Grid and Tree
Navigating the grid
Expand All Action
Collapse All Action
Expand Children Action
Collapse Children Action
Collapse Others
Specific Grid Actions
Sorting a Table Column
Inserting a row to a table
Inserting a column into a table
Clearing the content of a column
Adding nodes
Duplicating nodes
Refresh layout
Start editing a cell value
Stop editing a cell value
Drag and Drop(DnD) in the Grid Editor
Copy and Paste in the Grid Editor
Bidirectional Text Support in the Grid Editor
Grouping documents in XML projects
Large Documents
Creating an included part
Creating a new project
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
Edit actions
Select actions
Source actions
XML document actions
XML Refactoring actions
Smart editing
Syntax highlight depending on namespace prefix
Editing XML Schema schemas
Special content completion features
XML Schema diagram
Introduction
Full model view
Logical model view
Schema components view
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
XML Schema actions
Editing Relax NG schemas
Relax NG schema diagram
Introduction
Full model view
Logical model view
Schema components view
Relax NG editor specific actions
Search References and Declarations
Editing NVDL schemas
NVDL schema diagram
Introduction
Full model view
Schema components view
NVDL editor specific actions
Search References and Declarations
Editing XSLT stylesheets
Validating XSLT stylesheets
Custom validation of XSLT stylesheets
Content Completion in XSLT stylesheets
Content Completion in XPath expressions
Tooltip Helper for the XPath Functions Arguments
Code templates
The XSLT/XQuery Input View
The XSLT Input View
The Query Input View
The Stylesheet Templates View
Finding XSLT references and declarations
XSLT refactoring actions
Editing XQuery documents
Folding in 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
Changing the user interface language
5. Transforming documents
Output formats
Transformation scenario
Built-in transformation scenarios
Defining a new transformation scenario
XSLT Stylesheet Parameters
Additional XSLT Stylesheets
Scenario Editor Variables
XSLT/XQuery Extensions
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 console
Working with XQuery
What is XQuery
Syntax Highlight and Content Completion
XQuery Validation
Other XQuery editing actions
Transforming XML Documents Using XQuery
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
Inserting breakpoints
Removing breakpoints
Viewing processing information
Context node view
XPath watch view
Breakpoints View
Break conditions view
Messages View
Stack View
Trace history view
Templates view
Node set view
Variables View
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. Working with Databases
Relational Database Support
Configuring Database Data Sources
How to configure an IBM DB2 Data Source
How to configure a Generic JDBC Data Source
How to configure a Microsoft SQL Server Data Source
How to configure a MySQL Data Source
How to configure an Oracle 10.2 Data Source
Configuring Database Connections
How to Configure an IBM DB2 Connection
How to Configure a JDBC-ODBC Connection
How to Configure a Microsoft SQLServer Connection
How to Configure a MySQL Connection
How to Configure an Oracle 10.2 Connection
Resource Management
Database Explorer View
Actions available at connection level
Actions available at catalog level
Actions available at schema level
Actions available at table level
XML Schema Repository level
Oracle's XML Schema Repository Level
IBM DB2's XML Schema Repository Level
Microsoft SQL Server's XML Schema Repository Level
Table Explorer View
SQL Execution Support
Drag and Drop from Database Explorer
SQL Validation
Executing SQL Statements
Importing from Databases
Creating XML Schema from Databases
Native XML Database (NXD) Support
Configuring Database Data Sources
How to configure a Berkeley DB XML datasource
How to configure an eXist datasource
How to configure a MarkLogic datasource
How to configure a Software AG Tamino datasource
How to configure a Raining Data TigerLogic datasource
How to configure an X-Hive/DB datasource
Configuring Database Connections
How to configure a Berkeley DB XML Connection
How to configure an eXist Connection
How to configure a MarkLogic Connection
How to configure a Software AG Tamino Connection
How to configure a Raining Data TigerLogic Connection
How to configure an X-Hive/DB Connection
Resource Management
Database Explorer View
Oracle XML DB Browser
Actions available at XML Repository level
Actions available at container level
Actions available at resource level
Berkeley DB XML Connection
Actions available at connection level
Actions available at container level
Actions available at resource level
eXist Connection
Actions available at connection level
Actions available at container level
Actions available at resource level
MarkLogic Connection
Software AG Tamino Connection
Actions available at connection level
Actions available at collection level
Actions available at schema level
Actions available at resource level
Raining Data TigerLogic Connection
X-Hive/DB Connection
Actions available at connection level
Actions available at catalog level
Actions available at schema resource level
Actions available at library level
Actions available at resource level
X-Hive parser configuration for adding XML instances
XQuery and Databases
Drag and Drop from Database Explorer
XQuery validation
XQuery transformation
XQuery database debugging
10. 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
11. Composing Web Service calls
Overview
Composing a SOAP request
Testing remote WSDL files
The UDDI Registry browser
Generate WSDL documentation
12. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
13. Configuring the application
Importing/Exporting Global Options
Preferences
Global
Editor
Grid
Format
XML Format
CSS Format
Javascript Format
Content Completion
XSL/XPath
Syntax Highlight
Syntax highlight elements by Prefix
Save
Code Templates
Diagram
Spell Check
Document Checking
Default Schema Association
Custom Validation
CSS Validator
XML
XML Catalog
XML Parser
XML Instances Generator
XSLT/FO/XQuery
XSLT
Saxon6
Saxon8
Saxon8 Advanced options
XSLTProc
MSXML
MSXML.NET
XQuery
Saxon 8
Saxon8 Advanced options
Debugger
Profiler
FO Processors
XPath
Custom engines
Import
Date/Time format
Date/Time Patterns
Data Sources
Configuration of Data Sources
Download links for database drivers
Table Filters
HTTP / Proxy Configuration
HTTP / FTP / SFTP / Proxy Configuration/ FTP / SFTP
Certificates
Scenarios Management
Outline
View
Automatically importing the preferences from the other distribution
Reset Global Options
Scenarios Management
14. Common problems

List of Figures

2.1. Registration Dialog
2.2. Floating license number exceeded
2.3. Unregister a license key
3.1. <oXygen/> XML perspective
3.2. The Outline View
3.3. The Text View
3.4. The Browser View
3.5. The XPath Results View
3.6. <oXygen/> XSLT Debugger perspective
3.7. <oXygen/> XQuery Debugger perspective
3.8. Database 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 Create an XML Document - NVDL Tab
4.7. The New from Templates wizard
4.8. The Templates dialog
4.9. The Templates dialog
4.10. The Templates dialog
4.11. Open URL dialog
4.12. FTP server - change file permissions
4.13. The server certificate is not available
4.14. Security alert - untrusted certificate
4.15. The Properties View
4.16. Content completion driven by a Docbook DTD
4.17. Associate schema dialog
4.18. Content Completion Assistant
4.19. Content Completion assistant - element values in Relax NG documents
4.20. Schema annotations displayed at Content Completion
4.21. The Model View
4.22. The Element Structure panel
4.23. The Annotation panel
4.24. The Attributes panel
4.25. Validate as you type on the edited document
4.26. External validation toolbar
4.27. Configure Validation Scenarios
4.28. Edit a Validation Scenario
4.29. Edit a Validation Unit
4.30. Edit a Validation Unit
4.31. The External validation dialog
4.32. Folding of the XML Elements
4.33. The Outliner View
4.34. Popup menu of the Outline tree
4.35. Edit attributes dialog
4.36. The Grid Editor
4.37. Content Completion in Grid Editor
4.38. Grid Layout
4.39. Tree Layout
4.40. Initial configuration of grid tab
4.41. Sort Type Dialog
4.42. Copying from grid to other editors
4.43. Copying XML data into grid
4.44. Copying tab separated values into grid
4.45. Default left to right text orientation
4.46. Right to left text orientation
4.47. Content Completion list over a document with no schema
4.48. The New wizard
4.49. The XML Project wizard - step 1
4.50. The XML Project wizard - step 2
4.51. Convert a schema to other schema language
4.52. Convert a schema to other schema language - advanced options
4.53. Rename Prefix Dialog
4.54. Example of coloring XML tags by prefix
4.55. Schematron support in XML Schema content completion
4.56. XML Schema editor - full model view
4.57. Edit attributes of current XML Schema element
4.58. Logical Model View for XML Schema
4.59. Schema components view for XML Schema
4.60. The Generate Sample XML Files dialog
4.61. The Generate Sample XML Files dialog
4.62. XML Schema regular expressions builder dialog
4.63. The XML Schema documentation dialog
4.64. Relax NG schema editor - full model view
4.65. Logical Model View for a Relax NG schema
4.66. Schema components view for Relax NG
4.67. NVDL schema editor - full model view
4.68. Schema components view for NVDL
4.69. External validation toolbar
4.70. Namespace prefixes in the content completion window
4.71. Content Completion in the match attribute
4.72. Content Completion in the select attribute
4.73. Content Completion in the test attribute
4.74. Content Completion in the test attribute
4.75. Content Completion in attribute value templates
4.76. XPath Tooltip Helper - Identify the concat function first argument
4.77. XPath Tooltip Helper - Identify the abs function argument
4.78. XPath Tooltip Helper - Identify the concat function second argument
4.79. XSLT input view
4.80. XSLT Input drag and drop popup menu
4.81. XSLT Input drag and drop result
4.82. XQuery input view
4.83. XQuery Input drag and drop popup menu
4.84. XQuery Input drag and drop result
4.85. The Stylesheet Templates View
4.86. Folding in XQuery documents
4.87. The XQuery Documentation dialog
4.88. Content Completion in CSS stylesheets
4.89. 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. XPath results highlighted in editor panel with character precision
6.3. XPath results highlighted in the Grid Editor
6.4. XQuery Content Completion
6.5. 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. Data Source Drivers Configuration Dialog
9.2. The Connection Configuration Dialog
9.3. Database Explorer View
9.4. Register Dialog
9.5. Register Dialog
9.6. Register Dialog
9.7. The Table Explorer View
9.8. Cell containing an invalid value.
9.9. Duplicate entry for primary key
9.10. SQL statement editing with DND
9.11. New SQL scenario dialog
9.12. Data Source Drivers Configuration Dialog
9.13. The Connection Configuration Dialog
9.14. The Connection Configuration Dialog
9.15. The Connection Configuration Dialog
9.16. The Connection Configuration Dialog
9.17. The Connection Configuration Dialog
9.18. The Configure Connection Dialog
9.19. The Database Explorer View
9.20. Browsing the Oracle XML DB Repository
9.21. Add Container Dialog
9.22. Container indices
9.23. Adding/editing indices
9.24. Parser configuration
10.1. The Import wizards of <oXygen/> plugin
10.2. Import from Database data Wizard
10.3. Import from Database Criteria Dialog
10.4. Select database table Dialog
10.5. Select Excel Sheet
10.6. Import HTML file - step 1
10.7. Import HTML - step 2
10.8. Select text file Dialog
10.9. Import Text Criteria Dialog
10.10. Presentation Names
11.1. Content completion for WSDL documents
11.2. Validating a WSDL file
11.3. WSDL SOAP Analyser
11.4. WSDL File Opener
11.5. UDDI Registry Browser dialog
11.6. WSDL Documentation dialog
12.1. Canonicalization settings dialog
12.2. Signature settings dialog
12.3. Verifying signature dialog
13.1. Eclipse Preferences dialog - restricted version
13.2. The Global preferences panel
13.3. <oXygen/> XML Editor License dialog
13.4. The Editor preferences panel
13.5. The Grid editor preferences panel
13.6. The Format preferences panel
13.7. The XML format preferences panel
13.8. The CSS format preferences panel
13.9. The Javascript format preferences panel
13.10. The Content Completion Features preferences panel
13.11. The Content Completion XSL/XPath preferences panel
13.12. The Colors preferences panel
13.13. The Elements by Prefix preferences panel
13.14. The Save preferences panel
13.15. The Code Templates preferences panel
13.16. Schema diagram preferences panel
13.17. Spell check preferences panel
13.18. Document checking preferences panel
13.19. The Default Schema Association preferences panel
13.20. The Schema mapping dialog
13.21. Custom validation preferences panel
13.22. CSS Validator preferences panel
13.23. The XML Catalog preferences panel
13.24. The XML Parser preferences panel
13.25. The XML Instances Generator preferences panel
13.26. The XSLT/FO/XQuery preferences panel
13.27. The XSLT preferences panel
13.28. The Saxon 6 XSLT preferences panel
13.29. The Saxon 8 XSLT preferences panel
13.30. The Saxon 8 XSLT Advanced preferences panel
13.31. The XSLTProc preferences panel
13.32. The MSXML preferences panel
13.33. The MSXML.NET preferences panel
13.34. The XQuery preferences panel
13.35. The Saxon XQuery preferences panel
13.36. The Saxon 8 XQuery Advanced preferences panel
13.37. The Debugger preferences panel
13.38. The Profiler preferences panel
13.39. The FO Processors preferences panel
13.40. The external FO processor configuration dialog
13.41. The XPath preferences panel
13.42. Configuration of custom transformation engines
13.43. Parameters of a custom transformation engine
13.44. The XML import preferences panel
13.45. The Data Sources preferences panel
13.46. The Data Sources Drivers dialog
13.47. The Connections preferences panel
13.48. The Connection dialog
13.49. Table Filters Preferences Page
13.50. The Proxy Configuration preferences panel
13.51. The FTP / SFTP Configuration preferences panel
13.52. The Certificates preferences panel
13.53. The Scenarios Management preferences panel
13.54. The Outline preferences panel
13.55. The View 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
13.1. Pattern letters

List of Examples

2.1. Example of Eclipse start command
4.1. Document which is not Well-Formed XML
4.2. Document which is not namespace-well-formed
4.3. Document which is not namespace-valid
4.4. Validation error messages
4.5. The XSL code template called Template-Match-Mode
6.1. XPath Utilization with DocBook DTD