Schema Documentation - DIAGRAM Description Profile
version 1.0

The num element

On this page:

The num element represents a set of Arabic or Roman numerals that taken together indicate a single value or represent a single number in a standardized format.

Examples of numbers include: cardinal and ordinal values, weights, measures, currency values, postal codes, telephone numbers, ISBN numbers, scores and results, etc. Where these values include units of measure or other symbols integral to their understanding, the units and symbols must be included as a part of the num element.

The role attribute optionally expresses the semantic nature of the number. If omitted, the implicit value cardinal is assumed.

If the value of the num element is not in a machine-readable format, the value (num) attribute optionally allows the inclusion of an alternate representation.

The MathML feature is intended for marking proper mathematical statements within documents and should be used in preference over the num element whenever equations, formulae or other formal mathematic constructs or operators are being marked.

The num element must not be used to mark instances of dates and times. Refer to the time element for more information.

Usage details available in the Usage Details section.

Usage Example

At this rate, on the above data, the denudation of the Weald must have 
required <num>306,662,400</num> years;  or say 
<num value="300,000,000">three hundred million</num> years.

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, 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, @rel, @resource, @rev, @role, @ssml:onlangfailure, @typeof, @value, @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 requirement:
  • The num 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/

Usage Details

Following are examples of how the num element can be used to format identifiers and numbers that are not used in mathemtatical contexts:

The span element can further be used to group related sets of numbers: