termdef — An inline definition of a term
termdef ::= (text | Bibliography inlines | Error inlines | Graphic inlines | GUI inlines | Indexing inlines | Keyboard inlines | Linking inlines | Markup inlines | Math inlines | Object-oriented programming inlines | Operating system inlines | Product inlines | Programming inlines | Publishing inlines | Technical inlines | Ubiquitous inlines)*
Common attributes and common linking attributes.
Additional attributes:
baseform
sortas
A termdef
is an inline term definition. Some
styles of documentation collect all terms together in a
glossary
of some sort, but another style is to place
the definitions inline.
The glossary
and glosslist
elements support the former style, termdef
the
latter.
Every term should have an xml:id
attribute to uniquely identify it.
The content of the termdef
is the definition of the
term. Often it is valuable to word the definition so that it will stand
alone, in case it becomes useful to extract all the terms into a
separate glossary in addition to having them defined inline.
Every termdef
must contain exactly one
firstterm
. The firstterm
identifies the actual
term defined by the termdef
.
Common attributes and common linking attributes.
Specifies the base form of the term, the one that appears in the glossary. This allows adjectival, plural, and other variations of the term to appear in the element. The element content is the default base form.
Specifies the string by which the element’s content is to be sorted; if unspecified, the content is used.
<article xmlns="http://docbook.org/ns/docbook" xmlns:xlink='http://www.w3.org/1999/xlink'> <title>termdef</title> <para> This paragraph contains an inline term definition. <termdef xml:id="dt-xml-processor">A software module called an <firstterm>XML processor</firstterm> is used to read XML documents and provide access to their content and structure.</termdef> The definition comes from <link xlink:href="http://www.w3.org/TR/REC-xml">the XML Recommendation</link>. </para> </article>