Table of Contents
User Guide
Content References
Content References
Content references (conrefs) allow you to reuse topic elements in other topics.
Inserting a Conref
Use the Reuse feature to select and insert content for reuse.
Viewing Element Level Reuse
Use the Topic Editor to see reused content and where it is reused.
Content References

Content references (conrefs) allow you to reuse topic elements in other topics.

Rather than copying and pasting content, use conrefs to create a reference to content you’d like to reuse and insert the reusable content in the topic. Then, when you need to update the content, you only need to update the source content and all the files that reference the source inherit the change. That way, you can write something once and reference it in many other topics.

section
Keep the following things in mind when inserting conrefs:
  • You can only conref similar elements. If you want to reuse a Step, you can only reference to it from a Step. You can’t put the reuseable Step content in a Paragraph element.
  • You can only conref elements that are valid. If you want to conref a Paragraph, you can only reference it in areas where it is valid, such as in a Section or an Example.
  • You can only conref a Short Description (shortdesc) when it’s contained by an Abstract.
Content references are highlighted, indicating that the content cannot be edited there. Selecting the conref displays a Content Reference toolbar, where you can view the source content. To modify the text, you must open the source topic and revise the source content.

section

Reuse Strategy

We recommend creating warehouse topics to hold reusable content. Having a central area for reusable content makes it easier to manage and maintain the content. Warehouse topics are often used to hold:
  • Media
  • Notes, warnings, cautions
  • Steps
Inserting a Conref

Use the Reuse feature to select and insert content for reuse.
prereq
Important:If you haven’t yet set an ID for the element you want to reuse, you must verify that the topic you want to reuse content from is not locked. If the topic is locked by you or another user, you will not be able to set an element ID for reuse.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Place your cursor where you want to insert the conref.

    Expected Result
  3. Click Re-use Content -> Insert Conref .

    Step Information

    Expected Result
    The Select Content window displays.
  4. Navigate to and select the topic you want to reuse content from.

    Expected Result
    The selected topic displays.
  5. Select the element you want to insert.

    Expected Result
    The navigation tree dialog displays.

  6. In the navigation tree, select the element you want to insert.

    Step Information

    If the element doesn’t have an ID attribute, you will be prompted to set one. The default value is a unique ID containing the element name appended by a random number. However, you can set your own ID if you want to.
    Expected Result
    The element is selected.
  7. Click Select .
result
The element is inserted into the topic as reused content.
Reused context is highlighted in the topic where it’s reused, indicating that the content cannot be edited here. Clicking on the reused content will open a Content Reference toolbar below the content. Here you can change the reference or view the source content by clicking on the link.
Viewing Element Level Reuse

Use the Topic Editor to see reused content and where it is reused.
prereq
Check that the Reuse icon is displayed in the toolbar. This icon indicates that the topic contains element level reuse.
  1. Open a topic in the Topic Editor . Topic Editor
  2. Click the Reuse icon and select Highlight Reused Content .

    Step Information
    Expected Result
    Reused content is highlighted.
  3. Place your cursor in the content.

    Expected Result
    The element level reused icon displays.

  4. Hover over the element level reuse icon to see topics reusing this content.

    Expected Result
    The topics reusing the content are displayed.

result
You are viewing element level reuse in the topic.