Edit online

S1000D® Document Type (Framework)

S1000D® is an international specification for the procurement and production of technical publications (mainly used in aerospace and aviation industries). It is an XML-based specification for preparing, managing, and using equipment maintenance and operations information.

S1000D® has a modular architecture based on the following components:

  • Data Module - An XML-based, uniquely identified unit of information that can be managed, reused, and exchanged independently within the S1000D environment.

  • Data Module Structure - Describes the internal organization of a Data Module, typically divided into:
    • The Identification and Status part that identifies the Data Module within the CSDB structure.
    • The Content part that is the detailed information of the Data Module.

  • Common Source DataBase (CSDB) - The managed repository where S1000D objects (such as Data Modules, Publication Modules, and illustrations) are stored, controlled, and related to each other, and from which publications are assembled.

  • Business Rules Exchange (BREX) - A specialized Data Module that defines project- or organization-specific business rules governing how S1000D is applied, and against which other Data Modules can be checked for conformance.

  • Publication Module (PM) - An XML-based control file that defines the structure, sequence, and inclusion of Data Modules in a deliverable publication, effectively acting as the publication's table of contents.

  • Information Control Number (ICN) - A unique identifier assigned to illustrations and other multimedia objects, so they can be managed and referenced as standalone entities within the CSDB.

  • Data Dispatch Note (DDN) - A control document used to describe, package, and manage the exchange of Data Modules and related S1000D objects between organizations or systems.

  • Data Module Requirement List (DMRL) - A structured list of required Data Modules for a project, used as a planning and tracking tool before and during authoring.

  • Comment - A Data Module type used to record review comments, feedback, or annotations that reference one or more existing Data Modules.

Oxygen XML Author Eclipse plugin includes built-in support for S1000D. You can work with S1000D issues 4.0, 4.1, and 4.2 using built-in support for editing, visual authoring, templates, BREX handling, and smart paste.

Default Document Templates

You can get assistance with creating new S1000D® Data Modules or Publication Modules for issues 4.0, 4.1, and 4.2 by using the provided file templates available when creating new documents from templates.

Default Schema for Validation and Content Completion

The default schemas used for validation and content completion are stored in [OXYGEN_INSTALL_DIR]/frameworks/s1000d-base/ (with separate folders for each supported issue).

S1000D document editing features include schema-guiding, validation, and content completion support. Also, documentation for S1000D elements and attributes can be viewed directly in the content completion window and in the Attributes view.

Author Mode Actions

S1000D documents can be edited in the Author visual editing mode, while switching between full-width, print preview, or large-font styles. The following dedicated actions are available in the toolbar when editing S1000D documents:

Bold
Surrounds the selected text with an emphasis element with emphasisType="em01" (bold).
Italic
Surrounds the selected text with an emphasis element with emphasisType="em02" (italic).
Underline
Surrounds the selected text with an emphasis element with emphasisType="em03" (underline).
Overline
Surrounds the selected text with an emphasis element with emphasisType="em04" (overline).
Strikethrough
Surrounds the selected text with an emphasis element with emphasisType="em05" (strikethrough).
Subscript
Surrounds the selected text with a subscript element, used for inserting a character (number, letter, or symbol) that will appear slightly below the baseline and slightly smaller than the rest of the text.
Superscript
Surrounds the selected text with a superscript element, used for inserting a character (number, letter, or symbol) that will appear slightly above the baseline and slightly smaller than the rest of the text.
Insert List Item
Inserts a list item in the current list type.
Insert Sequential List
Inserts a sequential list at the cursor position. A child list item is also automatically inserted by default.
Insert Simple Random List
Inserts a simple random (unordered) list at the cursor position. A child list item is also automatically inserted by default.
Insert Unordered Random List
Inserts an unordered random list at the cursor position. A child list item is also automatically inserted by default.
Insert Definition List
Inserts a definition list at the cursor position. A child list item is also automatically inserted by default.
Insert Table
Opens a dialog box that allows you to configure and insert a table. You can generate a header and footer, set the number of rows and columns of the table and decide how the table is framed.
Insert Row
Inserts a new table row with empty cells below the current row. This action is available when the cursor is positioned inside a table.
Delete Row
Deletes the table row located at the cursor position or multiple rows in a selection.
Insert Column
Inserts a new table column with empty cells after the current column. This action is available when the cursor is positioned inside a table.
Delete Column
Deletes the table column located at the cursor position or multiple columns in a selection.
Join Cells
Joins the content of the selected table cells (both horizontally and vertically).
Split Cell
Splits the cell at the cursor location. If Oxygen XML Author Eclipse plugin detects more than one option to split the cell, a dialog box will be displayed that allows you to select the number of rows or columns to split the cell into.

BREX Editing and Transformation

BREX modules can be edited in the Text or Author mode with content completion and validation support. You can also convert BREX modules to Schematron using the provided transformation scenario.

Smart Paste

Content can be copied from web browsers or Word documents and pasted into S1000D documents while preserving structure and formatting.

Note:
To display the CGM images that are commonly used in S1000D documents, you have to install the CGM Add-on.

If you want more advanced S1000D editing features, you can ask some of our partners.