termdef
termdef — An inline definition of a term.
Synopsis
termdef ::= ![[-]](figs/web/nav/down.gif)
![[+]](figs/web/nav/right.gif)
- Zero or more of:
- text
- Bibliography inlines
- Graphic inlines
- Indexing inlines
- Linking inlines
- Markup inlines
- Math inlines
- Product inlines
- Publishing inlines
abbrevacronymcorefdateemphasis(db.emphasis)firstterm(db._firstterm)firstterm(db.firstterm)footnotefootnoterefforeignphrase(db.foreignphrase)glossterm(db._glossterm)glossterm(db.glossterm)phrase(db.phrase)quote(db.quote)subscriptsuperscriptwordasword
- Technical inlines
- Ubiquitous inlines
abbrevacronymaltanchorbibliorefcorefdateemphasis(db._emphasis)firstterm(db._firstterm)footnotefootnoterefforeignphrase(db._foreignphrase)glossterm(db._glossterm)indexterm(db.indexterm.endofrange)indexterm(db.indexterm.singular)indexterm(db.indexterm.startofrange)inlinemediaobjectlinkolinkphrase(db._phrase)quote(db._quote)remarksubscriptsuperscripttrademarkwordaswordxref
Attributes
Additional Constraints
- A termdef must contain exactly one firstterm
Description
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.
Processing expectations
Formatted inline.
Attributes
Common attributes and common linking attributes.
- baseform
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.
- sortas
Specifies the string by which the element's content is to be sorted; if unspecified, the content is used
Parents
These elements contain termdef: bridgehead, citation, citetitle, emphasis (db.emphasis), entry, firstterm (db.firstterm), glosssee, glossseealso, glossterm (db.glossterm), line, link, literallayout, member, olink, orgdiv, para, phrase (db.phrase), primary, quote (db.quote), remark, secondary, see, seealso, simpara, subtitle, term, termdef, tertiary, title, titleabbrev.
Children
The following elements occur in termdef: text, abbrev, acronym, alt, anchor, author, biblioref, citation, citebiblioid, citetitle, coref, date, editor, email, emphasis (db._emphasis), emphasis (db.emphasis), firstterm (db._firstterm), firstterm (db.firstterm), footnote, footnoteref, foreignphrase (db._foreignphrase), foreignphrase (db.foreignphrase), glossterm (db._glossterm), glossterm (db.glossterm), indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), inlineequation, inlinemediaobject, jobtitle, link, literal, olink, optional, org, orgname, person, personname, phrase (db._phrase), phrase (db.phrase), productname, productnumber, quote (db._quote), quote (db.quote), remark, subscript, superscript, termdef, trademark, uri, wordasword, xref.
Examples
<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>
This paragraph contains an inline term definition. [Definition: A software module called an XML processor is used to read XML documents and provide access to their content and structure.] The definition comes from the XML Recommendation.