Table of Contents
User Guide
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.

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 cannot conref a Shortdesc.

In easyDITA, a content reference is highlighted in gray, 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.


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