"Ruby" is the term used for short runs of text alongside the base text, typically used in East Asian documents to indicate pronunciation, or to provide a short annotation.
The Z39.98 ITS Ruby Feature defines ITS 1.0 Ruby as a feature for use in Z39.98-AI profiles. Note that this feature only supports the LOCAL Ruby type, as defined in ITS 1.0.
This feature is maintained by the ANSI/NISO Z39.98 advisory committee under the auspices of NISO.
The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this section are to be interpreted as described in RFC2119.
This resource directory represents version
1.0 of the ITS Ruby feature:
This release may not be the most recently published (current) version of the ITS Ruby feature. The current version should always be obtained from the static URI: http://www.daisy.org/z3998/2012/auth/features/its-ruby/current/
This feature must be identified as
its-ruby in Z39.98-AI document feature declarations.
The canonical identity URI is:
http://www.daisy.org/z3998/2012/auth/features/its-ruby/1.0/
This version of the feature is compliant with the Z39.98-2012 Specification.
The normative
RelaxNG schema for version
1.0 of the ITS Ruby feature is
z3998-feature-its-ruby.rng.
Note - this feature schema does not represent an entire document model; it is intended for inclusion in host profiles.
This feature makes the following components available for inclusion in host profiles:
This section defines processing agent behaviors that extend the default behaviors defined in Processing agent conformance definition.
If a processing agent
supports this feature, it must process encountered
its:ruby elements as defined in
ITS 1.0 Ruby.
(Implementors should note that ITS 1.0 Ruby explictly inherits all fundamental traits of ruby markup from Ruby Annotation).
If a processing agent recognizes but does not support this feature, it must employ one of the following behaviors:
Upon encountering a document instance with this feature enabled, the processing agent issues a notification, and then aborts the processing.
While traversing the document tree and encountering an
its:ruby element, the processing agent
ignores any
its:rt,
its:rp.
its:rbc and
its:rtc descendants, and processes only the content of
its:rb descendant elements.
The processing agent discards the elements and attributes contributed by this feature:
its:ruby element is replaced by the content of its
its:rb descendants.
The
abort behavior is the default; the
ignore and
discard behaviors must only be employed when the processing agent is explicitly instructed to do so by the client.
Processing agents that employ the
ignore or
discard behaviors should issue a notification.
If a processing agent does not recognize this feature, it must, as dictated in Processing agent conformance definition, abort processing and issue an error message.
The component definitions provided below follow the conventions used in Core Modules.
Provides support for Ruby Annotation markup as defined in the W3C Internationalization Tag Set (ITS) Version 1.0.
| Name | Default attribute model | Default content model | Default usage context |
|---|---|---|---|
ruby
|
Phrase.attrib
|
(
its:rb, (
its:rt | (
its:rp,
its:rt,
its:rp))) | (
its:rbc,
its:rtc,
its:rtc?)
|
Text.class
|
rb
|
Phrase.attrib
|
(text |
Text.class |
Phrase.class)+
|
its:ruby
and
its:rbc
|
rt
|
Phrase.attrib,
rbspan?
|
(text |
Text.class |
Phrase.class)+
|
its:ruby
and
its:rtc
|
rbc
|
Phrase.attrib
|
its:rb)+
|
its:ruby
|
rtc
|
Phrase.attrib
|
its:rt+
|
its:ruby
|
rp
|
Phrase.attrib
|
text
|
its:ruby
|
| Name | Default values | Default usage context |
|---|---|---|
rbspan
|
nonNegativeInteger
|
its:rt
|
| Name | Definition | Content |
|---|---|---|
ruby.simple
|
Simple ruby markup. |
its:rb, (
its:rt | (
its:rp,
its:rt,
its:rp))
|
ruby.complex
|
Complex ruby markup. |
its:rbc,
its:rtc,
its:rtc?
|
its:ruby element
The container for ruby markup declarations.
The
its:ruby element contains either
simple or
complex ruby markup.
Refer to ITS Ruby for further information.
| Local name |
ruby
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
Text.class
|
| Default attribute model |
Phrase.attrib
|
| Default content model |
(
its:rb, (
its:rt | (
its:rp,
its:rt,
its:rp))) | (
its:rbc,
its:rtc,
its:rtc?)
|
| Optionality | This element must not be omitted when activating this module. |
its:ruby element: Examples
its:ruby element: Example
<p>この本は <its:ruby>
<its:rb>慶応義塾大学</its:rb>
<its:rp>(</its:rp><its:rt>けいおうぎじゅくだいがく</its:rt><its:rp>)</its:rp>
</its:ruby>の歴史を説明するものです。</p>
its:rb element
Contains the base text.
Refer to ITS Ruby for further information.
| Local name |
rb
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
its:ruby
and
its:rbc
|
| Default attribute model |
Phrase.attrib
|
| Default content model |
(text |
Text.class |
Phrase.class)+
|
| Optionality | This element must not be omitted when activating this module. |
The following model restrictions apply to this element:
The
its:rb element must not contain
its:ruby descendants.
its:rt element
Contains the ruby text.
Refer to ITS Ruby for further information.
| Local name |
rt
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
its:ruby
and
its:rtc
|
| Default attribute model |
Phrase.attrib,
rbspan?
|
| Default content model |
(text |
Text.class |
Phrase.class)+
|
| Optionality | This element must not be omitted when activating this module. |
The following model restrictions apply to this element:
The
its:rt element must not contain
its:ruby descendants.
its:rbc element
Container for
its:rb elements in
complex ruby markup.
Refer to ITS Ruby for further information.
| Local name |
rbc
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
its:ruby
|
| Default attribute model |
Phrase.attrib
|
| Default content model |
its:rb)+
|
| Optionality | This element must not be omitted when activating this module. |
its:rtc element
Container for
its:rt elements in
complex ruby markup.
Refer to ITS Ruby for further information.
| Local name |
rtc
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
its:ruby
|
| Default attribute model |
Phrase.attrib
|
| Default content model |
its:rt+
|
| Optionality | This element must not be omitted when activating this module. |
its:rp element
Ruby text beginning and end marker
This element is used in the case of simple ruby markup to specify characters that denote the beginning and end of ruby text when user agents do not have other ways to present ruby text distinctively from the base text.
Refer to ITS Ruby for further information.
| Local name |
rp
|
|---|---|
| Namespace |
http://www.w3.org/2005/11/its
|
| Default usage context |
its:ruby
|
| Default attribute model |
Phrase.attrib
|
| Default content model |
text
|
| Optionality | This element must not be omitted when activating this module. |
rbspan attribute
Allows an
its:rt element to span multiple
its:rb elements in
complex ruby markup.
If omitted, the implicit value
1 is assumed..
Refer to ITS Ruby for further information.
| Local name |
rbspan
|
|---|---|
| Namespace | None |
| Default usage context |
its:rt
|
| Default value(s) |
nonNegativeInteger
|
| Optionality | This attribute must not be omitted when activating this module. |
The following model restrictions apply to this attribute:
The
rbspan attribute must not be used on the
its:rt element in simple ruby markup.
| Schema | Language |
|---|---|
| z3998-feature-its-ruby.rng | RelaxNG |
Activation of this module depends on the datatypes and global-classes modules also being activated.
Refer to the Z39.98-AI community portal for information on available software tools.
The below list represents the modules at the time of version 1.0 of this feature.
The occurrence of the keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in documentation fields embedded in these modules are to be interpreted as described in RFC2119.