abbreviated-form

Darwin Information Typing Architecture (DITA) Version 1.2

The <abbreviated-form> element represents a reference to a term that may appear in an abbreviated form (often an acronym). The long and short forms of the term are generally defined in a <glossentry> topic. Processors should display the referenced term when rendering an <abbreviated-form> element.

Rendering <abbreviated-form> references to glossentry

When the writer provides a keyref to a glossentry topic that contains a <glossSurfaceForm> element, a process should emit the surface form in introductory contexts where the term might be unfamiliar to the reader or in other contexts where a precise term is appropriate. In other contexts a process should submit the abbreviated form of the term. Note that the definition of an introductory context will differ for every deliverable format.

For instance, a process composing a book deliverable may emit the surface form of a term on the first reference to the glossentry topic within the book or for every reference within a copyright or a warranty-related warning. A process generating an online page may emit the surface form as a hover tooltip on every instance of the term.

Renderers should follow these rules when displaying an <abbreviated-form> element that refers to a glossentry topic:
  1. In an introductory context, processors SHOULD render the surface form of the term by displaying the contents of the glossSurfaceForm element from the referenced glossentry topic.
  2. If the glossentry topic does not contain a glossSurfaceForm element or the glossSurfaceForm element is empty, processors SHOULD render the contents of the glossterm element in introductory contexts.
  3. In non-introductory contexts, processors SHOULD render the abbreviated form of the term by displaying the contents of the <glossAcronym> element from the referenced glossentry topic.
  4. If the glossentry topic does not contain a glossAcronym element or the glossAcronym element is empty, processors SHOULD render the contents of the glossterm element in non-introductory contexts.

For instance, if the topic with the keyref to the "abs" key provided the first occurrence of the ABS term within a book, the sentence could be rendered as follows:

"The Anti-lock Brake System (ABS) will prevent the car from skidding in adverse weather conditions."

If the ABS term had appeared previously within the book, the same sentence could instead be rendered as follows:

"The ABS will prevent the car from skidding in adverse weather conditions."

Rendering <abbreviated-form> references to other topics

Typically the <abbreviated-form> is used to refer to a glossentry topic. In situations where it refers to another topic type, renderers should display the content of the referenced topic's title.

Contains

Note: These models represent only the default document types distributed by OASIS. Actual content models will differ with each new document type.
Doctype Content model
topic (technical content), map (technical content), concept, ditabase, glossary, glossentry, glossgroup, reference, task, bookmap no content

Contained by

Doctype Content model
topic (technical content), concept data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
map (technical content) data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, index-see, index-see-also, index-sort-as, b, u, i, tt, sup, sub, coords, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
ditabase data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, glossterm, glossdef, glossAbbreviation, glossAcronym, glossShortForm, glossSynonym, glossProperty, glossSurfaceForm, glossUsage, glossScopeNote, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
glossary, glossentry, glossgroup data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, glossterm, glossdef, glossAbbreviation, glossAcronym, glossShortForm, glossSynonym, glossProperty, glossSurfaceForm, glossUsage, glossScopeNote, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
reference data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, refsyn, proptypehd, propvaluehd, propdeschd, proptype, propvalue, propdesc, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
task (strict), task (general) data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, searchtitle, abstract, bodydiv, section, sectiondiv, example, linktext, linkinfo, prereq, context, steps-informal, stepsection, cmd, info, tutorialinfo, stepxmp, choice, choptionhd, chdeschd, choption, chdesc, stepresult, result, postreq, b, u, i, tt, sup, sub, coords, index-see, index-see-also, index-sort-as, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput
bookmap data, title, navtitle, shortdesc, desc, p, note, lq, q, sli, li, itemgroup, dthd, ddhd, dt, dd, figgroup, pre, lines, ph, alt, stentry, draft-comment, fn, indexterm, index-base, cite, xref, entry, author, source, publisher, copyrholder, category, prodname, brand, series, platform, prognum, featnum, component, linktext, searchtitle, person, organization, summary, printlocation, bookpartno, booknumber, booklibrary, mainbooktitle, booktitlealt, index-see, index-see-also, index-sort-as, organizationname, otherinfo, addressdetails, locality, localityname, administrativearea, thoroughfare, emailaddress, url, b, u, i, tt, sup, sub, coords, typeofhazard, consequence, howtoavoid, uicontrol, screen, codeph, codeblock, var, oper, delim, sep, pt, pd, fragref, synnote, repsep, msgph, msgblock, filepath, userinput, systemoutput

Inheritance

+ topic/term abbrev-d/abbreviated-form

Example

The term and acronym may be defined as follows, in a glossentry topic. Note that the id of the topic does not need to match the term or acronym.

<glossentry id="abs-definition">
  <glossterm>Anti-lock Braking System</glossterm>
  <glossBody>
    <glossSurfaceForm>Anti-lock Braking System (ABS)</glossSurfaceForm>
    <glossAlt>
      <glossAcronym>ABS</glossAcronym>
    </glossAlt>
  </glossBody>
</glossentry>

Note that there are three important elements for the purposes of rendering the <abbreviated-form> element.

  • The glossSurfaceForm element defines the term as it should be displayed in an introductory context.
  • The glossAcronym element defines the acronym associated with this term.
  • The glossterm element provides a fallback version of the term, which will be displayed in situations where the preferred representation is unavailable.

The glossentry topic will be added to a map in the following manner. Again, the key (in this case "abs") does not need to match the term or acronym value.

<glossref keys="abs" href="antilock.dita"/>

An author that wishes to reference this topic may do so using the abbreviated-form element. The keyref attribute should reference the value defined on the keys attribute above.

<section>An <abbreviated-form keyref="abs"/> helps a
driver to stop. For this reason many find an
<abbreviated-form keyref="abs"/> useful.
</section>
When rendered, the introductory usage of "abs" will display the surface form of the referenced term, while the later uses will display the acronym, as demonstrated here.
An Anti-lock Braking System (ABS) helps a driver to stop. For this reason many find an ABS useful.

Attributes

Name Description Data Type Default Value Required?
keyref The keyref attribute on <abbreviated-form> is used to reference a term, typically defined in a <glossentry> topic. See The keyref attribute for details about syntax and processing concerns. CDATA #REQUIRED Yes
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) A set of related attributes, described in univ-atts attribute group      
global-atts attribute group (xtrf, xtrc) A set of related attributes, described in global-atts attribute group      
class, outputclass Common attributes described in Other common DITA attributes