The ruby element

On this page:

Possible children

This element can not contain text. It may contain the following children: its:rb, its:rbc, its:rp, its:rt and its:rtc.

Possible parents

abbr, annotation, m:annotation-xml, aside, aside, bridgehead, caption, code, code, d, date, dd, dt, emph, xforms:group, h, identifier, l, l, xforms:label, label, li, li, lnum, meta, name, note, noteref, sel:otherwise, p, place, ssml:prosody, quote, quote, its:rb, xforms:repeat, its:rt, s, span, sub, sup, td, term, th, title, title, titlepart, ssml:token, w and sel:when

Content model

choice
group
group
its:rbc its:rtc
[optional] Optional:

Namespace

http://www.w3.org/2005/11/its

This element belongs to the feature «ITS Ruby»

Attributes

Name Presence Description
about Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value:

One of

• value(s) of type anyURI
• value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
class Optional The Z39.86 class attribute inherits all fundamental properties of the XHTML class attribute. It is used for arbitrary grouping or classification of elements, usable for example in the context of CSS styling.
The class attribute is not used to inflect semantics on the content of elements.
Value: Some value of type NMTOKENS
content Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: Any string
datatype Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: Some value of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
href Optional The value of the Z39.86 href attribute is a URI specifying a document-internal or -external target.
Value: Some value of type anyURI
property Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
rel Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
resource Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value:

One of

• value(s) of type anyURI
• value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
rev Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
role Optional The role attribute allows the author to annotate elements with machine-extractable semantic information about the nature or purpose of an element.
The value of the role attribute is one or several CURIEs.
Consult XHTML Role Attribute Module for further information.
Value:

One of

• A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
abbreviationsList
acknowledgments
afterword
appendix
artwork
bibliography
biblioref
biographicalNote
colophon
conclusion
contributorsList
dedication
diaryEntry
endnotes
epigraph
epilogue
errata
foreword
glossary
grantAcknowledgment
halftitlepage
help
imprimatur
imprint
index
introduction
keyterm
letter
otherCredits
poem
promotionalCopy
publisherAddress
publisherLogo
section
timeline
titlepage
translatorNote
targetlang Co-dependant on href The targetlang attribute specifies the language(s) of the resource designated by the href attribute.
Value: Any string
targetrole Co-dependant on href The targetrole attribute specifies the role(s) of the resource designated by the href attribute.
Value: A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
targettype Co-dependant on href The targettype attribute specifies the media type of the resource designated by the href attribute.
Value: Any string
typeof Optional This attribute is part of the RDF/a metadata attributes collection. For more information on the usage of RDF/a, consult the W3C RDF/a primer.
Value: A white space separated list of one or more value(s) of type string satisfying
• the pattern "(([\i-[:]][\c-[:]]*)?:)?.+"
• a minimum length of 1
its:dir Optional The its:dir attribute is used to specify the base writing direction of the content. If not specified, the default value ltr is assumed.
Consult Internationalization Tag Set (ITS) for further information.
This attribute belongs to the feature «ITS Ruby»
Value:

One of

lro
ltr
rlo
rtl
its:translate Optional The its:translate attribute expresses information about whether the content of an element should be translated or not.
If not specified, the default value "yes" is assumed.
Consult Internationalization Tag Set (ITS) for further information.
This attribute belongs to the feature «ITS Ruby»
Value:

One of

no
yes
rend:rend Optional

The Rendition (rend) attribute provides a means to indicate how the text within element in question was rendered or presented in the source text.

The value is a limited set of single CSS properties, provided primarily to allow efficient Braille transcription. For more elaborate expressions of source style capturing, authors must make use of external CSS stylesheets.

The value is inherit by descendants.


This attribute belongs to the feature «Source Rendition»
Value:

One of

font-style: italic
font-weight: bold
text-decoration: underline
ssml:alphabet Co-dependant on ssml:ph The SSML alphabet attribute specifies the phonemic/phonetic pronunciation alphabet to use when rendering the value of the ph attribute. If the alphabet attribute is not specified, the value ipa is assumed.
Consult Speech Synthesis Markup Language (SSML) Version 1.1 for further information.
This attribute belongs to the feature «SSML (Speech Synthesiser Markup Language) Integration»
Value:

One of

text:
ipa
ssml:onlangfailure Optional The onlangfailure attribute describes the desired behavior of a synthesis processor upon language speaking failure.
The value of this attribute is inherited by descendants.
Consult Speech Synthesis Markup Language (SSML) Version 1.1 for further information.
This attribute belongs to the feature «SSML (Speech Synthesiser Markup Language) Integration»
Value:

One of

changevoice
ignorelang
ignoretext
processorchoice
ssml:ph Optional The SSML ph attribute provides a phonemic and phonetic notation for the contained text.
Consult Speech Synthesis Markup Language (SSML) Version 1.1 for further information.
This attribute belongs to the feature «SSML (Speech Synthesiser Markup Language) Integration»
Value: Any string
xml:base Optional The xml:base attribute is used to specify a base URI other than the base URI of the document or external entity.
Consult XML Base for further information.
Value: Some value of type anyURI
xml:id Optional The xml:id attribute specifies a document-wide unique identifier of the element.
Consult xml:id Version 1.0 for further information.
Value: Some value of type ID
xml:lang Optional The xml:lang attribute is used to identify the natural or formal language in which the content is written.
Consult Extensible Markup Language (XML) 1.0 for further information.
Value: Some value of type language
xml:space Optional The xml:space attribute is used to signal an intention that element white space should be preserved by applications.
If not specified, the default value "default" is assumed.
Consult Extensible Markup Language (XML) 1.0 for further information.
Value:

One of

default
preserve
More information about this element can be found at
http://www.w3.org/TR/its/#ruby-annotation