DITA Glossary Entry ============================================================= HEADER ============================================================= MODULE: DITA Glossary VERSION: 2.0 DATE: [[[Release date]]] PURPOSE: Define elements and specialization atttributes for Glossary topics ============================================================= ============================================================= PUBLIC DOCUMENT TYPE DEFINITION TYPICAL INVOCATION Refer to this file by the following public identifier or an appropriate system identifier PUBLIC "-//OASIS//ELEMENTS DITA 2.0 Glossary Entry//EN" Delivered as file "glossentry.mod" ============================================================= (C) Copyright OASIS Open 2006, 2019. All Rights Reserved. UPDATES: 2019.03.23 KJE: Modified content models of glossSurfaceForm, glossAcronym, glossSynonym, glossShortForm, and glossAbbreviation ============================================================= topic glossentry -//OASIS//ELEMENTS DITA Glossary Entry//EN -//OASIS//ENTITIES DITA Glossary Entry//EN urn:oasis:names:tc:dita:rng:glossentryMod.rng
ELEMENT TYPE NAME PATTERNS
ELEMENT TYPE DECLARATIONS
LONG NAME: Glossary Entry 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. Category: Glossentry elements
LONG NAME: Glossary Term The <glossterm> element specifies the preferred term associated with a definition of a sense. If the same term has multiple senses, create a separate <glossentry> topic for each sense. Category: Glossentry elements
LONG NAME: Glossary Definition The <glossdef> element specifies the definition of one sense of a term. If a term has multiple senses, create a separate <glossentry> topic to define each sense. Category: Glossentry elements
LONG NAME: Glossary Body The <glossbody> element is used to provide details about a glossary term (such as part of speech or additional forms of the term).
LONG NAME: Glossary Abbreviation The <glossAbbreviation> element provides an abbreviated form of the term contained in a <glossterm> element.
LONG NAME: Glossary Acronym The <glossAcronym> element defines an acronym as an alternate form for the term defined in the <glossterm> element.
LONG NAME: Glossary Short Form The <glossShortForm> element provides a shorter alternative to the primary term specified in the <glossterm> element.
LONG NAME: Glossary Synonym Provides a term that is a synonym of the primary value in the <glossterm> element.
LONG NAME: Part of Speech Identifies the part of speech for the preferred and alternate terms. Alternate terms must have the same part of speech as the preferred term because all terms in the glossentry topic designate the same subject. If the part of speech isn't specified, the default is a noun for the standard enumeration.
LONG NAME: Glossary Status Identifies the usage status of a preferred or alternate term. If the status isn't specified, the <glossterm> provides a preferred term and an alternate term provides an allowed term.
LONG NAME: Glossary Status The <glossProperty> element is an extension point which allows additional details about the preferred term or its subject.
LONG NAME: Glossary Surface Form The <glossSurfaceForm> element specifies an unambiguous presentation of the <glossterm> that may combine multiple forms. The surface form is suitable to introduce the term in new contexts.
LONG NAME: Glossary Usage attention caution danger fastpath important note notice other remember restriction tip warning -dita-use-conref-target The <glossUsage> element provides information about the correct use of a term, such as where or how it can be used.
LONG NAME: Glossary Scope Note attention caution danger fastpath important note notice other remember restriction tip warning -dita-use-conref-target A clarification of the subject designated by the <glossterm> such as examples of included or excluded companies or products. For instance, a scope note for "Linux" might explain that the term doesn't apply to UNIX products and give some examples of Linux products that are included as well as UNIX products that are excluded.
LONG NAME: Glossary Symbol external local peer -dita-use-conref-target yes no -dita-use-conref-target break inline -dita-use-conref-target The <glossSymbol> element identifies a standard image associated with the subject of the <glossterm>.
LONG NAME: Glossary Alternate Form The <glossAlt> element contains a variant term for the preferred term. The variant should have the same meaning as the term in the <glossterm> element; the variant is simply another way to refer to the same term. There may be many ways to refer to a term; each variant is placed in its own <glossAlt> element.
LONG NAME: Glossary - Alternate For external local peer -dita-use-conref-target The <glossAlternateFor> element indicates when a variant term has a relationship to another variant term as well as to the preferred term.
SPECIALIZATION ATTRIBUTE DECLARATIONS