<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
Unattended installation
Setting a parameter in the startup script
Starting the application
Obtaining and registering a license key
Named User license registration
How floating (concurrent) licenses work
How to install the <oXygen/> license server as a Windows service
How to release a floating license
License registration with a registration code
Unregistering the license key
Upgrading the <oXygen/> application
Checking for new versions
Uninstalling the application
Unattended uninstall
Performance problems
Large documents
External processes
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
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
The Elements view
The Entities View
Validating XML documents
Checking XML well-formedness
Validating XML documents against a schema
Marking Validation Errors
Validation Example
Caching the Schema Used for Validation
Validate As You Type
Custom validation of XML documents
Linked output messages of an external engine
Validation Scenario
Validation Actions in the User Interface
References to XML Schema specification
Resolving references to remote schemas with an XML Catalog
Document navigation
Quick document browsing using bookmarks
Folding of the XML elements
Outline View
XML Document Overview
Outliner filters
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
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 DITA Maps
Advanced operations
Inserting a Topic Reference
Inserting a Topic Heading
Inserting a Topic Group
Edit properties
Transforming DITA Maps
Available Output Formats
Configuring a DITA transformation
Customizing the DITA scenario
The Parameters tab
The Filters tab
The Advanced tab
The Output tab
The FO Processor tab
Running a DITA Map ANT transformation
DITA OT customization support
Support for transformation customizations
Using your own DITA OT toolkit from <oXygen/>
Using your custom build file
Customizing the <oXygen/> Ant tool
Upgrading to a new version of DITA OT
Increasing the memory for the Ant process
Resolving topic references through an XML catalog
DITA specializations support
Support for editing DITA Map specializations
Support for editing DITA Topic specializations
Editing XML Schema schemas
Special content completion features
XML Schema diagram
Introduction
Full model view
The symbols used in the schema diagram
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
The symbols used in the schema diagram
Logical model view
Actions available in the diagram view
Schema components view
Relax NG editor specific actions
Search References and Declarations
Editing NVDL schemas
NVDL schema diagram
Introduction
Full model view
Actions available in the diagram 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
CSS Outline View
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. Authoring in the tagless editor
Authoring XML documents without the XML tags
The Content Author role
Author views
Outline view
XML Document Overview
Modification Follow-up
Document Structure Change
The popup menu of the Outline tree
Elements view
Attributes view
Entities view
The Author editor
Navigating the document content
Displaying the markup
Bookmarks
Position information tooltip
Displaying referred content
Finding and replacing text
Contextual menu
Editing XML in oXygen Author
Editing the XML markup
Editing the XML content
Refreshing the content
Validation and error presenting
Whitespace handling
6. Predefined document types
The DocBook V4 document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The DocBook V5 document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The DITA Topics document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The DITA MAP document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The XHTML document type
Association rules
Schema
CSS
Author extensions
Templates
Catalogs
Transformation Scenarios
The TEI P4 document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The TEI P5 document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The MathML document type
Association rules
Schema
Templates
The Microsoft Office OOXML document type
Association rules
Schema
Templates
The Open Office ODF document type
Association rules
Schema
Templates
The OASIS XML Catalog document type
Association rules
Schema
Templates
7. oXygen XML Editor Developer Guide
Introduction
Simple Customization Tutorial
XML Schema
Writing the CSS
The XML Instance Template
Advanced Customization Tutorial - Document Type Associations
Creating the Basic Association
First step. XML Schema.
Second step. The CSS.
Defining the General Layout.
Styling the section Element.
Styling the table Element.
Styling the Inline Elements.
Styling Elements from other Namespace
Styling images
Marking elements as foldable
Marking elements as links
Third Step. The Association.
Organizing the Framework Files
Association Rules
Java API: Rules implemented in Java
Schema Settings
Author CSS Settings
Testing the Document Type Association
Packaging and Deploying
Author Settings
Configuring Actions, Menus and Toolbars
The Insert Section Action
The Insert Table Action
Configuring the Toolbar
Configuring the Main Menu
Configuring the Contextual Menu
Author Default Operations
The arguments of InsertFragmentOperation
The arguments of SurroundWithFragmentOperation
Java API - Extending Author Functionality through Java
Example 1. Step by Step Example. Simple Use of a Dialog from an Author Operation.
Example 2. Operations with Arguments. Report from Database Operation.
Configuring a Table Cell Span Provider
Configuring a References Resolver
Configuring New File Templates
Configuring XML Catalogs
Configuring Transformation Scenarios
Configuring Extensions
Configuring a Link target reference finder
The DefaultElementLocatorProvider implementation
The XPointerElementLocator implementation
The IDElementLocator implementation
Creating a customized link target reference finder
CSS support in oXygen Author
CSS 2.1 features
Supported selectors
Unsupported selectors
Properties Support Table
oXygen CSS Extensions
Media Type oxygen
Supported Features from CSS Level 3
Namespace Selectors
The attr() function: Properties Values Collected from the Edited Document.
Additional Custom Selectors
Additional Properties
Folding elements: foldable and not-foldable-child properties
Link elements
oXygen Custom CSS functions
The local-name() function
The name() function
The url() function
The base-uri() function
The parent-url() function
The capitalize() function
The concat() function
The replace() function
The unparsed-entity-uri() function
Example Files Listings
The Simple Documentation Framework Files
XML Schema files
sdf.xsd
abs.xsd
CSS Files
sdf.css
XML Files
sdf_sample.xml
XSL Files
sdf.xsl
Java Files
InsertImageOperation.java
QueryDatabaseOperation.java
TableCellSpanProvider.java
ReferencesResolver.java
CustomRule.java
DefaultElementLocatorProvider.java
XPointerElementLocator.java
IDElementLocator.java
8. Grid Editor
Introduction
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
9. Transforming documents
Output formats
Transformation scenario
Built-in transformation scenarios
Defining a new transformation scenario
XSLT Stylesheet Parameters
Additional XSLT Stylesheets
XSLT/XQuery Extensions
Creating a Transformation Scenario
Sharing the Transformation Scenarios. Project Level Scenarios.
Scenarios view
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
10. 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 Outline View
XQuery Validation
Other XQuery editing actions
Transforming XML Documents Using XQuery
11. 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
12. Profiling XSLT stylesheets and XQuery documents
Overview
Viewing profiling information
Invocation tree view
Hotspots View
Working with XSLT/XQuery profiler
13. 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
14. Working with Archives
Using files directly from archives
Browsing and modifying archives' structure
Editing files from archives
15. 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 11g 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 11g 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
WebDAV Connection
How to Configure a WebDAV Connection
WebDAV connection actions
Actions available at connection level
Actions available at folder level
Actions available at file level
16. 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
17. Composing Web Service calls
Overview
Composing a SOAP request
Testing remote WSDL files
The UDDI Registry browser
Generate WSDL documentation
18. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
19. 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
Depth
Revision
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
Locked items
Locking a file
Unlocking a file
Synchronize with the repository
Presentation modes
View differences
Resolve conflicts
Real conflicts vs mergeable conflicts
Content conflicts vs Property conflicts
Edit real content 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 in the popup menu displayed by a right click in the view when a single resource is selected:
History actions available on the popup menu for double selection:
Directory Change Set View
Management of SVN properties
Add / Edit / Remove SVN properties
Creation and management of Branches/Tags
Create a Branch/Tag
Merging
Merge revisions
Reintegrate a branch
Merge two different trees
Merge Options
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
Sparse checkouts
Repository View
General description
Toolbar
Contextual menu actions
Working Copy View
General description
Toolbar
Contextual menu actions
Drag and drop operations
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
The History filter dialog
The History filter field
Features
Annotations View
Description
Properties View
Description
Toolbar / Contextual menu
Console View
Description
Help View
Description
The Revision Graph of a SVN Resource
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
20. How to develop an <oXygen/> plugin
Introduction
Requirements
Implementing plugins
General plugins
Selection plugins
Document plugins
Custom protocol plugins
Resource locking custom protocol plugins
Example - UppercasePlugin
Example - a custom protocol plugin
Installing the plugin
21. 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 Find All Elements 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 the file at caret in system application
Opening the file at caret position
Switching between open tabs
Printing a file
Exiting the application
22. Configuring the application
Importing/Exporting Global Options
Preferences
Global
Fonts
Document Type Association
Perspectives Layout
Encoding
Editor
Text
Author
Grid
Format
XML
Whitespaces
CSS
JavaScript
Content Completion
Annotations
XSL
XPath
XSD
Colors
Syntax Highlight / Elements by Prefix
Open/Save
Code Templates
Document Templates
Diagram
Spell Check
Document Checking
Custom Validation
CSS Validator
XML
XML Catalog
XML Parser
XML Instances Generator
XSLT/FO/XQuery
XSLT
Saxon6
Saxon-B/SA
Saxon-B/SA Advanced options
XSLTProc
MSXML
MSXML.NET
XQuery
Saxon-B/SA
Saxon-B/SA Advanced options
Debugger
Profiler
FO Processors
XPath
Custom Engines
Import
Date/Time format
Date/Time Patterns
Intel® XML Software Suite
Data Sources
Configuration of Data Sources
Download links for database drivers
Table Filters
Diff
Diff Appearance
Archive
Plugins
External Tools
Menu Shortcut Keys
File Types
HTTP(S) / (S)FTP / Proxy Configuration
Advanced HTTP Settings
(S)FTP
Certificates
Outline
View
Messages
Tree Editor
SVN
Sharing Preferences
Automatically importing the preferences from the other distribution
Reset Global Options
Scenarios Management
Editor variables
23. Common problems
A. Appendix
Accelerator Shortcut Keys
The Main Editor
The Tree View Editor
Unicode Character Encoding
References