Next
oXygen XML Author User Manual for Eclipse

oXygen XML Author User Manual for Eclipse

SyncRO Soft Ltd.

Table of Contents

1. Introduction
Key Features and Benefits
2. Installation
Installation Requirements
Platform Requirements
Operating System, Tools and Environment Requirements
Operating System
Tools
Environment Prerequisites
Installation Instructions
Starting <oXygen/> XML Author plugin
Obtaining and registering a license key
Named User license registration
How floating (concurrent) licenses work
How to install the <oXygen/> XML Author 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/> XML Author application
Uninstalling the Eclipse plugin
Performance problems
Large documents
3. Getting started
Supported types of documents
Getting help
Perspectives
<oXygen/> XML perspective
Supported editor types
<oXygen/> Database perspective
4. Editing documents
Working with Unicode
Opening and saving Unicode documents
Opening and closing documents
Creating new documents
<oXygen/> plugin wizards
Creating Documents based on Templates
Saving documents
Opening and Saving Remote Documents via FTP/SFTP
Changing file permissions on a remote FTP server
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
Correcting XML documents
Checking XML Form
Validating Documents
Marking Validation Errors
Validation Example
Caching the Schema Used for Validation
Validate As You Type
Custom validation of XML documents
Validation Scenario
Validation Actions in the User Interface
Resolving references to remote schemas with an XML Catalog
Document navigation
Folding of the XML elements
Outline View
XML Document Overview
Modification Follow-up
Document Structure Change
The popup menu of the Outline tree
Document Tag Selection
Grouping documents in XML projects
Large Documents
Creating an included part
Creating a new project
Including document parts with XInclude
Working with XML Catalogs
Formatting and indenting documents (pretty print)
Viewing status information
XML editor specific 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 specializations support
Support for editing DITA Map specializations
Support for editing DITA Topic specializations
Support for DITA OT customizations
Upgrading to a new version of DITA OT
Support for transformation customizations
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
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
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
6. 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 document-url() function
The parent-url() function
The capitalize() function
The concat() function
The replace() 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
7. 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
8. 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
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
9. Querying documents
Running XPath expressions
What is XPath
<oXygen/>'s XPath console
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
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
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
11. Digital signature
Overview
Canonicalizing files
Certificates
Signing files
Verifying the signature
12. Text editor specific actions
Finding and replacing text in the current file
The Find All Elements dialog
Changing the font size
13. Configuring the application
Importing/Exporting Global Options
Preferences
Global
Fonts
Document Type Association
Editor
Author
Grid
Format
XML
CSS
Content Completion
Annotations
XPath
Syntax Highlight
Syntax Highlight / Elements by Prefix
Open/Save
Code Templates
Document Templates
Spell Check
Document Checking
Custom Validation
CSS Validator
XML
XML Catalog
XML Parser
XSLT/FO/XQuery
XSLT
Saxon6
Saxon9
Saxon9 Advanced options
XSLTProc
MSXML
MSXML.NET
FO Processors
XPath
Custom Engines
Intel® XML Software Suite
Data Sources
Configuration of Data Sources
Download links for database drivers
Table Filters
Network Connections
Certificates
Scenarios Management
Outline
View
Automatically importing the preferences from the other distribution
Reset Global Options
Scenarios Management
Editor variables
14. Common problems

 Next
© 2008 syncRO soft ltd.