Oxygen XML Editor 16.1 Notice Copyright Oxygen XML Editor User Manual Syncro Soft SRL. Copyright © 2002-2014 Syncro Soft SRL. All Rights Reserved. All rights reserved. No parts of this work may be reproduced in any form or by any means - graphic, electronic, or mechanical, including photocopying, recording, taping, or information storage and retrieval systems - without the written permission of the publisher. Products that are referred to in this document may be either trademarks and/or registered trademarks of the respective owners. The publisher and the author make no claim to these trademarks. Trademarks. Many of the designations used by manufacturers and sellers to distinguish their products are claimed as trademarks. Where those designations appear in this document, and Syncro Soft SRL was aware of a trademark claim, the designations have been rendered in caps or initial caps. Notice. While every precaution has been taken in the preparation of this document, the publisher and the author assume no responsibility for errors or omissions, or for damages resulting from the use of information contained in this document or from the use of programs and source code that may accompany it. In no event shall the publisher and the author be liable for any loss of profit or any other commercial damage caused or alleged to have been caused directly or indirectly by this document. Link disclaimer. Syncro Soft SRL is not responsible for the contents or reliability of any linked Web sites referenced elsewhere within this documentation, and Syncro Soft SRL does not necessarily endorse the products, services, or information described or offered within them. We cannot guarantee that these links will work all the time and we have no control over the availability of the linked pages. Warranty. Syncro Soft SRL provides a limited warranty on this product. Refer to your sales agreement to establish the terms of the limited warranty. In addition, Oxygen XML Editor End User License Agreement, as well as information regarding support for this product, while under warranty, is available through the Oxygen XML Editor website. Third-party components. Certain software programs or portions thereof included in the Product may contain software distributed under third party agreements ("Third Party Components"), which may contain terms that expand or limit rights to use certain portions of the Product ("Third Party Terms"). Information identifying Third Party Components and the Third Party Terms that apply to them is available on the Oxygen XML Editor website. Downloading documents. For the most current versions of documentation, see the Oxygen XML Editor website. Contact Syncro Soft SRL. Syncro Soft SRL provides telephone numbers and e-mail addresses for you to report problems or to ask questions about your product, see the Oxygen XML Editor website. Contents Chapter 1: Introduction 21 Chapter 2: Installation 25 Installation Options 26 Windows Installation 26 Mac OS X Installation 28 Linux Installation 30 Windows NT Terminal Server Installation 31 Linux Server Installation 33 Java Web Start (JWS) Installation 34 Site-wide deployment 36 Licensing 36 Setting up a License Server 40 Transferring or Releasing a License 43 Upgrading 44 Installing and Updating Add-ons 45 Uninstalling 46 Installer Command Line Reference 46 Chapter 3: Getting Started 49 Your First XML Document 50 Your First DITA Topic 54 Chapter 4: Perspectives 61 Perspectives 62 Editor Perspective 62 XSLT Debugger Perspective 65 XQuery Debugger Perspective 65 Database Perspective 66 Dockable Views and Editors 67 Chapter 5: Editing Modes 71 Text Editing Mode 72 The Undo/Redo Actions 72 Copying and Pasting Text 72 Finding and Replacing Text in the Current File 72 Oxygen XML Editor | Contents | 5 Finding and Replacing Text in Multiple Files 76 Changing the Font Size 79 Word/Line Editor Actions 79 Dragging and Dropping the Selected Text 79 Inserting a File at Caret Position 79 Opening the File at Caret in System Application 79 Opening the File at Caret Position 79 Printing a File 80 Bidirectional Text Support in Text Mode 81 Grid Editing Mode 81 Layouts: Grid and Tree 82 Grid Move Navigation 82 Specific Grid Actions 83 Drag and Drop in the Grid Editor 84 Copy and Paste in the Grid Editor 85 Bidirectional Text Support in Grid Mode 86 Author Editing Mode 87 Tagless XML Authoring 87 General Author Presentation 88 Smart Paste Support 135 Bidirectional Text Support in Author Mode 135 Chapter 6: Editing Documents 139 Working with Unicode 140 Opening and Saving Unicode Documents 140 Inserting Symbols 141 Creating, Opening, and Closing Documents 141 Creating Documents 141 Saving Documents 145 Opening/Navigating Documents 146 Opening and Saving Remote Documents via FTP/SFTP/WebDAV/SharePoint 153 Opening the Current Document in System Application 158 Switching Between Opened Tabs 158 Closing Documents 158 The Contextual Menu of the Editor Tab 159 Viewing File Properties 159 Grouping Documents in XML Projects 159 Using the Project View 160 Defining Master Files at Project Level 165 Editing XML Documents 169 Associate a Schema to a Document 169 Streamline with Content Completion 172 Validating XML Documents 178 Document Navigation 189 Oxygen XML Editor | Contents | 6 Large Documents 193 Working with XML Catalogs 195 XML Resource Hierarchy/Dependencies View 197 Converting Between Schema Languages 199 Editing XML Tree Nodes 201 Formatting and Indenting XML Documents 201 Editing Modular XML Files in the Master Files Context 205 Managing ID/IDREFS 205 Search and Refactor Operations Scope 207 Viewing Status Information 208 Image Preview 209 Making a Persistent Copy of Results 209 Locking and Unlocking XML Markup 209 Adjusting the Transparency of XML Markup 210 XML Editor Specific Actions 210 XML Quick Fixes 215 Editing XHTML Documents 216 Editing XSLT Stylesheets 216 Validating XSLT Stylesheets 216 Editing XSLT Stylesheets in the Master Files Context 217 Syntax Highlight 217 Content Completion in XSLT Stylesheets 217 The XSLT/XQuery Input View 222 The XSLT Outline View 224 XSLT Stylesheet Documentation Support 226 Generating Documentation for an XSLT Stylesheet 227 Finding XSLT References and Declarations 233 Highlight Component Occurrences 234 XSLT Refactoring Actions 234 XSLT Resource Hierarchy/Dependencies View 235 Component Dependencies View 238 XSLT Quick Assist Support 239 XSLT Quick Fix Support 240 Linking Between Development and Authoring 242 XSLT Unit Test (XSpec) 242 Editing Ant Build Files 243 Validate Ant Build Files 243 Editing Ant Build Files in the Master Files Context 244 Syntax Highlight 244 Content Completion in Ant Build Files 244 Ant Outline View 244 Find References and Declarations of Ant Components 246 Highlight Component Occurrences 247 Ant Refactoring Actions 247 Ant Resource Hierarchy/Dependencies View 247 Oxygen XML Editor | Contents | 7 Ant Component Dependencies View 248 Ant Quick Assist Support 249 Ant Quick Fix Support 249 Editing XML Schemas 249 XML Schema Diagram Editing Mode 250 XML Schema Text Editing Mode 283 Editing XML Schema in the Master Files Context 285 Searching and Refactoring Actions 285 Component Dependencies View 287 XML Schema Quick Assist Support 288 XML Schema Resource Hierarchy / Dependencies View 289 Generating Documentation for an XML Schema 292 Flatten an XML Schema 299 Generate Sample XML Files 301 XML Schema Regular Expressions Builder 305 Create an XML Schema From a Relational Database Table 307 XML Schema 1.1 307 Setting the XML Schema Version 308 Linking Between Development and Authoring 309 Editing XQuery Documents 309 XQuery Outline View 309 Folding in XQuery Documents 310 Generating HTML Documentation for an XQuery Document 311 Editing WSDL Documents 312 WSDL Outline View 312 Content Completion in WSDL Documents 315 Editing WSDL Documents in the Master Files Context 316 Searching and Refactoring Operations in WSDL Documents 317 Searching and Refactoring Operations Scope in WSDL Documents 317 WSDL Resource Hierarchy/Dependencies View in WSDL Documents 318 Component Dependencies View in WSDL Documents 321 Highlight Component Occurrences in WSDL Documents 322 Quick Assist Support in WSDL Documents 322 Generating Documentation for WSDL Documents 323 WSDL SOAP Analyzer 326 Editing CSS Stylesheets 329 Validating CSS Stylesheets 329 Content Completion in CSS Stylesheets 330 CSS Outline View 330 Folding in CSS Stylesheets 331 Formatting and Indenting CSS Stylesheets (Pretty Print) 331 Minifying CSS Stylesheets 331 Other CSS Editing Actions 332 Editing Relax NG Schemas 332 Editing Relax NG Schema in the Master Files Context 332 Oxygen XML Editor | Contents | 8 Relax NG Schema Diagram 332 Relax NG Editor Specific Actions 337 Searching and Refactoring Actions 337 RNG Resource Hierarchy/Dependencies View 338 Component Dependencies View 340 RNG Quick Assist Support 341 Configuring a Custom Datatype Library for a RELAX NG Schema 342 Linking Between Development and Authoring 342 Editing NVDL Schemas 342 NVDL Schema Diagram 342 NVDL Editor Specific Actions 344 Searching and Refactoring Actions 344 Component Dependencies View 345 Linking Between Development and Authoring 345 Editing JSON Documents 345 JSON Editor Text Mode 346 JSON Editor Grid Mode 347 JSON Outline View 348 Validating JSON Documents 348 Convert XML to JSON 348 Editing StratML Documents 349 Editing JavaScript Documents 350 JavaScript Editor Text Mode 350 Content Completion in JavaScript Files 352 JavaScript Outline View 352 Validating JavaScript Files 353 Editing XProc Scripts 353 Editing Schematron Schemas 354 Validate an XML Document 355 Validating Schematron Documents 355 Content Completion in Schematron Documents 355 RELAX NG/XML Schema with Embedded Schematron Rules 357 Editing Schematron Schema in the Master Files Context 357 Schematron Resource Hierarchy/Dependencies View 357 Highlight Component Occurrences in Schematron Documents 359 Searching and Refactoring Operations in Schematron Documents 359 Searching and Refactoring Operations Scope in Schematron Documents 360 Quick Assist Support in Schematron Documents 360 Editing SVG Documents 361 The Standalone SVG Viewer 362 The Preview Result Panel 362 Spell Checking 363 Spell Checking Dictionaries 364 Learned Words 365 Ignored Words 365 Oxygen XML Editor | Contents | 9 Automatic Spell Check 366 Spell Checking in Multiple Files 366 Editing Large Documents 367 File sizes smaller than 300 Megabytes 367 XML file sizes greater than 300 MB 367 Scratch Buffer 368 Handling Read-Only Files 368 Editing Documents with Long Lines 368 Associating a File Extension with Oxygen XML Editor 369 Chapter 7: Author for DITA 371 Creating DITA Maps and Topics 372 Editing DITA Maps 372 Editing Actions 375 Creating a Map 377 Validating DITA Maps 377 Using a Root Map 378 Create a Topic in a Map 378 Organize Topics in a Map 378 Creating Relationship Tables 378 Advanced Operations 379 Transforming DITA Maps and Topics 382 Creating a DITA Transformation Scenario 382 Customizing a DITA Scenario 385 Running a DITA Map ANT Transformation 390 Set a Font for PDF Output Generated with Apache FOP 390 Tips and Tricks 390 DITA-OT Customization 393 Support for Transformation Customizations 393 Using Your Custom Build File 393 Customizing the Oxygen XML Editor Ant Tool 393 Increasing the Memory for the Ant Process 394 Resolving Topic References Through an XML Catalog 394 DITA to PDF Output Customization 394 Installing a plugin in the DITA Open Toolkit 396 Creating a Simple DITA OT HTML and PDF Customization Plugin 396 DITA Specialization Support 398 Integration of a DITA Specialization 398 Editing DITA Map Specializations 398 Editing DITA Topic Specializations 399 Use a New DITA Open Toolkit in Oxygen XML Editor 399 Reusing Content 399 Working with Content References 400 How to Work with Reusable Components 400 Oxygen XML Editor | Contents | 10 [...]... Options for Oxygen XML Editor Install Oxygen XML Editor on Windows Install Oxygen XML Editor on Mac OS X Install Oxygen XML Editor on Linux Installing Oxygen XML Editor on Windows NT Server Installing Oxygen XML Editor on a Linux / UNIX Server Installing Oxygen XML Editor using the Java Web Start (JWS) Installer Site-wide Deployment Obtaining and Registering a License Key for Oxygen XML Editor Setting... Server for Oxygen XML Editor Transferring or Releasing a License Key Upgrading Oxygen XML Editor Installing and Updating Add-ons in Oxygen XML Editor Uninstalling Oxygen XML Editor Oxygen XML Editor Installer Command Line Reference The platform requirements and installation instructions are presented in this chapter Oxygen XML Editor | Installation | 26 Installation Options for Oxygen XML Editor Choosing... implementations will work with future Oxygen XML Editor updates and releases Oxygen XML Editor uses the following rules to determine which installed version of Java to use: 1 If you start oXygen with the application launcher (.app) file then: a if you use the zip distribution for OS X Oxygen XML Editor uses the Apple Java SE 6 available on your Mac computer Oxygen XML Editor | Installation | 29 b if you... rename it as oxygen1 6.1 4 Start Oxygen XML Editor by running oxygenMac.sh, which is located in the install folder 5 To license your copy of Oxygen XML Editor go to Help > Register and enter your license information Oxygen XML Editor | Installation | 30 Install Oxygen XML Editor on Linux Choosing an installer You can install Oxygen XML Editor on Linux using any of the following methods: • • • Install... workstation For example: xterm -display workstationip:0.0 7 Start Oxygen XML Editor by typing oxygen. sh Installing Oxygen XML Editor using the Java Web Start (JWS) Installer Oxygen XML Editor provides the tools to create your own JWS distribution that can be installed on a custom web server Advantages of a JWS distribution include: • • • Oxygen XML Editor is run locally, not inside a web browser, overcoming... package (oxygen. tar.gz ) to a folder of your choice 2 Extract the archive in that folder Oxygen XML Editor is now installed in a new sub-folder called oxygen 3 If you wish, you can move the directory where you installed Oxygen XML Editor to your applications directory You can also rename it to contain the product version information For example you can rename it as oxygen1 6.1 4 Start Oxygen XML Editor. .. 2 Extract the archive in that folder Oxygen XML Editor is now installed in a new sub-folder called oxygen 3 If you wish, you can move the directory where you installed Oxygen XML Editor to your applications directory You can also rename it to contain the product version information For example you can rename it as oxygen1 6.1 4 Start Oxygen XML Editor by running oxygen. bat, which is located in the install... that other implementations will work with future Oxygen XML Editor updates and releases Oxygen XML Editor does not work with the GNU libgcj Java Virtual Machine Oxygen XML Editor uses the following rules to determine which installed version of Java to use: 1 If you used the Linux installer, which installs a version of Java as part of the Oxygen XML Editor installation, the version in the jre subdirectory... package (oxygen. tar.gz ) to a folder of your choice 2 Extract the archive in that folder Oxygen XML Editor is now installed in a new sub-folder called oxygen 3 If you wish, you can move the directory where you installed Oxygen XML Editor to your applications directory You can also rename it to contain the product version information For example you can rename it as oxygen1 6.1 4 Start Oxygen XML Editor. .. - 2 GB of RAM Oxygen XML Editor | Installation | 32 Storage • • Minimum - 400 MB free disk space Recommended - 1 GB free disk space Java Oxygen XML Editor requires Java If you use the native Windows installer, Oxygen XML Editor will be installed with its own copy of Java If you use the all platforms installer, your system must have a compatible Java virtual machine installed Oxygen XML Editor supports . 661 Oxygen XML Editor | Contents | 13 Transformation Scenarios View 662 The WebHelp Skin Builder 664 Using the Oxygen XML WebHelp Plugin 665 Oxygen XML WebHelp Plugin for DITA 665 Oxygen XML. Tools 891 Chapter 20: Extending Oxygen XML Editor with Plugins 893 Introduction 894 General configuration of an Oxygen XML Editor plugin 894 Installation 895 Oxygen XML Editor | Contents | 16 Types. Open XML Files in Internet Explorer Anymore 1009 I Cannot Associate Oxygen XML Editor With a File Type on My Windows Computer 1010 The Files Are Opened in Split Panels When I Restart Oxygen XML Editor