774
Oxygen XML Editor 13.2

Oxygen XML Editor 13archives.oxygenxml.com/Oxygen/Editor/doc/13.2/... · Large Documents.....40

  • Upload
    others

  • View
    14

  • Download
    0

Embed Size (px)

Citation preview

  • Oxygen XML Editor 13.2

  • Contents

    Chapter 1: Introduction..........................................................................................19Key Features and Benefits of Oxygen XML Editor ...........................................................................................20

    Chapter 2: Installation............................................................................................23Installation Requirements....................................................................................................................................24

    Platform Requirements............................................................................................................................24

    Operating System....................................................................................................................................24

    Environment Requirements.....................................................................................................................24

    JWS-specific Requirements....................................................................................................................24

    Installation Instructions.......................................................................................................................................25

    Windows Installation...............................................................................................................................25

    Mac OS X Installation.............................................................................................................................26

    Linux Installation....................................................................................................................................26

    All Platforms Installation........................................................................................................................26

    Unix / Linux Server Configuration.........................................................................................................27

    Windows NT Terminal Server Configuration.........................................................................................27

    Unattended Installation............................................................................................................................28

    Java Web Start (JWS) Installer............................................................................................................................29

    Setting a Parameter in the Launcher Configuration File / Startup Script............................................................30

    Starting the Application.......................................................................................................................................31

    Starting the Application on Windows......................................................................................................31

    Starting the Application on Mac OS X....................................................................................................31

    Starting the Application on Linux...........................................................................................................32

    Starting the Application with the All Platforms Kit................................................................................32

    Obtaining and Registering a License Key...........................................................................................................32

    Named User License Registration...........................................................................................................33

    Named User License Registration with Text File....................................................................................33

    Named User License Registration with XML File..................................................................................33

    How Floating (Concurrent) Licenses Work.............................................................................................34

    License Registration with an Activation Code........................................................................................39

    Unregistering the License Key............................................................................................................................39

    Upgrading the Oxygen XML Editor Application................................................................................................39

    Upgrading the Standalone Application....................................................................................................39

    Checking for New Versions.................................................................................................................................40

    Uninstalling the Application................................................................................................................................40

    Uninstalling the Standalone Application.................................................................................................40

    Unattended Uninstall...............................................................................................................................40

    Performance Problems........................................................................................................................................40

    Table of Contents | 3

  • Large Documents....................................................................................................................................40

    External Processes...................................................................................................................................41

    Display Problems on Linux/Solaris.........................................................................................................41

    Chapter 3: Getting Started.....................................................................................43Getting Help........................................................................................................................................................44

    Supported Types of Documents...........................................................................................................................44

    Perspectives.........................................................................................................................................................44

    Editor Perspective ...................................................................................................................................44

    XSLT Debugger Perspective ..................................................................................................................47

    XQuery Debugger Perspective ...............................................................................................................48

    Database Perspective ..............................................................................................................................49

    Tree Editor Perspective...........................................................................................................................51

    Dockable Views and Editors................................................................................................................................52

    Chapter 4: Editing Documents..............................................................................55Working with Unicode........................................................................................................................................56

    Opening and Saving Unicode Documents...............................................................................................56

    The Unicode Toolbar...............................................................................................................................57

    Opening and Closing Documents........................................................................................................................57

    Creating New Documents.......................................................................................................................57

    Saving Documents...................................................................................................................................61

    Opening Existing Documents..................................................................................................................62

    Opening and Saving Remote Documents via FTP/SFTP/WebDAV ......................................................63

    Opening the Current Document in System Application..........................................................................67

    Closing Documents.................................................................................................................................67

    Viewing File Properties...........................................................................................................................67

    Grouping Documents in XML Projects...............................................................................................................67

    Using the Project View............................................................................................................................67

    Editing XML Documents....................................................................................................................................71

    Associate a Schema to a Document........................................................................................................71

    Streamline with Content Completion......................................................................................................75

    Validating XML Documents...................................................................................................................82

    Document Navigation..............................................................................................................................92

    Large Documents....................................................................................................................................95

    Working with XML Catalogs..................................................................................................................98

    Converting Between Schema Languages................................................................................................99

    Editing XML Tree Nodes......................................................................................................................101

    Formatting and Indenting Documents (Pretty Print).............................................................................101

    Viewing Status Information...................................................................................................................102

    Image Preview.......................................................................................................................................102

    Making a Persistent Copy of Results....................................................................................................102

    Locking and Unlocking XML Markup.................................................................................................103

    Table of Contents | 4

  • Adjusting the Transparency of XML Markup.......................................................................................103

    XML Editor Specific Actions................................................................................................................103

    Editing XHTML Documents.................................................................................................................107

    Editing XML Schemas......................................................................................................................................107

    XML Schema Text Editor.....................................................................................................................107

    XML Schema Diagram Editor..............................................................................................................109

    Contextual Editing.................................................................................................................................137

    Create an XML Schema From a Relational Database Table.................................................................137

    Generate Sample XML Files.................................................................................................................137

    XML Schema Regular Expressions Builder.........................................................................................141

    Generating Documentation for an XML Schema..................................................................................143

    Searching and Refactoring Actions.......................................................................................................150

    Search and Refactor Operations Scope.................................................................................................152

    Resource Hierarchy / Dependencies View............................................................................................153

    Component Dependencies View............................................................................................................155

    Highlight Component Occurrences.......................................................................................................156

    XML Schema Quick Assist Support.....................................................................................................156

    Linking Between Development and Authoring.....................................................................................157

    Editing Relax NG Schemas...............................................................................................................................157

    Relax NG Schema Diagram..................................................................................................................157

    Relax NG Editor Specific Actions.........................................................................................................161

    Searching and Refactoring Actions.......................................................................................................162

    Resource Hierarchy/Dependencies View..............................................................................................162

    Component Dependencies View............................................................................................................164

    RNG Quick Assist Support...................................................................................................................164

    Configuring a Custom Datatype Library for a RELAX NG Schema....................................................165

    Linking Between Development and Authoring.....................................................................................165

    Editing NVDL Schemas....................................................................................................................................165

    NVDL Schema Diagram.......................................................................................................................165

    NVDL Editor Specific Actions..............................................................................................................167

    Searching and Refactoring Actions.......................................................................................................167

    Component Dependencies View............................................................................................................168

    Linking Between Development and Authoring.....................................................................................168

    Editing XSLT Stylesheets..................................................................................................................................168

    Validating XSLT Stylesheets.................................................................................................................168

    Contextual Editing.................................................................................................................................169

    Syntax Highlight...................................................................................................................................169

    Content Completion in XSLT Stylesheets.............................................................................................169

    The XSLT/XQuery Input View..............................................................................................................174

    The XSLT Outline View........................................................................................................................175

    XSLT Stylesheet Documentation Support.............................................................................................177

    Generating Documentation for an XSLT Stylesheet.............................................................................178

    Finding XSLT References and Declarations.........................................................................................186

    Highlight Component Occurrences.......................................................................................................186

    XSLT Refactoring Actions....................................................................................................................186

    Table of Contents | 5

  • Resource Hierarchy/Dependencies View..............................................................................................187

    Component Dependencies View............................................................................................................188

    XSLT Quick Assist Support..................................................................................................................189

    Linking Between Development and Authoring.....................................................................................190

    Editing XQuery Documents..............................................................................................................................190

    XQuery Outline View............................................................................................................................190

    Folding in XQuery Documents.............................................................................................................192

    Generating HTML Documentation for an XQuery Document.............................................................192

    Editing CSS Stylesheets....................................................................................................................................193

    Validating CSS Stylesheets...................................................................................................................193

    Content Completion in CSS Stylesheets...............................................................................................194

    CSS Outline View..................................................................................................................................195

    Folding in CSS Stylesheets...................................................................................................................195

    Formatting and Indenting CSS Stylesheets (Pretty Print).....................................................................195

    Other CSS Editing Actions....................................................................................................................195

    Editing JSON Documents.................................................................................................................................195

    JSON Editor Text Mode........................................................................................................................196

    JSON Editor Grid Mode........................................................................................................................197

    Validating JSON Documents.................................................................................................................197

    Convert XML to JSON..........................................................................................................................198

    Editing XProc Scripts........................................................................................................................................199

    Editing Schematron Schemas............................................................................................................................199

    Combined RELAX NG / W3C XML Schemas and Schematron Schema............................................200

    Validate an XML Document..................................................................................................................200

    SVG Documents................................................................................................................................................201

    The Standalone SVG Viewer.................................................................................................................201

    The Preview Result Panel......................................................................................................................202

    Integrating External Tools.................................................................................................................................202

    Editing Very Large Documents.........................................................................................................................203

    Insufficient Memory..........................................................................................................................................204

    Large File Viewer..............................................................................................................................................204

    Handling Bidirectional (BIDI) Text..................................................................................................................206

    Hex Viewer........................................................................................................................................................206

    Scratch Buffer....................................................................................................................................................207

    Localization of the User Interface.....................................................................................................................207

    Handling Read-Only Files.................................................................................................................................208

    Editing Documents with Long Lines.................................................................................................................208

    Chapter 5: Authoring in the Visual Editor.........................................................211Authoring XML Documents Without the XML Tags.......................................................................................212

    General Author Presentation.............................................................................................................................213

    Author Views.........................................................................................................................................214

    The Author Editor..................................................................................................................................218

    Review...................................................................................................................................................234

    Table of Contents | 6

  • Profiling / Conditional Text...................................................................................................................236

    Smart Paste Support..........................................................................................................................................241

    Chapter 6: Author for DITA................................................................................243Creating DITA Maps and Topics.......................................................................................................................244

    Editing DITA Maps...........................................................................................................................................244

    Editing Actions......................................................................................................................................246

    Creating a Map......................................................................................................................................247

    Validating DITA Maps..........................................................................................................................247

    Create a Topic in a Map.........................................................................................................................249

    Organize Topics in a Map......................................................................................................................249

    Create a Bookmap.................................................................................................................................249

    Create a Subject Scheme.......................................................................................................................249

    Create Relationships Between Topics...................................................................................................250

    Advanced Operations............................................................................................................................250

    Transforming DITA Maps and Topics...............................................................................................................254

    Available Output Formats......................................................................................................................254

    Configuring a DITA Transformation.....................................................................................................257

    Running a DITA Map ANT Transformation.........................................................................................257

    Customizing a DITA Scenario...............................................................................................................257

    Set a Font for PDF Output Generated with Apache FOP......................................................................263

    DITA-OT Customization...................................................................................................................................263

    Support for Transformation Customizations.........................................................................................263

    Using Your Custom Build File..............................................................................................................263

    Customizing the Oxygen XML Editor Ant Tool...................................................................................263

    Upgrading to a New Version of DITA OT.............................................................................................263

    Increasing the Memory for the Ant Process..........................................................................................263

    Resolving Topic References Through an XML Catalog.......................................................................263

    DITA Specialization Support............................................................................................................................264

    Integration of a DITA Specialization.....................................................................................................264

    Editing DITA Map Specializations.......................................................................................................264

    Editing DITA Topic Specializations......................................................................................................264

    Use a New DITA Open Toolkit in Oxygen XML Editor ..................................................................................265

    Reusing Content................................................................................................................................................265

    Working with Content References........................................................................................................265

    How to Work with Reusable Components............................................................................................266

    Insert a Direct Content Reference.........................................................................................................266

    DITA Profiling / Conditional Text.....................................................................................................................267

    Profiling / Conditional Text Markers.....................................................................................................267

    Profiling with a Subject Scheme Map...................................................................................................268

    Publish Profiled Text.............................................................................................................................269

    How to Profile DITA Content...............................................................................................................269

    Working with MathML.....................................................................................................................................269

    Table of Contents | 7

  • Chapter 7: Predefined Document Types.............................................................271Document Type.................................................................................................................................................272

    The DocBook 4 Document Type.......................................................................................................................272

    Author Extensions.................................................................................................................................272

    Transformation Scenarios......................................................................................................................275

    Templates...............................................................................................................................................275

    Inserting olink Links in Docbook Documents......................................................................................275

    The DocBook 5 Document Type.......................................................................................................................278

    Author Extensions.................................................................................................................................278

    Transformation Scenarios......................................................................................................................279

    Templates...............................................................................................................................................279

    Inserting olink Links in Docbook Documents......................................................................................279

    The DocBook Targetset Document Type..........................................................................................................282

    Templates...............................................................................................................................................282

    The DITA Topics Document Type.....................................................................................................................283

    Author Extensions.................................................................................................................................283

    Transformation Scenarios......................................................................................................................289

    Templates...............................................................................................................................................289

    The DITA Map Document Type........................................................................................................................289

    Author Extensions.................................................................................................................................290

    Transformation Scenarios......................................................................................................................290

    Templates...............................................................................................................................................290

    The XHTML Document Type...........................................................................................................................291

    Author Extensions.................................................................................................................................291

    Transformation Scenarios......................................................................................................................292

    Templates...............................................................................................................................................293

    The TEI ODD Document Type.........................................................................................................................293

    Author Extensions.................................................................................................................................293

    Transformation Scenarios......................................................................................................................295

    Templates...............................................................................................................................................295

    The TEI P4 Document Type..............................................................................................................................295

    Author Extensions.................................................................................................................................295

    Transformation Scenarios......................................................................................................................297

    Templates...............................................................................................................................................297

    Customization of TEI Frameworks.......................................................................................................297

    The TEI P5 Document Type..............................................................................................................................298

    Transformation Scenarios......................................................................................................................298

    Templates...............................................................................................................................................298

    Customization of TEI Frameworks.......................................................................................................298

    The EPUB Document Type...............................................................................................................................299

    Chapter 8: Author Developer Guide...................................................................301

    Table of Contents | 8

  • Simple Customization Tutorial..........................................................................................................................303

    XML Schema........................................................................................................................................303

    CSS Stylesheet......................................................................................................................................304

    The XML Instance Template.................................................................................................................306

    Advanced Customization Tutorial - Document Type Associations...................................................................307

    Author Settings......................................................................................................................................308

    Creating the Basic Association..............................................................................................................329

    Configuring New File Templates..........................................................................................................337

    Configuring XML Catalogs...................................................................................................................340

    Configuring Transformation Scenarios.................................................................................................340

    Configuring Validation Scenarios..........................................................................................................342

    Configuring Extensions.........................................................................................................................344

    Customizing the Default CSS of a Document Type..............................................................................369

    Document Type Sharing........................................................................................................................369

    Other Author Features...........................................................................................................................370

    CSS Support in Author......................................................................................................................................371

    CSS 2.1 Features...................................................................................................................................371

    CSS 3 Features......................................................................................................................................375

    Styling Elements from other Namespace..............................................................................................379

    Additional Custom Selectors.................................................................................................................379

    Oxygen CSS Extensions........................................................................................................................381

    Example Files Listings - The Simple Documentation Framework Files..........................................................389

    XML Schema files.................................................................................................................................389

    CSS Files...............................................................................................................................................391

    XML Files.............................................................................................................................................393

    XSL Files...............................................................................................................................................395

    Author Component............................................................................................................................................396

    Licensing...............................................................................................................................................396

    Installation Requirements......................................................................................................................397

    Customization........................................................................................................................................397

    Deployment...........................................................................................................................................399

    Frequently asked questions...................................................................................................................402

    Chapter 16: Grid Editor.......................................................................................421Layouts: Grid and Tree......................................................................................................................................422

    Navigating the Grid...........................................................................................................................................422

    Specific Grid Actions........................................................................................................................................423

    Sorting a Table Column.........................................................................................................................423

    Inserting a Row in a Table.....................................................................................................................423

    Inserting a Column in a Table...............................................................................................................423

    Clearing the Content of a Column.........................................................................................................423

    Adding Nodes........................................................................................................................................423

    Duplicating Nodes.................................................................................................................................423

    Refresh Layout......................................................................................................................................424

    Table of Contents | 9

  • Start Editing a Cell Value......................................................................................................................424

    Stop Editing a Cell Value......................................................................................................................424

    Drag and Drop in the Grid Editor......................................................................................................................424

    Copy and Paste in the Grid Editor.....................................................................................................................424

    Bidirectional Text Support in the Grid Editor...................................................................................................426

    Chapter 17: Transforming Documents................................................................427Output Formats..................................................................................................................................................428

    Transformation Scenario...................................................................................................................................429

    Batch Transformation............................................................................................................................429

    Built-in Transformation Scenarios........................................................................................................429

    Defining a New Transformation Scenario.............................................................................................430

    Sharing the Transformation Scenarios..................................................................................................439

    Transformation Scenarios View.............................................................................................................440

    XSLT Processors...............................................................................................................................................441

    Supported XSLT Processors..................................................................................................................442

    Configuring Custom XSLT Processors.................................................................................................443

    Configuring the XSLT Processor Extensions Paths..............................................................................443

    XSL-FO Processors...........................................................................................................................................443

    The Built-in XSL-FO Processor............................................................................................................444

    Add a Font to the Built-in FOP - The Simple Version..........................................................................444

    Add a Font to the Built-in FOP.............................................................................................................445

    XProc Transformations.....................................................................................................................................448

    XProc Transformation Scenario............................................................................................................448

    Integration of an External XProc Engine..............................................................................................448

    Chapter 18: Querying Documents.......................................................................451Running XPath Expressions..............................................................................................................................452

    What is XPath........................................................................................................................................452

    Oxygen's XPath Console.......................................................................................................................452

    The XPath Builder View........................................................................................................................455

    Working with XQuery.......................................................................................................................................455

    What is XQuery.....................................................................................................................................456

    Syntax Highlight and Content Completion...........................................................................................456

    XQuery Outline View............................................................................................................................456

    The XQuery Input View........................................................................................................................458

    XQuery Validation.................................................................................................................................459

    Other XQuery Editing Actions..............................................................................................................460

    Transforming XML Documents Using XQuery....................................................................................460

    Chapter 19: Debugging XSLT Stylesheets and XQuery Documents................465Overview...........................................................................................................................................................466

    Layout................................................................................................................................................................466

    Table of Contents | 10

  • Control Toolbar.....................................................................................................................................467

    Information View...................................................................................................................................469

    Multiple Output Documents in XSLT 2.0.............................................................................................478

    Working with the XSLT / XQuery Debugger....................................................................................................478

    Steps in a Typical Debug Process..........................................................................................................478

    Using Breakpoints.................................................................................................................................479

    Determining What XSLT / XQuery Expression Generated Particular Output......................................479

    Debugging Java Extensions...............................................................................................................................481

    Supported Processors for XSLT / XQuery Debugging.....................................................................................482

    Chapter 20: Profiling XSLT Stylesheets and XQuery Documents...................483Overview...........................................................................................................................................................484

    Viewing Profiling Information..........................................................................................................................484

    Invocation Tree View.............................................................................................................................484

    Hotspots View........................................................................................................................................485

    Working with XSLT/XQuery Profiler...............................................................................................................485

    Chapter 21: Comparing and Merging Documents.............................................487Directories Comparison.....................................................................................................................................488

    Directories Comparison User Interface.................................................................................................488

    Comparison Result................................................................................................................................489

    Compare Images....................................................................................................................................490

    Files Comparison...............................................................................................................................................490

    Main Menu............................................................................................................................................491

    Compare Toolbar...................................................................................................................................493

    Files Selector.........................................................................................................................................495

    File Contents Panel................................................................................................................................495

    Word Level Comparison........................................................................................................................495

    Character Level Comparison.................................................................................................................495

    XML Diff API...................................................................................................................................................496

    Chapter 22: Working with Archives....................................................................497Browsing and Modifying Archive Structure.....................................................................................................498

    Working with EPUB..........................................................................................................................................499

    Create an EPUB.....................................................................................................................................500

    Publish to EPUB....................................................................................................................................500

    Editing Files From Archives..............................................................................................................................501

    Chapter 23: Working with Databases.................................................................503Relational Database Support.............................................................................................................................504

    Configuring Database Data Sources......................................................................................................504

    Configuring Database Connections.......................................................................................................509

    Table of Contents | 11

  • Resource Management..........................................................................................................................514

    SQL Execution Support.........................................................................................................................519

    Native XML Database (NXD) Support.............................................................................................................521

    Configuring Database Data Sources......................................................................................................522

    Configuring Database Connections.......................................................................................................524

    Data Source Explorer View...................................................................................................................526

    XQuery and Databases......................................................................................................................................536

    Build Queries With Drag and Drop From Data Source Explorer View................................................536

    XQuery Transformation........................................................................................................................537

    XQuery Database Debugging................................................................................................................538

    WebDAV Connection........................................................................................................................................540

    How to Configure a WebDAV Connection............................................................................................540

    WebDAV Connection Actions...............................................................................................................540

    Chapter 24: Importing Data................................................................................543Introduction.......................................................................................................................................................544

    Import from Database........................................................................................................................................544

    Import Table Content as XML Document.............................................................................................544

    Convert Table Structure to XML Schema.............................................................................................546

    Import from MS Excel Files..............................................................................................................................546

    Import from HTML Files..................................................................................................................................547

    Import from Text Files.......................................................................................................................................547

    Chapter 25: Content Management System (CMS) Integration........................551Integration with Documentum (CMS)..............................................................................................................552

    Configure Connection to Documentum Server.....................................................................................552

    Documentum (CMS) Actions in the Data Source Explorer View.........................................................553

    Transformations on DITA Content from Documentum (CMS)............................................................557

    Chapter 26: Composing Web Service Calls........................................................559Overview...........................................................................................................................................................560

    Composing a SOAP Request.............................................................................................................................560

    Testing Remote WSDL Files.............................................................................................................................563

    The UDDI Registry Browser.............................................................................................................................563

    Generate WSDL Documentation.......................................................................................................................564

    Chapter 27: Digital Signatures.............................................................................567Overview...........................................................................................................................................................568

    Canonicalizing Files..........................................................................................................................................569

    Certificates.........................................................................................................................................................570

    Signing Files......................................................................................................................................................570

    Verifying the Signature......................................................................................................................................571

    Table of Contents | 12

  • Chapter 28: Syncro SVN Client...........................................................................573Main Window....................................................................................................................................................574

    Views.....................................................................................................................................................574

    Main Menu............................................................................................................................................574

    Main Toolbar.........................................................................................................................................580

    Status Bar..............................................................................................................................................580

    Getting Started...................................................................................................................................................581

    SVN Repository Location.....................................................................................................................581

    Defining a Working Copy......................................................................................................................583

    Manage Working Copy Resources........................................................................................................586

    Synchronize with Repository................................................................................................................589

    Obtain Information for a Resource........................................................................................................598

    Management of SVN Properties............................................................................................................598

    Branches and Tags.................................................................................................................................599

    Working with Repositories....................................................................................................................622

    Sparse Checkout....................................................................................................................................624

    Syncro SVN Client Views.................................................................................................................................624

    Repositories View..................................................................................................................................624

    Working Copy View..............................................................................................................................627

    History View..........................................................................................................................................637

    Directory Change Set View...................................................................................................................640

    The Editor Panel of SVN Client............................................................................................................641

    Annotations View..................................................................................................................................641

    Compare View.......................................................................................................................................642

    Image Preview.......................................................................................................................................644

    Compare Images View...........................................................................................................................644

    Properties View......................................................................................................................................644

    Console View.........................................................................................................................................646

    Dynamic Help View..............................................................................................................................646

    The Revision Graph of a SVN Resource...........................................................................................................646

    Syncro SVN Client Preferences........................................................................................................................649

    Command Line Reference.................................................................................................................................649

    Checkout Command..............................................................................................................................649

    Update Command..................................................................................................................................650

    Commit Command................................................................................................................................650

    Diff Command.......................................................................................................................................650

    Show History.........................................................................................................................................650

    Refresh...................................................................................................................................................651

    Synchronize...........................................................................................................................................651

    Import....................................................................................................................................................651

    Export....................................................................................................................................................651

    Information............................................................................................................................................651

    Add........................................................................................................................................................652

    Table of Contents | 13

  • Add to svn:ignore..................................................................................................................................652

    Delete.....................................................................................................................................................652

    Copy......................................................................................................................................................652

    Move / Rename......................................................................................................................................652

    Mark resolved........................................................................................................................................653

    Revert....................................................................................................................................................653

    Cleanup..................................................................................................................................................653

    Show / Refresh Properties.....................................................................................................................653

    Branch / Tag..........................................................................................................................................653

    Merge.....................................................................................................................................................653

    Scan for locks........................................................................................................................................654

    Lock.......................................................................................................................................................654

    Unlock...................................................................................................................................................654

    Mark as merged.....................................................................................................................................654

    Override and update..............................................................................................................................655

    Override and Commit............................................................................................................................655

    Add / Edit property................................................................................................................................655

    Remove property...................................................................................................................................655

    Revert changes from this revision.........................................................................................................655

    Revert changes from these revisions.....................................................................................................655

    Technical Issues.................................................................................................................................................656

    Authentication Certificates Not Saved..................................................................................................656

    Updating Newly Added Resources........................................................................................................656

    Chapter 29: Extending Oxygen XML Editor with Plugins...............................657Introduction.......................................................................................................................................................658

    General configuration of an Oxygen XML Editor plugin.................................................................................658

    Types of plugins................................................................................................................................................659

    General Plugin.......................................................................................................................................659

    Selection Plugin.....................................................................................................................................659

    Document Plugin...................................................................................................................................660

    Custom Protocol Plugin........................................................................................................................660

    Resource Locking Custom Protocol Plugin..........................................................................................660

    Components Validation Plugin..............................................................................................................661

    Workspace Access Plugin......................................................................................................................662

    Open Redirect Plugin............................................................................................................................663

    Targeted URL Stream Handler Plugin..................................................................................................663

    Lock Handler Factory Plugin................................................................................................................665

    How to...............................................................................................................................................................665

    How to Write a CMS Integration Plugin...............................................................................................665

    How to Write A Custom Protocol Plugin..............................................................................................669

    Installation.........................................................................................................................................................669

    Example - A Selection Plugin...........................................................................................................................670

    Table of Contents | 14

  • Chapter 30: Text Editor Specific Actions............................................................673Undoing and Redoing User Actions..................................................................................................................674

    Copying and Pasting Text..................................................................................................................................674

    Finding and Replacing Text in the Current File................................................................................................674

    The Find / Replace Dialog.....................................................................................................................674

    The Find All Elements / Attributes Dialog............................................................................................677

    The Quick Find Toolbar........................................................................................................................678

    Keyboard Shortcuts for Finding the Next and Previous Match.............................................................678

    Finding and Replacing Text in Multiple Files...................................................................................................678

    Spell Checking..................................................................................................................................................681

    Spell Checking Dictionaries..................................................................................................................682

    Learned Words.......................................................................................................................................683

    Ignored Words.......................................................................................................................................683

    Automatic Spell Check..........................................................................................................................683

    Spell Checking in Multiple Files...........................................................................................................684

    Changing the Font Size.....................................................................................................................................684

    Word/Line Editor Actions.................................................................................................................................685

    Dragging and Dropping the Selected Text........................................................................................................685

    Inserting a File at Caret Position.......................................................................................................................685

    Opening the File at Caret in System Application..............................................................................................685

    Opening the File at Caret Position....................................................................................................................685

    Switching Between Opened Tabs......................................................................................................................685

    Printing a File....................................................................................................................................................685

    Exiting the Application......................................................................................................................................686

    Chapter 31: Configuring the Application...........................................................687Configuring Options..........................................................................................................................................688

    Customized Default Options.................................................................................................................688

    Project Level User Options...................................................................................................................689

    Importing / Exporting Global Options..............................................................................................................689

    Preferences........................................................................................................................................................690

    Global....................................................................................................................................................691

    Fonts......................................................................................................................................................692

    Document Type Association..................................................................................................................692

    Perspectives Layout...............................................................................................................................693

    Encoding................................................................................................................................................694

    Editor.....................................................................................................................................................695

    CSS Validator........................................................................................................................................713

    XML......................................................................................................................................................713

    Data Sources..........................................................................................................................................730

    SVN.......................................................................................................................................................733

    Files Comparison...................................................................................................................................736

    Table of Contents | 15

  • Directories Comparison.........................................................................................................................738

    Archive..................................................................................................................................................739

    Plugins...................................................................................................................................................740

    External Tools........................................................................................................................................740

    Menu Shortcut Keys..............................................................................................................................742

    File Types..............................................................................................................................................743

    SVN File Editors...................................................................................................................................743

    Custom Editor Variables........................................................................................................................745

    HTTP(S) / (S)FTP / Proxy Configuration ............................................................................................745

    Certificates.............................................................................................................................................748

    XML Structure Outline.........................................................................................................................749

    View.......................................................................................................................................................749

    Messages...............................................................................................................................................749

    Tree Editor.............................................................................................................................................751

    Reset Global Options.........................................................................................................................................751

    Scenarios Management......................................................................................................................................751

    Editor Variables.................................................................................................................................................751

    Custom Editor Variables........................................................................................................................753

    Configure Toolbars............................................................................................................................................753

    Chapter 32: Common Problems..........................................................................755XML Document Opened After a Long Time....................................................................................................757

    Out Of Memory Error When I Open Large Documents....................................................................................757

    Special Characters Are Replaced With a Square in Editor................................................................................757

    XSLT Debugger Is Very Slow...........................................................................................................................757

    The Scroll Function of my Notebook's Trackpad is Not Working....................................................................757

    NullPointerException at Startup on Windows XP.............................................................................................758

    Crash at Startup on Windows with an Error Message About a File nvoglv32.dll.............................................758

    Oxygen XML Crashed on My Mac OS X Computer........................................................................................758

    Wrong Highlights of Matched Words in a Search in User Manual...................................................................759

    Keyboard Shortcuts Do Not Work.....................................................................................................................759

    After Installing Oxygen XML Editor I Cannot Open XML Files in Internet Explorer Anymore....................759

    I Cannot Associate Oxygen XML Editor With a File Type on My Windows Computer..................................760

    The Files Are Opened in Split Panels When I Restart the Oxygen XML Editor Application..........................760

    Grey Window on Linux With the Compiz / Beryl Window Manager...............................................................760

    Drag and Drop Without Initial Selection Does Not Work.................................................................................760

    Set Specific JVM Version on Mac OS X...........................................................................................................761

    Segmentation Fault Error on Mac OS X...........................................................................................................761

    Damaged File Associations on Mac OS X........................................................................................................761

    I Cannot Connect to SVN Repository From Repositories View.......................................................................762

    Problem Report Submitted on the Technical Support Form.............................................................................762

    Signature verification failed error on open or edit a resource from Documentum...........................................762

    Cannot cancel a system shutdown when there is at least one modified document open in Oxygen XML Editor

    .....................................................................................................................................................................763

    Table of Contents | 16

  • Chapter 33: Terms.................................................................................................765

    Table of Contents | 17

  • 18 | Table of Contents

  • Chapter

    1

    Introduction

    Welcome to the User Manual of Oxygen XML Editor 13.2 .Topics:

    Oxygen XML Editor is a cross-platform application designed for documentdevelopment using structured mark-up languages such as XML , XSD, RelaxNG, XSL, DTD.

    • Key Features and Benefits ofOxygen XML Editor

    It offers developers and authors a powerful Integrated Development Environment.Based on proven Java technology, the intuitive Graphical User Interface of theOxygen XML Editor is easy-to-use and provides robust functionality for editing,project management and validation of structured mark-up sources. Coupled withXSLT and FOP transformation technologies, Oxygen XML Editor supportsoutput to multiple target formats, including: PDF, PS, TXT, HTML, JavaHelpand XML.

    Oxygen XML Editor is the XML Editor of choice for developers, authors andintegrators that demand high-quality output with a flexible and robust,single-source, structured mark-up environment.

    This user guide is focused mainly at describing features, functionality andapplication interface to help you get started in no time. It also describes the basicprocess of authoring, management, validation of structured mark-up documentsand their transformation to multiple target outputs. It is assumed that you arefamiliar with the use of your operating system and the concepts related tostructured mark-up.

  • Key Features and Benefits of Oxygen XML Editor

    Multilanguage support: English, German, French, Italianand Japanese

    Multiplatform availability: Windows, Mac OS X, Linux,Solaris

    Visual DITA Map editorVisual WYSIWYG XML editing mode based on W3CCSS stylesheets.

    Support for latest versions of document frameworks:DocBook and TEI.

    Closely integrate with the DITA Open Toolkit forgenerating DITA output

    Non blocking operations, you can perform validation andtransformation operations in background

    Can be used as standalone desktop application, run throughJava Web Start or as an Eclipse plugin

    Support f