Schema Documentation - DIAGRAM Description Profile
version 1.0

The abbr element

On this page:

The abbr element represents the abbreviated form of a phrase, term or name.

The role attribute optionally expresses whether the type of abbreviation.

The expansion and name elements provide a mechanism for associating an abbreviation with its uncontracted form. When including an expansion, the ref attribute on the abbr element links the abbreviation to an expansion or name.

The ref attribute can also be used to reference a definition element when an explanatory definition of the abbreviation is also needed.

Usage Example

        
<head>
    …
    <expansion xml:id="rn">Royal Navy</expansion>
</head>    
<body>       
    …
    <p> … a ten-gun brig, under the command of Captain Fitz Roy, 
        <abbr ref="rn">R.N.</abbr>, sailed from Devonport … </p>
    …  
</body>

Allowed parents

annoref, annotation (block variant), annotation (phrase variant), m:annotation-xml, aside, block, caption, citation (block variant), citation (phrase variant), d, definition, description (block variant), description (phrase variant), emph, expansion, h, hd, hpart, item, ln, d:longdesc, meta, name, note (block variant), note (phrase variant), noteref, object (block variant), object (phrase variant), p, ssml:phoneme, ssml:prosody, quote (block variant), quote (phrase variant), its:rb, ref, its:rt, s, ssml:say-as (phrase variant), ssml:say-as (text variant), d:simplifiedLanguageDescription, span, ssml:sub, d:summary, td, term, th and d:tour

Allowed children

This element may contain text.

This element may contain the following children: ssml:break, char, emph, object, pagebreak, ssml:phoneme, ssml:prosody, its:ruby, ssml:say-as, span, sub, ssml:sub, sup and ssml:token

Content model and additional requirements

optional attributes: @about, @by, @class, @content, @datatype, @desc, @its:dir, @its:translate, @property, @ref, @rel, @resource, @rev, @role, @ssml:onlangfailure, @typeof, @xml:base, @xml:id, @xml:lang and @xml:space
optionally the following 2 co-ocurring attributes: @ssml:alphabet and @ssml:ph
one or more of
a choice of
either one of the 14 elements: char, emph, its:ruby, object, pagebreak, span, ssml:break, ssml:phoneme, ssml:prosody, ssml:say-as, ssml:sub, ssml:token, sub or sup
or text
end of choice
Note that in addition to restrictions presented in the content model above, use of this element must also respect the following requirements:
  • The ref attribute on an abbr element must resolve to an expansion, name or definition element.
  • The abbr element must neither be empty nor contain only whitespace.
Such requirements take precedence over any conflicting statements in the content model or in the lists above of allowed children and parents.

Namespace

http://www.daisy.org/ns/z3998/authoring/