Inserting items from a CIR or a CSDB reusable components repository
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
| Issue 2.3 | Issue 3.0 | Issue 4.0 | Issue 4.1 (or later) | |
|---|---|---|---|---|
| Warning | CSDB | CSDB | CSDB and/or Internal | CIR or Internal |
| Caution | CSDB | CSDB | CSDB and/or Internal | CIR or Internal |
| Support Equipment | CSDB | CSDB | CSDB | CSDB |
| Supply | CSDB | CSDB | CSDB | CSDB |
| Spare | CSDB | CSDB | CSDB | CSDB |
To help make locating warnings and cautions stored in CIR DMs easier, the Insert Reusable Component editor plug-in allows you to enter a search string (consisting of plain text or an XSLT 3.x regular expression) by which to filter search results, displaying only warnings and cautions whose content or attributes contain this value.
To customize search functionality by CIR type, modify the ReusableComponentSearchConfig.xml configuration file in the Contenta_home\web\cw_common\custom\S1000D_config directory on the Contenta Web server.
- S1000D Spec Issue (Issue 4.1 or later)
- Element(s) within which to search for the specified search string
- Maximum number of search results to be returned
- 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.
- Find CIR items that contain—Enter a text string or regular expression to match in an item's content or attributes when searching in a CIR DM. You can activate this option only if you are editing an Issue 4.1 or later DM that does not contain an internal warnings/cautions repository, and selected Warnings or Cautions in the Select type of reusable component to find field.
- Search—Initiates a search for reusable components of the selected type.
- Select reusable component to insert—A 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, 4.2, and 5.0 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.