Glossary Term Linking

In the published document you may want to create interactive cross references between glossary terms used throughout the document and the glossary term in the glossary. This can be achieved using the cite_gloss-term character style, available in eXtyles.

In Word, apply the cite_gloss-term character style to any glossary term in the document that you want linked to its matching glossary entry in the glossary. You do not need to apply the cite_gloss-term character style to the glossary entry itself.

eXtyles Citation Matching will not automatically apply the cite_gloss-term character style. You will need to apply it by hand.

The eXtyles BITS export will then produce <xref> markup around that term with an rid attribute that matches the id attribute on the matching glossary term. For example, a term with cite_gloss-term applied in the middle of a paragraph:

<p>A paragraph with a glossary term that should be linked: <xref ref-type="term" rid="XML_glossary.Term_here"> Term here </xref> in the text. </p>

and the matching term in the glossary:

<term id="XML_glossary.Term_here"> <bold> Term here </bold> </term>

Note the matching id and rid for the glossary term: XML_glossary.Term_here

Importantly:

  • Only those glossary terms that have styled cross references will generate IDs in the XML. If a glossary entry does not have a cross reference no ID will be generated for the <term>.

  • Only cross references that match exactly the text value of the glossary (without any face markup) will generate an ID. So, for the above example, if the cross reference was (see Terms here) no ID would be generated (because the word Terms is plural instead of singular).

  • id/rid attribute values do not support face markup, so if you have T<i>erm</i> and T<b>erm</b>, those would both create <term id="XML_glossary.Term"> (with the markup dropped from the attribute). In that scenario, you would need a different solution for the glossary term linking.