What would you like to know more about?

Reusing the Same Topic in Multiple Product Spaces

This task provides instructions on how to reuse a topic across multiple product spaces and ensure that links direct to the correct product section by using keys and IDs.

  • You must be an administrator in Heretto.
ACST has a complex set of product offerings with an ever-increasing number of potential product integrations. We're finding that the number of topics being reused across various product spaces (ACS, Go Method, Realm, etc) is increasing exponentially. Frequently, if you reuse the same topic in Realm and ACS, when you try to link to that topic, the portal doesn't know which product space you intend to link to.

For example, I include a topic about the Dymo 550 printer in the PDS, ACS, and Realm product spaces.

In order link to the desired product section, the writer/architect will need to assign keys and id's to the topic in the map you want to reuse.

  1. Dock the map where you plan to reuse a global topic.
  2. Architect the map, adding and chunking topics as desired.
  3. In the global topic that is reused across multiple maps, open the topic attributes.
    CAUTION: Do NOT create keys and ids on the topic that is set aside for global use. Create keys and id's on the topic within your product map. This prevents the keys and id's from being attached to the global topic and allows another writer to create keys and id's for their product.
  4. Add a key and an id. They can be the different and, in fact, in the minimal documentation I've found it does indicate that keys and id's are different. I don't yet understand the purpose. For this example, they are the same. Once we know more, this may get updated. View the ACS map here.
    <topicref href="../../../Global_Equipment/Printer_Dymo/t_equipment_configure_your_printer_settings_on_mac_dymo.dita" keys="acsdymo"/>
  5. To link to this reusable document from another page and ensure that the user lands in the desired product space, open the document containing the link.
  6. If you haven't already, insert a link to the topic.
  7. Click source view and add the following code to your link: id="idyouassigned"> . Sample topic.
    <xref href="printer_Dymo/c_equpment_dymo_labelwriter_450_turbo_printer.dita" id="acsdymo">ACS</xref>
  8. Test your link.
When you click a link using a global topic, it should resolve to the desired product section.