<oXygen/> XML Editor User Manual

SyncRO Soft Ltd.

Contributor: 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
Operating System
Tools
Environment Prerequisites
Installation Instructions
Starting the application
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
Checking for new versions
Uninstalling the application
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
Database 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/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
References to XML Schema specification
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
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
Using the Project view
Team Collaboration - Subversion
Project Level Settings
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
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
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
SVG documents
The Standalone SVG Viewer.
The Preview Result Pane.
Integrating external tools
Integrating the Ant tool
Large File Viewer
Scratch Buffer
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
Sharing the Transformation Scenarios. Project Level 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 console
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
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. 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
11. 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
12. Composing Web Service calls
Overview
Composing a SOAP request
Testing remote WSDL files
The UDDI Registry browser
Generate WSDL documentation
13. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
14. The Syncro SVN Client
Introduction
What is Syncro SVN Client
Quick start guide and reference
Main window
Starting Syncro SVN 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
Integration with Bug Tracking Tools
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
Switch the Repository Location
Relocate a Working Copy
Create Patches
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
Compare images view
Editor
Description
Image preview
Description
History View
Description
History Filters
Features
Annotations View
Description
Properties View
Description
Toolbar / Contextual menu
Console View
Description
Help View
Description
Syncro 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
15. 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
16. 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
Inserting a file at caret position
Opening edited file in system application
Opening the file at caret position
Switching between open tabs
Printing a file
Exiting the application
17. Configuring the application
Importing/Exporting Global Options
Preferences
Global
Fonts
Perspectives Layout
Editor
Grid
Format
XML Format
CSS Format
Javascript Format
Content Completion
XSL/XPath
Colors
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
Diff
Diff appearance
Plugins
External Tools
Menu Shortcut Keys
File Types
HTTP / FTP / SFTP / Proxy Configuration
HTTP / FTP / SFTP / Proxy Configuration/ FTP / SFTP
Certificates
Outline
View
Print
Messages
Tree editor
SVN
Sharing Preferences
Automatically importing the preferences from the other distribution
Reset Global Options
Scenarios Management
18. Common problems
A. Appendix
Accelerator Shortcut Keys
The Main Editor
The Tree View Editor
Unicode Character Encoding
References