Schema Documentation - DIAGRAM Description Profile
version 1.0

The text variant of the sub element

On this page:

Indicates that the text in the alias attribute value replaces the contained text for pronunciation.

Refer to SSML 1.1 for further information.

Allowed parents

abbr, d:about, annoref, annotation (block variant), annotation (phrase variant), m:annotation-xml, aside, block, caption, citation (block variant), citation (phrase variant), code, d, definition, description, emph (phrase variant), emph (text variant), expansion, h, hd, hpart, item, ln (code variant), ln (ln variant), lnum, d:longdesc, meta, name, note (block variant), note (phrase variant), noteref, num, object, p, ssml:phoneme (phrase variant), ssml:phoneme (text variant), ssml:prosody (phrase variant), ssml:prosody (text variant), 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 (phrase variant), span (text variant), sub, ssml:sub (phrase variant), ssml:sub (text variant), d:summary, sup, td, term, th, time, ssml:token (phrase variant), ssml:token (text variant), d:tour, w and wpart

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

required attributes: @alias
optional attributes: @class, @its:dir, @its:translate, @xml:base, @xml:id, @xml:lang and @xml:space
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 ssml:sub 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.

Variants

This element exists in 2 variants. The other variant is the phrase variant.

Namespace

http://www.w3.org/2001/10/synthesis