Xuse User Guide: Glossary

The glossary.xml file contains the project glossary. The glossary entries may either represent abbreviations or common words that are pertinent to the project. Glossary entries are not directly referenced elsewhere in the XML files of a Xuse project - rather the HTML generation auto links to glossary terms when they are detected within a passage of text. Because of this powerful feature you can automatically link existing text to a new glossary entry should the term prove unfamiliar to your readership.

An Example XML based glossary file is shown below:

Before examining the different parts of the XML structure in detail it is worth visualising the transformed HTML result:

Note: in this example you can see the auto linking between text and items in the project glossary. The text HTML in the glossary entry for SSL has auto linked with the HTML glossary entry.