Schema Documentation: the sub element

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

Refer to SSML 1.1 for further information.

Usage Example

        
<p>The great toe, as <ssml:sub alias="professor">Prof.</ssml:sub> Owen remarks, which forms 
    the fulcrum when standing or walking, is perhaps the most characteristic …</p>

Allowed parents

annoref, annotation (block variant), annotation (phrase variant), m:annotation-xml, aside, block, caption, citation (block variant), citation (phrase variant), d, definition, emph, expansion, h, hd, hpart, item, ln, d:longdesc, meta, note (block variant), note (phrase variant), noteref, 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: abbr, annoref, annotation, ssml:break, char, citation, code, d, definition, emph (text variant), emph (phrase variant), expansion, rend:linebreak, ln, m:math, name, note, noteref, num, object (text variant), object (phrase variant), pagebreak, ssml:phoneme (text variant), ssml:phoneme (phrase variant), ssml:prosody (text variant), ssml:prosody (phrase variant), quote, ref, its:ruby, s, ssml:say-as (text variant), ssml:say-as (phrase variant), span (text variant), span (phrase variant), sub, ssml:sub (text variant), ssml:sub (phrase variant), sup, term, time, ssml:token (text variant), ssml:token (phrase variant) and w

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 45 elements: abbr, annoref, annotation, char, citation, code, d, definition, emph, emph, expansion, its:ruby, ln, m:math, name, note, noteref, num, object, object, pagebreak, quote, ref, rend:linebreak, s, span, span, ssml:break, ssml:break, ssml:phoneme, ssml:phoneme, ssml:prosody, ssml:prosody, ssml:say-as, ssml:say-as, ssml:sub, ssml:sub, ssml:token, ssml:token, sub, sup, term, time, w or w

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 text variant.

Namespace

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