<oXygen/> XML Editor 11.2 User Manual

SyncRO Soft Ltd.

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
Associating a schema with the namespace of the root element
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
Sharing the Validation Scenarios. Project Level Scenarios
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 XML Schemas
XML Schema Text Editor
Special content completion features
References to XML Schema specification
XML Schema actions
XML Schema editor specific actions
Flatten an XML Schema
XML Schema Diagram Editor
Introduction
Navigation in the schema diagram
Schema validation
Schema editing actions
The Schema Outline View
The Attributes view
The Facets view
Editing patterns
Edit Schema Namespaces
Schema Components
xs:schema
xs:element
xs:attribute
xs:complexType
xs:simpleType
xs:group
xs:attributeGroup
xs:include
xs:import
xs:redefine
xs:notation
xs:sequence, xs:choice, xs:all
xs:any
xs:anyAttribute
xs:unique
xs:key
xs:keyRef
xs:selector
xs:field
Constructs used to group schema components
Attributes
Constraints
Substitutions
Create an XML Schema from a relational database table
XML Schema Instance Generator
Running the XML instance generator from command line
XML Schema regular expressions builder
Generating documentation for an XML Schema
Generate documentation in HTML format
Generate documentation in PDF, DocBook or a custom format
Generating documentation from the command line
Searching and refactoring actions
Resource Hierarchy/Dependencies View
Component Dependencies View
Linking between development and authoring
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
Relax NG Outline view
Relax NG editor specific actions
Searching and refactoring actions
Resource Hierarchy/Dependencies View
Component Dependencies View
Configuring a custom datatype library for a RELAX NG Schema
Linking between development and authoring
Editing NVDL schemas
NVDL schema diagram
Introduction
Full model view
Actions available in the diagram view
NVDL Outline view
NVDL editor specific actions
Searching and refactoring actions
Component Dependencies View
Linking between development and authoring
Editing XSLT stylesheets
Validating XSLT stylesheets
Custom validation of XSLT stylesheets
Associate a validation scenario
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 XSLT Outline View
XSLT Stylesheet documentation support
Generating documentation for an XSLT Stylesheet
Generate documentation in HTML format
Generate documentation in a custom format
Generating documentation from the command line
Finding XSLT references and declarations
XSLT refactoring actions
Resource Hierarchy/Dependencies View
Component Dependencies View
Linking between development and authoring
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
Editing XProc Scripts
SVG documents
The Standalone SVG Viewer.
The Preview Result Pane.
Integrating external tools
Integrating the Ant tool
Editing very large documents
Insuficient memory
Editing documents with long lines
Large file viewer
Hex Viewer
Scratch Buffer
Changing the user interface language
Handling read-only files
5. Authoring in the tagless editor
Authoring XML documents without the XML tags
General Author Presentation
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
Table layout and resizing
DocBook
XHTML
DITA
Editing MathML notations
Refreshing the content
Validation and error presenting
Whitespace handling
Minimize differences between versions saved on different computers
Change Tracking
Managing changes
6. Author for DITA
Creating DITA maps and topics
Editing DITA Maps
Creating a map
Create a topic and add it to a map
Organize topics in a map
Create a bookmap
Create relationships between topics
Create an index entry
Editing actions
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
Set a font for PDF output generated with Apache FOP
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
Integration of a DITA specialization
Editing DITA Map specializations
Editing DITA Topic specializations
Use a new DITA Open Toolkit in <oXygen/>
Reusing content
Working with content references
Reusable component
Insert a direct content reference
7. 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 DocBook Targetset document type
Association rules
Schema
Author extensions
Templates
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
The XML Schema document type
Association rules
Author extensions
The RelaxNG document type
Association rules
Author extensions
The NVDL document type
Association rules
Author extensions
The Schematron document type
Association rules
Author extensions
The Schematron 1.5 document type
Association rules
Author extensions
The XSLT document type
Association rules
Author extensions
The XMLSpec document type
Association rules
Schema
Author extensions
Templates
Catalogs
Transformation Scenarios
The FO document type
Association rules
Schema
Author extensions
Transformation Scenarios
The EAD document type
Association rules
Schema
Author extensions
Templates
Catalogs
8. Author 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
Deciding the initial page
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 Toolbars
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 New File Templates
Configuring XML Catalogs
Configuring Transformation Scenarios
Configuring Extensions
Configuring an Extensions Bundle
Implementing an Author Extension State Listener
Implementing an Author Schema Aware Editing Handler
Configuring a Content completion handler
Configuring a Link target element finder
The DefaultElementLocatorProvider implementation
The XPointerElementLocator implementation
The IDElementLocator implementation
Creating a customized link target reference finder
Configuring a custom Drag and Drop listener
Configuring a References Resolver
Configuring CSS Styles Filter
Configuring a Table Column Width Provider
Configuring a Table Cell Span Provider
Configuring an Unique Attributes Recognizer
Customizing the default CSS of a document type
Document type sharing
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
Display Tag Markers
<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 uppercase() function
The lowercase() function
The concat() function
The replace() function
The unparsed-entity-uri() function
The attributes() 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
SDFExtensionsBundle.java
SDFSchemaManagerFilter.java
SDFSchemaAwareEditingHandler.java
TableCellSpanProvider.java
TableColumnWidthProvider.java
ReferencesResolver.java
CustomRule.java
DefaultElementLocatorProvider.java
XPointerElementLocator.java
IDElementLocator.java
9. 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 in a table
Inserting a column in 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
10. Transforming documents
XSLT Transformations
Output formats
Transformation scenario
Batch transformation
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.
Transformation Scenarios view
XSL-FO processors
Add a font to the built-in FOP
Locate font
Generate font metrics file
Register font to FOP configuration
Set FOP configuration file in Oxygen
Add new font to FO output
DocBook Stylesheets
TEI Stylesheets
DITA-OT Stylesheets
Common transformations
PDF Output
PS Output
TXT Output
HTML Output
HTML Help Output
Java Help Output
XHTML Output
Supported XSLT processors
Configuring custom XSLT processors
Configuring the XSLT processor extensions paths
XProc Transformations
XProc transformation scenario
Integration of an external XProc engine - the XProc API
11. 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
The Query Input View
XQuery Validation
Other XQuery editing actions
Transforming XML Documents Using XQuery
XQJ transformer support
How to configure an XQJ Data source
How to Configure an XQJ Connection
Display result in Sequence view
Advanced Saxon HE/PE/EE transform options
Updating XML documents using XQuery
12. 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
13. Profiling XSLT stylesheets and XQuery documents
Overview
Viewing profiling information
Invocation tree view
Hotspots View
Working with XSLT/XQuery profiler
14. Comparing and merging documents
Directories Comparison
The directories comparison user interface
The Operations Menu
Compare Toolbar
Directories Selector
The comparison result
Compare images
Files Comparison
The Main Menu
Edit Menu
Find Menu
Source Menu
The Target Menu
Operations Menu
Option Menu
Help Menu
Compare Toolbar
Files Selector
File contents panel
Word Level Comparison
Character Level Comparison
15. Working with Archives
Using files directly from archives
Browsing and modifying archives' structure
Editing files from archives
16. 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
How to configure a PostgreSQL 8.3 Data Source
Configuring Database Connections
How to Configure an IBM DB2 Connection
How to Configure a JDBC-ODBC Connection
How to Configure a Microsoft SQL Server Connection
How to Configure a MySQL Connection
How to Configure an Oracle 11g Connection
How to Configure a PostgreSQL 8.3 Connection
Resource Management
Data Source 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 Data Source 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 a Documentum xDb (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 Documentum xDb (X-Hive/DB) Connection
Resource Management
Data Source Explorer View
Oracle XML DB Browser
Actions available at XML Repository level
Actions available at container level
Actions available at resource level
PostgreSQL connection
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
Documentum xDb (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
Documentum xDb (X-Hive/DB) parser configuration for adding XML instances
XQuery and Databases
Drag and Drop from Data Source Explorer
XQuery validation
XQuery transformation
XQuery database debugging
Debugging with MarkLogic
Debugging with Berkeley DB XML
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
17. 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
18. Content Management System (CMS) Integration
Documentum (CMS) Support
How to configure Documentum (CMS) support
How to configure a Documentum (CMS) data source
How to configure a Documentum (CMS) connection
Documentum (CMS) actions
Actions available on connection
Actions available on cabinets/folders
Actions available on resources
DITA transformations on DITA content from Documentum
19. Composing Web Service calls
Overview
Composing a SOAP request
Testing remote WSDL files
The UDDI Registry browser
Generate WSDL documentation
20. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
21. The Syncro SVN Client
Introduction
What is Syncro SVN Client
Quick start guide and reference
Main window
Starting Syncro SVN Client
Views
Main menu
Main toolbar
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
Tree conflicts
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
Resolve merge conflicts
Switch the Repository Location
Relocate a Working Copy
Create Patches
Create a patch from working copy
Include unversioned files in the patch
Create patch from repository revision
Working with repositories
Import / Export resources
Importing resources into a repository
Exporting resources from a repository
Copy / Move / Delete resources from the repository
Sparse checkouts
Repository View
General description
Toolbar
Contextual menu actions
Working Copy View
General description
Working Copy format
Refresh a Working Copy
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
The svn:externals property
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
22. How to develop an <oXygen/> plugin
Introduction
Requirements
Implementing plugins
General plugins
Selection plugins
Document plugins
Custom protocol plugins
Resource locking custom protocol plugins
Components Validation plugins
Workspace access plugin
Open redirect plugin
Example - UppercasePlugin
Example - a custom protocol plugin
Installing the plugin
23. 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/Attributes dialog
The Quick Find toolbar
Keyboard shortcuts for finding the next and previous match
Finding and replacing text in multiple files
Using Check Spelling
Adding a spell dictionary
Adding a Hunspell dictionary
Adding an AZ Check dictionary
Learning words
Ignoring words
Spell checking as you type
Check Spelling in Files
Changing the font size
VI editor actions
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 opened tabs
Printing a file
Exiting the application
24. Configuring the application
Importing/Exporting Global Options
Preferences
Global
Fonts
Document Type Association
Perspectives Layout
Encoding
Editor
Pages
Text
Text/Diagram
Grid
Author
Schema aware
Track Changes
MathML
Messages
Schema Design
Properties
Format
XML
Whitespaces
CSS
JavaScript
Content Completion
Annotations
XSL
XPath
XSD
Colors
Syntax Highlight / Elements/Attributes by Prefix
Open/Save
Code Templates
Document Templates
Spell Check
Document Checking
Custom Validation
CSS Validator
XML
XML Catalog
XML Parser
Saxon EE Validation
XML Instances Generator
XProc Engines
XSLT/FO/XQuery
XSLT
Saxon6
Saxon HE/PE/EE
Saxon HE/PE/EE Advanced options
XSLTProc
MSXML
MSXML.NET
XQuery
Saxon HE/PE/EE
Saxon HE/PE/EE 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
SVN
Working Copy
SVN Diff
Diff
Diff Appearance
Archive
Plugins
External Tools
Menu Shortcut Keys
File Types
SVN File Editors
Custom Editor Variables
HTTP(S) / (S)FTP / Proxy Configuration
Advanced HTTP Settings
(S)FTP
Certificates
XML Structure Outline
View
Messages
SVN Messages
Tree Editor
Sharing Preferences
Automatically importing the preferences from the other distribution
Reset Global Options
Scenarios Management
Editor variables
Custom editor variables
Configure toolbars
25. Common problems
Index