Create a Custom Acronym List
In this tutorial, you'll learn how to create a custom acronym list for your collection.
A common scenario could be the need to create a custom acronym list to use repeatedly in a collection of policies and procedures or in your new software documentation project.
Since setting this up is almost trivial, thanks to the folks at XStandard, you'll go a bit further and create a new "collection specific" style list, where you can define tags that are used in a collection.
Create a new collection specific style list
Follow these steps to create a new style file first:
- Right-click on the button above the editor;
- From the popup menu, select any style list;
- Save the file as styles.collection.xml;
Leave the file open for editing.
Create your custom acronym list
Now edit the file to contain only your acronym list.
- Leave only one group with one style in the file;
- Edit the group title ("Acronyms" in English and "Acronymes" in French);
- Edit the style according to your acronym (see example below);
- Copy this style as many time as you need;
- Edit the copied styles to include all your required acronyms;
The example below create an acronym tag for XML:
<style> <name xml:lang="en">XML</name> <name xml:lang="fr">XML</name> <description xml:lang="en"/> <description xml:lang="fr"/> <elt>acronym</elt> <attr> <name>title</name> <value>Extensible Markup Language</value> </attr> </style>
You can add as many acronym as you want to your new list. This user guide collection defines about half a dozen, for the different web standards used in Tópico. This does not mean that all acronyms in this document are already tagged as such but that it would be far easier to do so!
Assign the acronym tag to some text
To wrap some text with the acronym tag:
- Select the text;
- Click on the button;
- From the popup menu, select the appropriate style list;
- Click on the styles dropdown at the top right of the editor;
- From the drop down menu, select the acronym style you created.