Home
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Editor
DocBook 5 Document Type (Framework)
An enhanced (version 5) document type standard designed for a variety of documents (particularly technical documentation)

Introduction
Welcome to the User Manual of Oxygen XML Editor 26.1
Getting Started
Information and resources to help you get started using Oxygen XML Editor as quickly as possible
Installation
The requirements and installation instructions for each platform
Configuration
Description of all of the options that allow you to configure Oxygen XML Editor
Perspectives
The Editor, XSLT Debugger, XQuery Debugger, and Database perspectives
Editing Modes
The Text, Grid, Author, and Schema Design editing modes
Working With Documents
General information about features available when working with documents
Editing Supported Document Types
Details about the various types of supported documents and their unique editing features
Built-in Frameworks (Document Types)
The editing frameworks that are supported in Oxygen XML Editor
- DocBook 4 Document Type (Framework)
  A document type standard for books, articles, and other prose documents (particularly technical documentation)
- DocBook 5 Document Type (Framework)
  An enhanced (version 5) document type standard designed for a variety of documents (particularly technical documentation)
  - DocBook 5 Author Mode Actions
  - Inserting an Olink in DocBook Documents
- DocBook Assembly (5.1 and Later)
  A document type standard used to define the hierarchy and relationships for a collection of DocBook resources
- DocBook Topic (5.1 and Later)
  A document type standard used as a modular unit of DocBook documentation
- DocBook Targetset Document Type (Framework)
  A document type standard used to resolve cross references with the DocBook olink
- DITA Topics Document Type (Framework)
  An XML-based architecture designed for authoring, publishing, and delivering technical information
- DITA Map Document Type (Framework)
  A document type that collects and organizes references to DITA topics or other maps
- XHTML Document Type (Framework)
  Extensible HyperText Markup Language includes the same depth of expression as HTML, but also conforms to XML syntax
- TEI P5 Document Type (Framework)
  A standard for the academic community that collectively defines an XML format for text that is primarily semantic rather than presentational
- TEI ODD Document Type (Framework)
  An XML-conformant specification that allows you to create TEI P5 schema in a literate programming style
- jTEI Document Type (Framework)
  A highly restrictive customization (only about 80 elements are included) of the TEI P5 standard
- JATS Document Type (Framework)
  A technical standard that defines an XML format for scientific literature
- EPUB Document Type (Framework)
  An e-book file format that is a ZIP archive and can be downloaded and read on devices such as phones, tablets, computers, or e-readers
- OpenAPI (Swagger) Document Type (Framework)
  A specification that defines a standard programming language-agnostic interface description for HTTP APIs
- OpenAPI Test Scenario Document Type (Framework)
  A framework that provides the ability to inspect OpenAPI request responses and to ensure that they work as expected
- AsyncAPI Document Type (Framework)
  A project used to describe and document message-driven APIs in a machine-readable format
- JSON-LD Document Type (Framework)
  An easy-to-use lightweight Linked Data format that consists of multi-dimensional arrays
Additional XML Editing Frameworks (Document Types)
The custom frameworks that are supported in Oxygen XML Editor
Publishing
Details about transformation scenarios and customizing various types of output
Working with XPath Expressions
Information about using XPath Expressions in Oxygen XML Editor
Working with Archives
Describes how to use the Archive Browser to work with various type of archives
Databases and SharePoint
Connecting to supported databases and integrating Oxygen XML Editor with SharePoint
Importing Data
Information about how to import data from external sources into XML documents
XSLT/XQuery Debugging
The debugging interface that detects problems with XSLT and XQuery transformations
Framework and Author Mode Customization
Tutorials and details about customizing frameworks and the visual Author editing mode
Extending Oxygen With the SDK
Information about extending Oxygen XML Editor using the SDK
Add-ons
Information about extending Oxygen XML Editor with add-ons
Tools
Specifics about the various tools that are included in Oxygen XML Editor
Troubleshooting
A compilation of common problems and their solutions
DITA Authoring
A guide to help content authors who create and publish DITA content
Scripting Oxygen
Details about the scripting possibilities that are available with Oxygen XML Editor
Glossary
Copyright
Legal information

DocBook 5 Document Type (Framework)

DocBook is a very popular set of tags for describing books, articles, and other prose documents, particularly technical documentation. DocBook provides a vast number of semantic element tags, divided into three broad categories: structural, block-level, and inline. DocBook content can then be published in a variety of formats, including HTML, PDF, WebHelp, and EPUB.

File Definition

A file is considered to be a DocBook 5 document when the namespace is http://docbook.org/ns/docbook.

Default Document Templates

There are a variety of default DocBook 5 templates available when creating new documents from templates and they can be found in: Framework Templates > DocBook 5 > DocBook 5.0 and Framework Templates > DocBook 5 > DocBook 5.1.

New document templates for both DocBook 5 documents are located in the [OXYGEN_INSTALL_DIR]/frameworks/docbook/templates/Docbook5.0 folder.

New document templates for both DocBook 5.1 documents are located in the [OXYGEN_INSTALL_DIR]/frameworks/docbook/templates/Docbook5.1 folder.

Default Schema for Validation and Content Completion

The default schema that is used if one is not detected is docbookxi.rng and it is stored in [OXYGEN_INSTALL_DIR]/frameworks/docbook/5.0/rng/ (or for DocBook 5.1 in [OXYGEN_INSTALL_DIR]/frameworks/docbook/5.1/rng/). Other types of schemas for various DocBook versions are also located in various folders inside the [OXYGEN_INSTALL_DIR]/frameworks/docbook/ directory.

Default CSS

The default CSS files used for rendering DocBook content in Author mode is stored in [OXYGEN_INSTALL_DIR]/frameworks/docbook/css/.

By default, these default CSS files are merged with any that are specified in the document. For more information, see Configuring and Managing Multiple CSS Styles for a Framework.

Transformation Scenarios

Oxygen XML Editor includes numerous built-in DocBook transformation scenarios that allow you to transform DocBook 5 documents to a variety of outputs, such as WebHelp, PDF, HTML, HTML Chunk, XHTML, XHTML Chunk, and EPUB. Oxygen XML Editor also includes a DocBook 5.1 transformation scenario for Assembly documents. All of them are listed in the DocBook 5 section in the Configure Transformation Scenario(s) dialog box.

For more information, see the DocBook Transformation Scenarios section.

Resources