Using the S1000D Clip Reference tool to copy an object's reference information and then pasting it into another document helps ensure that the reference is accurate.
About this task
You can copy a DM's, PM's, SCORM Content Package's, or graphic's reference information to your clipboard so you can paste it into another document. This feature allows you to insert references without having to manually add the markup.
Depending on the object whose reference you want, different information is copied. The reference tag structure is different between pre-S1000D Issue 4.0 and S1000D Issue 4.0 or later specifications. Copy the set of tags that pertains to the specification version you are using.
Important:
- When you run the S1000D Clip Reference tool on an Issue 5.0 or later DM that includes an
infoNameVariant tag, those tag contents are included in the dmRef generated for the Issue 4.0 or later code block. If you subsequently insert this dmRef into a pre-5.0 module, you must delete the infoNameVariant tag from the module.
- To insert a reference to an AGE DM, you must use the S1000D Clip Reference tool. The S1000D Insert Reference tool does not support references to AGE DMs.
- If you run the S1000D Clip Reference tool on an S1000D Issue 1.7 or later DM, the resulting markup will include a
dmtitle tag. If you subsequently paste this markup into an Issue 1.6 DM, you must delete the dmtitle tag, as that tag was not added to refdm tags until Issue 1.7. Conversely, if you run Clip Reference on an Issue 1.6 DM, the resulting markup will not include a dmtitle tag, which would be invalid in another Issue 1.6 DM. However, if you are adding the markup to an Issue 1.7 or later DM, you may want to manually add the dmtitle tag (and its techname and infoname child tags and content).
Note: Because AGE markup is unavailable in S1000D Issue 4.0 or later, invoking the Clip Reference tool on an AGE DM, the
S1000D 4.0 or higher Code Block displays a statement such as the following.
Not applicable: AGE markup is not available in 4.0 or higher.
To insert references in an XML editor instead, see the "Inserting a reference to a ..." topics in this section of the documentation.