Documentation Center

Inserting a reference to a data module

Using the S1000D Insert Reference tool, you can filter by Model, SDC, SNS, and Information Code to quickly find and insert a reference to a data module. This feature lets you add references without having to enter the markup manually. The markup that is inserted is consistent with the S1000D issue in which it is being inserted, regardless of the source.

About this task

Procedure

  1. In the editor, place your cursor where you want to insert the reference.
  2. Do one of the following.
    • In Arbortext Editor, select Contenta > Insert Reference.
    • In Oxygen XML Author, select the Contenta S1000D tool panel Reference tab.
    If the module is not writable, this command is disabled.
  3. In the Contenta S1000D Insert Reference window, click Data Module.
  4. In the Model field, click the program to be referenced.
  5. In the SDC field, click a code or click All.
  6. To filter by direct SNS:
    1. In the Select SNS by field, click Direct SNS.
    2. Click a specific code or click All.
  7. To filter by SNS parts, perform the following steps:
    1. In the Select SNS by field, click System, Subsystem, Subsubsystem, and Unit or assembly.
    2. Click System.
    3. In the System field, click a code or click All.
    4. Click Subsystem.
    5. In the Subsystem field, click a code or click All.
    6. Click SubSubsystem.
    7. In the SubSubsystem field, click a code or click All.
    8. Click Unit or Assembly.
    9. In the Unit or Assembly field, click a code or click All
  8. In the Information Code field, click a code or click All.
  9. Click Search.
  10. In the Data Module field, click a DM (or CTRL-click to select multiple DMs).
  11. Optional: Click Preview if you want to ensure that you have selected the correct DM.
    A read-only copy of the DM opens in a LiveContent Preview window.
  12. Click Insert Reference.

Results

A reference to the selected DM is inserted with the correct markup for the S1000D issue of the module being edited. In a CSDB that supports multiple languages, if language and country codes are defined for the referenced DM, they will be included in the reference markup. After inserting the reference, you can change the languageIsoCode/countryIsoCode attribute values (language/country attribute values in Issue 3.0) if needed, then run Validate to make sure the referenced object exists in that language/country in this CSDB.