Create a reusable element

Before you can reuse an element as a conref, you must first give it an ID attribute and add it to a topic with the referable-content type.

Check if you can create a topic with the referable-content type. If you don't see a template for a referable-content type, contact your administrator about creating a template for it.

You can add an ID attribute with a unique value to any element. By referencing that ID, you can reuse that element from a topic with the referable-content type in any other topic.

Tip: As a best practice, it is better to create a new topic for each element or component you want to reuse rather than having one topic with all the reusable content. To organize these new topics, you can create a map to act as a library of reusable content.

To create a reusable element:

  1. In Map Editor, create a new topic with the referable-content type.
    1. For the map, click Edit.
    2. Put your cursor where you want to add the new topic.
    3. On the toolbar, click Create a new DITA topic and insert a reference to it icon.
    4. Name the topic and click Next.
    5. Select the referable-content topic template.
      Note: The template might have a different name depending on how your Administrator set it up.
    6. Click Create.
  2. Edit the new topic in Topic Editor.
  3. Add the element that you want to make reusable to the topic.
  4. Select the element.
  5. Right-click and select Generate IDs.

    In the Attributes panel, the id attribute has a unique value beside it.

  6. Click Check in.

The element can now be inserted as a conref into another topic.