Skip to content

Commit bbe2ee5

Browse files
Update Outline and Structure sections about glossaries (#269)
* Update Outline and Structure sections about glossaries * Update Structure with glossary sorting * Update xml/docu_styleguide.structure.xml Co-authored-by: Tom Schraitle <[email protected]> --------- Co-authored-by: Tom Schraitle <[email protected]>
1 parent 3da462a commit bbe2ee5

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

xml/docu_styleguide.outline.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -260,7 +260,8 @@
260260
<listitem>
261261
<para>
262262
The optional glossary contains important terms in alphabetical order and
263-
provides a brief explanation for each.
263+
provides a brief explanation for each. For more information on creating lists
264+
of terms, see <xref linkend="sec-glossary"/>.
264265
</para>
265266
</listitem>
266267
</varlistentry>

xml/docu_styleguide.structure.xml

+8-3
Original file line numberDiff line numberDiff line change
@@ -1412,12 +1412,17 @@ will be displayed in &lt;emphasis role="bold"&gt;bold&lt;/emphasis&gt;</screen>
14121412
unfamiliar terms and special jargon.
14131413
</para>
14141414
<para>
1415-
Define infinitive forms of verbs and singular nouns. Use lowercase for
1416-
the term unless it is a proper noun.
1415+
Define infinitive forms of verbs and singular nouns. Do not start the definition with the term itself.
1416+
Use lowercase for the term unless it is a proper noun.
14171417
</para>
1418+
<para>Where applicable, group your terms with the <tag class="emptytag">glossdiv</tag>
1419+
tag for higher ordering.</para>
1420+
<para>To support automatic alphabetical ordering in localized versions,
1421+
use <tag>glosslist</tag> and set the style sheet parameter
1422+
<literal>glossary.sort</literal> to 1. This sorts glossary lists in alphabetical order.</para>
14181423
<para>
14191424
Use cross-references to link acronyms with their written out forms.
1420-
Define the written out form. Use a <emphasis>See</emphasis> reference for
1425+
Define the written out form. Use a <emphasis>See also</emphasis> reference for
14211426
the acronym form to link it to the defined written out form.
14221427
</para>
14231428
<para>

0 commit comments

Comments
 (0)