Documentation Center

Inserting reusable components from a CSDB repository

SDL Contenta S1000D aids you in locating and inserting (or referencing) reusable components (warnings, cautions, support equipment, supplies, or spares). In a multi-language CSDB, you can insert only source language components. Therefore you can insert reusable components only when editing a module in the source language. The storage mechanism varies by the reusable component type and the S1000D Issue of the DM you are editing. See the table for more information.

Before you begin

You must have the appropriate permissions to edit DMs on your Contenta S1000D desktop, and you only have access to the reusable components in your configuration. In a multi-language CSDB, you can insert reusable components only when editing a source language DM. Your cursor must be in a location in the DM that is valid for inserting the type of reusable component that you are inserting as this location will vary with the reusable component type you are inserting (or referencing).

About this task

Reusable components can be stored in the CSDB, in the DM being edited, or in a CIR DM. This table identifies the storage mechanism that SDL Contenta S1000D uses for each reusable component type in each S1000D Issue:
Issue 2.3Issue 3.0Issue 4.0Issue 4.1 (or later)
WarningCSDBCSDBCSDB and/or InternalCIR or Internal
CautionCSDBCSDBCSDB and/or InternalCIR or Internal
Support EquipmentCSDBCSDBCSDBCSDB
SupplyCSDBCSDBCSDBCSDB
SpareCSDBCSDBCSDBCSDB
Field descriptions for the Insert Reusable Component pane:
  • Select type of reusable component to find—A drop-down list containing the following reusable component types: Warnings, Cautions, Support Equipment, Supplies, and Spares.
  • All model identifiers—A checkbox that, when checked, searches for reusable components that have any model identifier rather than only for reusable components whose model identifier matches that in the DM that you are editing. Therefore, clicking this check box will typically cause more reusable components to be found/returned. Defaults to unchecked.
  • All system difference codes—A check box that, when checked, searches for reusable components that have any system difference code rather than only for reusable components whose system difference code matches that in the DM that you are editing. Therefore, clicking this check box will typically cause more reusable components to be found/returned. Defaults to unchecked.
  • Select CIR repository—A drop-down list of Issue 4.1 or later CIR DMs. You must be editing an Issue 4.1 or later DM that does not contain an internal warnings/cautions repository, and you must have selected either Warnings or Cautions from the Select type of reusable component to find drop-down list to activate this option.
  • Search—Initiates a search for reusable components of the selected type.
  • Select reusable component to insert—A radio-button list of reusable components. Click the item that you want to insert. This list includes reusable components that:
    • Match the component type you selected.
    • Match the S1000D Issue of the DM you are editing.
    • Match the model identifier of the DM you are editing, unless you checked All model identifiers.
    • Match the SDC of the DM you are editing, unless you checked All system difference codes.
    • Are associated with a Contenta configuration to which you have access.
  • Full text of selected component—Displays the entire content of the reusable component.
    • For Issues 2.3 and 3.0 warnings and cautions, structured content is displayed. The same applies to support equipment, supplies, and spares in all Issues of S1000D.
    • For Issues 4.0, 4.1, and 4.2 warnings and cautions, the text of the selected warning or caution is displayed so that you can ensure that you have selected the desired item.
  • Insert—Inserts the reusable component in the DM.
    • For Issues 2.3 and 3.0 warnings and cautions, the structured content is inserted at the location of your cursor in the DM. The same applies to all S1000D Issues of support equipment, supplies, and spares.
    • For Issue 4.0 and later warnings and cautions, a warning or caution reference is inserted where your cursor is located. If the DM being edited contains an internal warnings/cautions repository, the selected warning or caution is added to that repository. If CIR DMs are being used instead (in Issues 4.1 and later), a reference to the selected CIR DM is added.
  • Close—Dismisses the Insert Reusable Component pane.

Procedure

  1. With your cursor in a location in the DM that is valid for inserting a reusable component of the type you selected, click Contenta > Insert Reusable Component....
    If your cursor is in an element that cannot contain the reusable component type that you selected, you can continue with this procedure, but the Insert button will be deactivated until you move your cursor to a valid location for that reusable component type.
    The Contenta S1000D Insert Reusable Component pane appears at the left of your screen.
  2. In the Select type of reusable component to find field, click the drop-down list and click the reusable component type you want to insert.
  3. Optionally, you can refine your search criteria by clicking All model identifiers or All system difference codes, or both.
  4. Click Search.
    A radio-button list appears showing all reusable components that match your search criteria. The full text of the first item in the list appears in the pane below.
  5. Click the reusable component that you want to reuse.
    The full text of the selected item appears in the pane below. You can search more than once by checking/unchecking the All model identifiers or All system difference codes check boxes, or by selecting different reusable component types.
  6. Click Insert.

    For warnings and cautions in Issues 4.0 and later, a warning or caution reference is inserted. The warningRefs or cautionRefs attributes are added or updated in the element where your cursor is located. Additionally, one of the following is also inserted:

    • If the DM being edited contains an internal warnings/cautions repository (in Issues 4.0 or later), the selected warning or caution element is added to that repository (in the warningsAndCautions element).
    • If CIR DMs are being used instead (in Issues 4.1 and later), a warningRef or cautionRef element is added to the warningsAndCautionsRef section of the DM along with a dmRef tag that references the selected CIR DM.

    For all other cases, the reuseable component XML markup is inserted where your cursor is located.