<oXygen/> XML Editor User Guide

<oXygen/> User Manual

SyncRO Soft Ltd.

Sean Wheller

Legal Notice

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/>
Obtaining and Installing an <oXygen/> License
Upgrading <oXygen/>
Checking for new versions
Uninstalling <oXygen/>
Performance problems
Large documents
Display problems on Linux/Solaris
3. Getting started
Supported types of documents
Getting help
Perspectives
Editor perspective
Debugger perspective
Tree Editor perspective
4. Editing documents
Working with Unicode
Opening and closing documents
Creating new documents
Saving documents
Opening existing documents
Opening and Saving Remote Documents via FTP/WebDAV
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
Editing XML tree nodes
Formatting and Indenting Documents (Pretty Print)
Making a persistent copy of results
Locking and unlocking XML markup
Adjusting the transparency of XML markup
Schema diagram
Introduction
XML Schema diagram
Relax NG schema diagram
SVG documents
The Standalone SVG Viewer.
The Preview Result Pane.
Integrating external tools
Integrating the Ant tool
XML editor specific actions
Select actions
Source actions
XML document actions
XML Refactoring actions
Text editor specific actions
Undoing and redoing user actions
Copying and pasting text
Finding and replacing text in the current file
Finding and replacing text in multiple files
Using Check Spelling
Printing a file
Inserting a file at caret position
Opening edited file in system application
Opening the file at caret position
Exiting the <oXygen/> XML Editor
5. Transforming documents
Output formats
Transformation scenario
Builtin 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. Comparing and merging documents
Directories Comparison
The directories comparison user interface
The comparison result
File Comparison
The Main Menu
Compare Toolbar
Files Selector
File contents panel
Word Level Comparison
Character Level Comparison
10. Importing data
Introduction
Import from text files
Import from MS Excel files
Import from Database Data
Import from HTML files
11. Composing Web Service calls
Overview
Composing a SOAP request
12. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
13. Configuring the editor
Preferences
Global
Editor
XML Catalog
XML Parser Options
XSLT Options
Debugger Settings
Profiler Settings
FO processors
XPath
XQuery
Database
Diff
Plugins
External Tools
Menu shortcut keys
File Types
Proxy Configuration
Certificates
Results / Output
Print
Tree editor
Colors
Automatically importing the preferences from the other distribution
Importing/Exporting <oXygen/> preferences
Reset options
14. Common problems
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. Editor perspective
3.2. Debugger perspective
3.3. Tree Editor perspective
4.1. Available Java Encodings Dialog
4.2. The New dialog
4.3. The Create an XML Document Dialog - XML Schema Tab
4.4. The Create an XML Document Dialog - DTD Tab
4.5. The Create an XML Document Dialog - Relax NG Tab
4.6. The Create an XML Document Dialog - NRL Tab
4.7. The Templates dialog
4.8. The Templates dialog
4.9. The Templates dialog
4.10. The Templates dialog
4.11. Open URL dialog
4.12. The server certificate is not available
4.13. Security alert - untrusted certificate
4.14. Tag-Insight driven by a Docbook DTD
4.15. Associate schema dialog
4.16. Tag-Insight Assistant
4.17. Schema annotations displayed at Tag Insight
4.18. The Model View
4.19. The Element Structure View.
4.20. The Annotation View
4.21. The Attributes View
4.22. The External validation dialog
4.23. Link to specification for XML Schema errors
4.24. Editor Bookmarks
4.25. Folding of the XML Elements
4.26. The Outliner Panel
4.27. Go to
4.28. Tag-Insight list over a document with no schema
4.29. Project Panel
4.30. Convert an edited schema
4.31. The XML Schema documentation dialog
4.32. XML Schema editor - diagram and source
4.33. Logical Model View for XML Schema
4.34. Full Model View
4.35. Logical Model View
4.36. SVG Tag Insight
4.37. SVG Viewer
4.38. Integrated SVG Viewer
4.39. Find/Replace Dialog
4.40. Search/Replace in Files
4.41. Check Spelling Dialog
4.42. Options Dialog
5.1. The Configure Transformation Dialog
5.2. Edit cascade 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 Messages view
7.7. The Stack view
7.8. The Trace History View
7.9. The Templates view
7.10. The Node Set view
7.11. The Variables view
7.12. Output to Source Mapping
7.13. XHTML Output Mapping
8.1. Invocation tree view
8.2. Hotspots view
8.3. Source backmapping
9.1. The Compare directories window
9.2. The Operations Menu
9.3. The Compare toolbar
9.4. File filter
9.5. The Directories Selector
9.6. Comparison result
9.7. The Compare Files Window
9.8. The Compare Toolbar
9.9. Files contents panel
9.10. Word Level Comparison
9.11. Character Level Comparison
10.1. Select text file Dialog
10.2. Import Text Criteria Dialog
10.3. Presentation Names
10.4. Select Excel Sheet
10.5. Select database table Dialog
10.6. Import from Database Criteria Dialog
10.7. The Import HTML dialog
11.1. Content completion for WSDL documents
11.2. Validating a WSDL file
11.3. WSDL SOAP Analyser
11.4. WSDL File Opener
12.1. Canonicalization settings dialog
12.2. Signature settings dialog
12.3. Verifying signature dialog
13.1. The Global preferences
13.2. The Aspect pane
13.3. The Format pane
13.4. The Save pane
13.5. The Code templates pane
13.6. The Performance pane
13.7. The Tag Insight Features pane
13.8. The Tag Insight Default pane
13.9. Schema mapping dialog
13.10. The Tag Insight XSL pane
13.11. Schema diagram configuration panel
13.12. The XML Catalog pane
13.13. The XML Parser Options pane
13.14. XSLT options
13.15. Debugger Settings
13.16. Profiler Settings
13.17. The FO processors pane
13.18. Configure the external processors
13.19. The XPath pane
13.20. XQuery pane
13.21. Database import configuration panel
13.22. JDBC Drivers pane
13.23. The JDBC Drivers dialog
13.24. The Diff pane
13.25. The Plugins pane
13.26. Configure External Tools
13.27. The Menu shortcut keys pane
13.28. The File Types
13.29. The Proxy Configuration Dialog
13.30. Certificates
13.31. The Results/Output option
13.32. The Printing Scale option
13.33. Tree editor options
13.34. The Colors pane

List of Tables

7.1. Context node details
7.2. XWatch details
7.3. Breakpoints details
7.4. Messages details
7.5. Stack details
7.6. Trace History details
7.7. Templates details
7.8. Node set details
7.9. Variables details
A.1. Unicode to Java Name Matrix

List of Examples

2.1. Example of java command line in startup script (Windows)
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