<oXygen/> User Manual
SyncRO Soft Ltd.
Contributor: Sean
Wheller
Copyright © 2002-2006 SyncRO Soft Ltd. All Rights Reserved.
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
Operating System
Tools
Environment Prerequisites
Installation Instructions
Starting <oXygen/>
Obtaining and installing an <oXygen/> license
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
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
XSLT Debugger Perspective
XQuery Debugger Perspective
Tree Editor perspective
Dockable views and editors
4. Editing documents
Working with Unicode
Opening and saving Unicode documents
The Unicode toolbar
Opening and closing documents
Creating new documents
The New dialog
Creating Documents based on Templates
Saving documents
Opening existing documents
Opening and Saving Remote Documents via FTP/WebDAV
Changing file permissions on a remote FTP server
WebDAV over HTTPS
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
Debugging XML documents
Checking XML Form
Validating Documents
Validate as you type
References to XML Schema specification
Custom validation of XML documents
Document navigation
Quick document browsing using bookmarks
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
Navigation buttons
Using the Go To dialog
Grouping documents in XML projects
Large Documents
Creating an included part
Using the Project view
Including document parts with XInclude
Working with XML Catalogs
Converting between schema languages
Editing XML tree nodes
Formatting and indenting documents (pretty print)
Viewing status information
Image preview
Making a persistent copy of results
Locking and unlocking XML markup
Adjusting the transparency of XML markup
XML editor specific actions
Split actions
Edit actions
Select actions
Source actions
XML document actions
XML Refactoring actions
XML Schema 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
References to XML Schema specification
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
Introduction
Full model view
Logical model view
Schema components view
Relax NG 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
Code templates
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
SVG documents
The Standalone SVG Viewer.
The Preview Result Pane.
Integrating external tools
Integrating the Ant tool
Scratch Buffer
Text editor specific actions
Undoing and redoing user actions
Copying and pasting text
Finding and replacing text in the current file
The Find/Replace dialog
The Quick Find toolbar
Keyboard shortcuts for finding the next and previous match
Finding and replacing text in multiple files
Using Check Spelling
Changing the font size
Dragging and dropping the selected text
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
Built-in transformation scenarios
Defining a new transformation scenario
XSLT Stylesheet Parameters
Additional XSLT Stylesheets
Scenario Macros
XSLT/XQuery Extensions
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
The XPath Builder view
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
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. Comparing and merging documents
Directories Comparison
The directories comparison user interface
The Operations Menu
Compare Toolbar
File Filter options
Directories Selector
The comparison result
File Comparison
The Main Menu
The Source Menu
The Target Menu
Operations Menu
Compare Toolbar
Files Selector
File contents panel
Word Level Comparison
Character Level Comparison
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. The <oXygen/> SVN Client
Introduction
What is <oXygen/> SVN Client
Quick start guide and reference
Main window
Starting <oXygen/> Subversion client
Views
Main menu
Getting started
Define a repository location
Add / Edit / Remove repository locations
Authentication
Defining a working copy
Check out a working copy
Use an existing working copy
Manage working copy resources
Edit files
Add resources to version control
Ignore resources not under version control
Delete resources
Copy / Move / Rename resources
Lock / Unlock resources
Scanning for locks
Locking a file
Unlocking a file
Synchronize with the repository
View differences
Resolve conflicts
Real conflicts vs Pseudo conflicts
Content conflicts vs Property conflicts
Revert your changes
Merge conflicted resources
Drop incoming modifications
Update the working copy
Send your changes to the repository
Obtain information for a resource
Request status information for a resource
Request history for a resource
Using the resource history view
History actions available for single selection
History actions available for double selection
Management of SVN properties
Add / Edit / Remove SVN properties
Creation and management of Branches/Tags
Create a Branch/Tag
Merge branches
Working with repositories
Import / Export resources
Import resources into the repository
Export resources from the repository
Copy / Move / Delete resources from the repository
Repository view
General description
Toolbar
Contextual menu actions
Working copy view
General description
Toolbar
Contextual menu actions
Icons
Synchronize View
General description
Synchronize trees
Toolbar
Contextual menu actions
Icons
Compare view
Description
Toolbar
Editor
Description
History view
Description
Features
Properties view
Description
Toolbar / Contextual menu
Console view
Description
Help view
Description
SVN Client Preferences
Command line interface cross reference
Actions commands reference
Checkout
Update
Commit
Diff
Show History
Refresh
Synchronize
Import
Export
Information
Add
Add to svn:ignore
Delete
Copy
Move / Rename
Mark resolved
Revert
Cleanup
Show / Refresh Properties
Branch / Tag
Merge
Scan for locks
Lock
Unlock
Mark as merged
Override and update
Override and commit
Add / Edit property
Remove property
Revert changes from this revision
Revert changes from these revisions
14. How to develop an <oXygen/> plugin
Introduction
Requirements
Implementing plugins
General plugins
Selection plugins
Document plugins
Custom protocol plugins
Example -
UppercasePlugin
Example - a custom protocol plugin
Installing the plugin
15. Configuring the editor
Reset options
Preferences
Global
Fonts
Editor
Format
XML Format
CSS Format
Save
Code Templates
Performance
Default Schema Association
Content Completion
XSL/XPath
Diagram
Spell Check
Document Checking
Custom Validation
CSS Validator
XML
XML Catalog
XML Parser
XML Instances Generator
XSLT/FO/XQuery
XSLT
Saxon6
Saxon8
XSLTProc
MSXML
MSXML.NET
XQuery
Saxon
eXist
Berkeley DB XML
X-Hive/DB
MarkLogic
TigerLogic
Debugger
Profiler
FO Processors
XPath
Custom engines
Database
Import
Diff
Plugins
External Tools
Menu Shortcut Keys
File Types
HTTP / FTP / Proxy Configuration
Certificates
View
Print
Tree editor
SVN
Colors
Elements by Prefix
Automatically importing the preferences from the other distribution
Importing/Exporting <oXygen/> preferences
16. Common problems
A. Appendix
Accelerator Shortcut Keys
The Main Editor
The Tree View Editor
Unicode Character Encoding
References