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
Important: When editing an S1000D Issue 3.0 or earlier DM, the S1000D Insert Reference tool searches for and inserts references only to AVEE DMs, and not to AGE DMs. To insert a reference to an AGE DM, instead use the S1000D Clip Reference tool.
Note:
- Because warning and caution CIR data modules share the same Information Code, 012, and since the Insert Reference window displays each Information Code along with one Information Name, the Information Name indicates either a warning repository or a caution repository, but not both. However, when you search for DMs with an Information Code of 012, all warning and caution CIR DMs that exist in the CSDB are displayed in the search results.
- If your CSDB contains AGE and AVEE DMs that share the same Information Code, the Information Name displayed next to the Information Code may be drawn from an AGE DM rather than from an AVEE DM. However, when you search for DMs with the desired Information Code(s), only AVEE DMs are displayed in the search results.
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.
When inserting a reference into an Issue 5.0 DM, if the referenced DM is also for Issue 5.0 and contains an
infoNameVariant element, the
infoNameVariant is included in the
dmRef markup.
Note: In Oxygen XML Author, Title must be selected on the Tool panel Reference tab for infoNameVariant to be included in the markup.