Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add correct glossary example #271

Merged
merged 1 commit into from
Oct 23, 2023
Merged

Add correct glossary example #271

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 30 additions & 19 deletions xml/docu_styleguide.structure.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1426,26 +1426,37 @@ will be displayed in &lt;emphasis role="bold"&gt;bold&lt;/emphasis&gt;</screen>
</para>
<example xml:id="ex-glossary">
<title>A typical example of a glossary</title>
<screen>&lt;glossary&gt;
&lt;title&gt;Glossary&lt;/title&gt;
&lt;glossentry&gt;
&lt;glossterm xml:id="gt-extensible"&gt;Extensible Markup Language&lt;/glossterm&gt;
&lt;glossdef&gt;
&lt;para&gt;
A markup language that defines a set of rules for encoding documents in a
format that is both human-readable and machine-readable.
&lt;/para&gt;
&lt;/glossdef&gt;
&lt;/glossentry&gt;
&lt;glossentry&gt;
&lt;glossterm&gt;XML&lt;/glossterm&gt;
&lt;glossdef&gt;
&lt;para&gt;
See also &lt;xref linkend="gt-extensible"/&gt;.
&lt;/para&gt;
&lt;/glossdef&gt;
&lt;/glossentry&gt;
<screen>&lt;glossary xmlns="http://docbook.org/ns/docbook" version="5.2"&gt;
&lt;title&gt;Glossary&lt;/title&gt;

&lt;glossentry xml:id="gt-docbook"&gt;
&lt;glossterm&gt;DocBook&lt;/glossterm&gt;
&lt;glossdef&gt;&lt;para&gt;...&lt;/para&gt;&lt;/glossdef&gt;
&lt;/glossentry&gt;

&lt;glossentry xml:id="gt-svg"&gt;
&lt;glossterm&gt;SVG&lt;/glossterm&gt;
&lt;glossdef&gt;&lt;para&gt;...&lt;/para&gt;&lt;/glossdef&gt;
&lt;/glossentry&gt;

&lt;glossentry xml:id="gt-extensible-markup-language"&gt;
&lt;glossterm&gt;Extensible Markup Language&lt;/glossterm&gt;
&lt;glossdef&gt;
&lt;para&gt; A markup language that defines a set of rules for encoding
documents in a format that is both human-readable and
machine-readable. &lt;/para&gt;
&lt;glossseealso linkend="gt-docbook"/&gt;
&lt;glossseealso linkend="gt-svg"&gt;SVG (Scalable Vector Graphics)&lt;/glossseealso&gt;
&lt;/glossdef&gt;
&lt;/glossentry&gt;

&lt;glossentry xml:id="gt-xml"&gt;
&lt;glossterm&gt;XML&lt;/glossterm&gt;
&lt;glosssee linkend="gt-extensible-markup-language" /&gt;
&lt;/glossentry&gt;

&lt;/glossary&gt;</screen>

</example>
</sect2>

Expand Down