How can I use other topic types as referable-content topics?

You can use other topic types like task as referable-content topics and have them appear in the Referable-Content view.

Description

The referable-content topic type is an MadCap Software specialization. Due to a limitation in third-party publishing engines, topic types need to be used as conrefs. For example, use the generic topic type as well as specific task topics that have an @outputclass value of "reusable" on their <taskbody> element. Some existing indexes need to be modified to be able to use the topics as referable-content.

Solution

Note: If you do not plan to use the referable-content topic type, you can delete or comment out the lines for rcbody shown in the following code samples.
  1. Edit the Index Definition file.
    CAUTION: Be careful when editing the Index Definition document. Changes can significantly affect the indexing process, and any errors in the document can lead to data corruption or other errors. Consult with IXIA CCMS Customer Support before making changes if you are unsure.
  2. Add the following two lines in bold to the reusable_element_id index:
    <index NAME="reusable_element_id">
       <stringindex KEEPEXTRACTEDVALUES="True">
          <elements>
             <element DEPTH="INFINITE" XPATH="//rcbody//*[@id]/@id"/>
           <element DEPTH="INFINITE" XPATH="//body//*[@id]/@id"/>
             <element DEPTH="INFINITE" XPATH="//taskbody[@outputclass='reusable']//*[@id]/@id"/>
          </elements>
       </stringindex>
    </index>
  3. Add the following two lines in bold to the reusable_element_name index:
    <index NAME="reusable_element_name"> 
       <stringindex KEEPEXTRACTEDVALUES="True">
          <elements>
             <element DEPTH="INFINITE" XPATH="for $e in (//rcbody//*[@id]) return local-name($e)"/>
             <element DEPTH="INFINITE" XPATH="for $e in (//body//*[@id]) return local-name($e)"/>
             <element DEPTH="INFINITE" XPATH="for $e in (//taskbody[@outputclass='reusable']//*[@id]) return local-name($e)"/>
          </elements>
       </stringindex>
    </index>
  4. Add the following two lines in bold to the reusable_fulltext index:
    <index NAME="reusable_fulltext">
       <!-- System index required by the DITA CMS -->
       <admindescription>Fulltext index on the documents</admindescription>
       <wordindex>
          <elements>
             <element DEPTH="INFINITE" XPATH="//rcbody//*"/>
             <element DEPTH="INFINITE" XPATH="//body//*"/>
             <element DEPTH="INFINITE" XPATH="//taskbody[@outputclass='reusable']//*"/>
          </elements>
       </wordindex>
    </index>
  5. Add the following two lines in bold to the reusable_units index:
    <unit NAME="reusable_units">
       <unitelements>
          <unitelement XPATH="//rcbody//*[@id]"/>
          <unitelement XPATH="//body//*[@id]"/>
          <unitelement XPATH="//taskbody//*[@id]"/>
       </unitelements>
    </unit>
  6. Save and check in the Index Definition file.
  7. Edit the system/conf/xpathforids.xml file and add the following two lines in bold:
    <xpath value="//rcbody//*"/>
    <xpath value="//body//*"/>
    <xpath value="//taskbody[@outputclass='reusable']//*"/>
    Note: These two lines ensure that the IXIA CCMS automatically adds an @id value to any elements in the <body> element of a <topic> or in the <taskbody> of a <task> where the <taskbody> has an @outputclass value of "reusable". Without an @id value, the element cannot be used as a conref and does not appear in the Referable-Content view.
  8. Save and check in the xpathforids.xml file.
  9. When the indexing is complete, restart your IXIA CCMS Desktop.