glossentry

The <glossentry> element defines a single sense of a glossary term. The expected book processing is to sort and group the glossary entries based on the localized term so a back-of-the-book glossary can contain a collated list of terms with the definitions of the senses of the terms indented under the terms. The glossary can have a different organization in different languages depending on the translation of the terms. One possible online processing is to associate a hotspot for mentions of terms in <term> elements and display the definition on hover or click. Glossary entries for different term senses can be reused independently of one another.

Example

<glossentry id="ddl">
    <glossterm>Data Definition Language</glossterm>
    <glossdef>A formal language used for defining database schemas....</glossdef>
</glossentry>

Contains

Doctype Content model
ditabase, glossary ( ( glossterm) then ( glossdef) then ( related-links) (optional) then ( no-topic-nesting) (any number) )

Contained by

Doctype Parents
ditabase dita, topic, concept, task, reference

Inheritance:

- topic/topic concept/concept glossentry/glossentry

Attributes

Name Description Data Type Default Value Required?
id This ID enables topics to be referenced uniquely by topicrefs in DITA maps. ID Yes
conref This attribute is used to reference an ID on a topic that can be reused. See The conref attribute for examples and details about the syntax. CDATA #IMPLIED No
xmlns:ditaarch Declares the default DITA namespace. CDATA #FIXED http://dita.oasis-open.org/architecture/2005/  
DITAArchVersion Designates the version of the architecture that is in use. CDATA "1.1" (version dependent; will increase) No
domains Indicates the specialized domains that are included in the DTD or Schema. CDATA (topic ui-d) (topic hi-d) (topic pr-d) (topic sw-d) (topic ut-d) (topic indexing-d) No
%select-atts; (props, base, platform, product, audience, otherprops, importance, rev, status) A set of related attributes, described at %select-atts; parameter entity PE not applicable Not applicable
%localization-atts; (translate, xml:lang, dir) A set of related attributes, described at %localization-atts;. parameter entity PE not applicable Not applicable
%global-atts; (xtrf, xtrc) A set of related attributes, described at %global-atts; parameter entity PE not applicable Not applicable
class, outputclass Common attributes described in Other common DITA attributes.      

Return to main page.

OASIS DITA Language Specification v1.1 -- Committee Draft 13 February 2007
Copyright © OASIS Open 2005, 2007. All Rights Reserved.