Copyright © 2002 W3C® (MIT, INRIA, Keio), All Rights Reserved. W3C liability, trademark, document use, and software licensing rules apply.
This document proposes a set of CSS properties associated with the 'Ruby' elements.
This document is a working draft of the CSS Working Group which is part of the Style activity (see summary). It contains a proposal for features to be included in CSS level 3.
This is the last call for comments, before the working group will decide if the draft is ready for Candidate Recommendation. The deadline for comments is 27 November 2002.
Feedback is very much welcome. Comments can be sent directly to the editor, but the mailing list www-style@w3.org (see instructions) is also open and is preferred for discussion of this and other drafts in the Style area. The mailing list is archived.
This working draft may be updated, replaced or rendered obsolete by other W3C documents at any time. It is inappropriate to use W3C Working Drafts as reference material or to cite them as other than "work in progress". Its publication does not imply endorsement by the W3C membership or the CSS Working Group (members only).
Patent disclosures relevant to CSS may be found on the Working Group's public patent disclosure page.
To find the latest version of this working draft, please follow the "Latest version" link above, or visit the list of W3C Technical Reports.
This CSS3 module depends on the following other CSS3 modules:
There is a number of illustrations in this document for which the following legend is used:
- wide-cell glyph (e.g. Han)
which is the n-th character in the text run, they may also appear as
half size boxes when used as annotations.
- narrow-cell glyph (e.g. Roman)
which is the n-th glyph in the text run.
Many typographical properties in East Asian typography depend on the fact that a character is typically rendered as either a wide or narrow character. All characters described by the Unicode Standard [UNICODE] can be categorized by a width property. This is covered by the Unicode Standard Annex [UAX#11].
The orientation which the above symbols assume in the diagrams corresponds to the orientation that the glyphs they represent are intended to assume when rendered in the UA (user agent). Spacing between these characters in the diagrams is usually symbolic, unless intentionally changed to make a point.
Finally, in this document, requirements are expressed using the key words "MUST", "MUST NOT", "REQUIRED", "SHALL" and "SHALL NOT". Recommendations are expressed using the key words "SHOULD", "SHOULD NOT" and "RECOMMENDED". "MAY" and "OPTIONAL" are used to indicate optional features or behavior. These keywords are used in accordance with [RFC 2119]. For legibility these keywords are used in lowercase form.
"Ruby" is the commonly used name for a run of text that appears in the immediate vicinity of another run of text, referred to as the "base", and serves as an annotation or a pronunciation guide associated with that run of text. Ruby, as used in Japanese, is described in JIS X-4051 [JIS]. The ruby structure and the HTML markup to represent it is described in the Ruby Annotation [RUBY]. This section describes the CSS properties relevant to ruby. The following figures show two examples of Ruby.
Figure 2.1.1: Example of ruby used in Japanese (simple case)
Figure 2.1.2: Complex ruby with annotation text before and after the base characters
In the first example, a single annotation is used to annotate the base sequence. This simple case is typically referred as a 'group' ruby.
In the second example, multiple annotations are attached to a base sequence, the hiragana characters on top refer to the pronunciation of each of the base Kanji characters (annotated in a mono-ruby fashion), while the words 'Keio' and 'University' on the bottom are annotations describing the English translation of respectively the first four and the last two Kanji characters of the base. To allow correct association between the hiragana characters and their corresponding Kanji base characters, the spacing between these Kanji characters may be adjusted (this happens to the fourth Kanji character in the figure 2.1.2 above).
Note. To avoid variable spacing between the Kanji characters in the example above the hiragana annotations can also be created as a 'group' ruby.
The two examples correspond respectively to two types of ruby: a simple ruby using a simple ruby markup and a complex ruby using a complex ruby markup.
The CSS ruby model is based on the W3C Ruby Annotation Recommendation [RUBY], which is consistent with the XHTML Modularization Framework [XHTMLMOD]. The Recommendation specifies the ruby structure in a way to closely parallel the visual layout of the ruby element. In this model, a ruby consists of one or more base elements associated with one or more annotation elements.
The CSS model does not require that the document language include elements that correspond to each of these components. For document languages (such as XML applications) that do not have pre-defined ruby elements, authors must map document language elements to ruby elements; this is done with the 'display' property. The following 'display' values assign ruby semantics to an arbitrary element:
The rbspan attribute should also be used by XML applications to allow annotation spanning; but in addition, the 'ruby-span' property must be used by those applications to indicate to the user agent the number of ruby base elements to be spanned.
Conforming CSS3 user agents may not implement these ruby-related display' property values if they only support XHTML applications.
In the following description, the elements specified by the Ruby Annotation [RUBY] are used to describe the box model. As mentioned earlier, a UA can obtain the same results by using the Ruby specific 'display' property values.
In a UA that supports the ruby markup, the ruby structure consists of three or more boxes. The outermost container is the ruby element itself. In the simple case, it is a container for two non-overlapping boxes: the ruby text box (rt element) and the ruby base box (rb element). The positioning of these two boxes relative to each other is controlled by the 'ruby-position' property.
Figure 3.2.1: Ruby box model (simple case)
In the case of complex ruby, the ruby element is a container for two or three non-overlapping boxes: one ruby base collection (rbc element), and one or two ruby text collections (rtc element). The rbc element is itself a container for one or several ruby base box (rb element), while each rtc element is a container for one or several ruby text box (rt element). The position of the rtc element in relation to the related rbc element is controlled by the 'ruby-position' property. The two following figures show examples of these complex ruby.
Figure 3.2.2: Ruby box model (complex ruby with an empty rb element after)
In the example above, the rtc element following the rbc element contains two rt elements with the first one being empty, the empty rt element corresponds to the first part of the ruby base collection (identified by the first rb element within the rbc element)
Figure 3.2.3: Ruby box model (complex ruby with a spanning ruby text element)
In the example above, the rtc element preceding the rbc element spans the whole ruby base collection. The following rtc element still contain two rt elements, one of which is empty. The spanning behavior of rt text elements is controlled by the rbspan attribute in a way similar to the colspan attribute used for table column.
The width of the ruby box is by default determined by its widest child element, whose width in turn is determined by its content. The width of all direct children of the ruby element is the width of the widest children. In this respect, the ruby box is much like a two or three row table element, with the following exceptions:
If the ruby text is not allowed to overhang, then the ruby behaves like a traditional box, i.e. only its contents are rendered within its boundaries and adjacent elements do not cross the box boundary:
Figure 3.2.4: Simple ruby whose text is not allowed to overhang adjacent text
However, if ruby text is allowed to overhang adjacent elements and it happens to be wider than its base, then the adjacent content is partially rendered within the area of the ruby base box, while the ruby text may be partially overlapping with the upper blank parts of the adjacent content:
Figure 3.2.5: Simple ruby whose text is allowed to overhang adjacent text
The ruby text related to a ruby base can never overhang another ruby base.
The alignment of the contents of the base or the ruby text is not affected by the overhanging behavior. The alignment is achieved the same way regardless of the overhang behavior setting and it is computed before the space available for overlap is determined. It is controlled by the 'ruby-align' property.
The exact circumstances in which the ruby text will overhang other elements, and to what degree it will do so, will be controlled by the 'ruby-overhang' property.
This entire logic applies the same way in vertical ideographic layout, only the dimension in which it works in such a layout is vertical, instead of horizontal.
Finally, a conforming UA must not display the content of the rp element [RUBY]. The purpose of that element is to allow pre-existing UAs to parenthesize ruby text content.
The interaction of the ruby box and line stacking is controlled by the 'line-stacking-ruby' property described in the CSS3 Line Module. That property takes two values: 'include-ruby' and 'exclude-ruby. Depending on the property value, the ruby box is considered or excluded for line stacking. Even if the ruby box is considered for line stacking, some values of the 'line-stacking-strategy' property (also described in the CSS3 Line module) can still create occurrences where a the ruby box will eventually be ignored (e.g. case where the 'line-stacking-strategy' value is 'block-line-height').
In the following figure, each line box is shown with leading space distributed before and after the two text segments ('Previous line' and 'Ruby base'); the dotted lines show the line box for each line. The 'line-stacking-ruby' property is set to 'exclude-ruby'. The achieved effect is that the ruby box does not affect the line to line spacing. It is however the responsibility of the style author to avoid 'bleeding' effects between the ruby text and the surrounding text of images.
Figure 3.3.1: Excluded Ruby text
In the following figure, the line boxes have no extra leading space. The 'line-stacking-ruby' property is set to 'include-ruby' and the 'line-stacking-strategy' property is set to a value where inline boxes are considered for line stacking. In this case, the line box with the ruby text is affected and has its 'stack-height' increased by the amount necessary to fit the ruby text.
Figure 3.3.2: Ruby text increasing line height
This mechanism allows rendering of evenly spaced lines of text within a block-level element, whether a line contains ruby or not. The authors need only to set for the block-level element a line height value larger than the computed line-height of the largest ruby element within the block.
All properties, in addition to the noted values, take 'initial' and 'inherit'. These values are not repeated in each of the property value enumeration.
Name: | 'ruby-position' |
---|---|
Value: | before | after | right |
Initial: | before |
Applies to: | the parent of elements with display: ruby-text. |
Inherited: | yes |
Percentages: | N/A |
Media: | visual |
Computed value: | specified value (except for initial and inherit) |
This property is used by the parent of elements with display: ruby-text to control the position of the ruby text with respect to its base. Such parents are typically either the ruby element itself (simple ruby) or the rtc element (complex ruby). This assures that all part of a rtc element will be displayed in the same position. Possible values:
Figure 4.1.1: Top ruby in horizontal layout applied to Japanese text
If the base appears in a vertical-ideographic layout mode, the ruby appears on the right side of the base and is rendered in the same layout mode as the base (i.e. vertical-ideographic).
Figure 4.1.2: Top ruby in vertical ideographic layout applied to Japanese text
Note the special case of traditional Chinese as used especially in Taiwan: ruby (made of Bopomofo glyphs) in that context can appear along the right side of the base glyph, as if the text were in vertical layout, but the bases themselves are rendered on a horizontal line, since the actual layout is horizontal:
Figure 4.1.3: "Bopomofo" ruby in traditional Chinese (ruby text shown in blue for clarity) in horizontal layout
In order to achieve that effect, vertical-ideographic layout should be set on each individual ruby. That can be accomplished with the following simple CSS rule:
ruby.bopomofo { writing-mode: tb-rl }
Note. The Bopomofo transcription is written in the normal way as part of the ruby text. The user agent is responsible for ensuring the correct relative alignment and positioning of the glyphs, including those corresponding to the tone marks, when displaying as vertical ruby.
Figure 4.1.4: Bottom ruby in horizontal layout applied to Japanese text
If the base appears in a vertical ideographic mode, the bottom ruby appears on the left side of the base and is rendered in the same layout mode as the base (i.e. vertical).
Figure 4.1.5: Top ruby in vertical ideographic layout applied to Japanese text
If two rtc elements are set with the same ruby-position value, (for example both 'before'), the relative position of the two elements is undefined. This setting should not be used..
Name: | 'ruby-align' |
---|---|
Value: | auto | start | left | center | end | right | distribute-letter | distribute-space | line-edge |
Initial: | auto |
Applies to: | all elements and generated content |
Inherited: | yes |
Percentages: | N/A |
Media: | visual |
Computed value: | specified value (except for initial and inherit) |
This property can be used on any element to control the text alignment of the ruby text and ruby base contents relative to each other. It applies to all the ruby's in the element. For simple ruby, the alignment is applied to the ruby child element whose content is shorter: either the rb element or the rt element [RUBY]. For complex ruby, the alignment is also applied to the ruby child elements whose content is shorter: either the rb element and/or one or two rt elements for each related ruby text and ruby base element within the rtc and rbc element.
Possible values:
Figure 4.2.1: Wide-cell text in 'auto' ruby alignment is 'distribute-space' justified
The recommended behavior for a narrow-cell glyph ruby is to be aligned in the 'center' mode.
Figure 4.2.2: Narrow-width ruby text in 'auto' ruby alignment is centered
Figure 4.2.3: Start ruby alignment
Figure 4.2.4: Center ruby alignment
Figure 4.2.5: End ruby alignment
Figure 4.2.6: Distribute-letter ruby alignment
Figure 4.2.7: Distribute-space ruby alignment
Figure 4.2.8: Line edge ruby alignment
For a complex ruby with spanning elements, one additional consideration is required. If the spanning element spans multiple 'rows' (other rbc or rtc elements), and the ruby alignment requires space distribution among the 'spanned' elements, a ratio must be determined among the 'columns' of spanned elements. This ratio is computed by taking into consideration the widest element within each column.
In the context of this property, the 'left' and 'right' values are synonymous with the 'start' and 'end' values respectively. I.e. their meaning is relative according to the text layout flow. Most of the other CSS properties interpret 'left' and 'right' on an 'absolute' term. See Appendix A of the CSS3 Text Module for further details.
Name: | 'ruby-overhang' |
---|---|
Value: | auto | start | end | none |
Initial: | none |
Applies to: | the parent of elements with display: ruby-text |
Inherited: | yes |
Percentages: | N/A |
Media: | visual |
Computed value: | specified value (except for initial and inherit) |
This property determines whether, and on which side, ruby text is allowed to partially overhang any adjacent text in addition to its own base, when the ruby text is wider than the ruby base. Note that ruby text is never allowed to overhang glyphs belonging to another ruby base. Also the UA is free to assume a maximum amount by which ruby text may overhang adjacent text. The UA may use the [JIS] recommendation of using one ruby text character length as the maximum overhang length.
Possible values:
Figure 4.3.1: Ruby overhanging adjacent text
Figure 4.3.2: Ruby overhanging preceding text only
Figure 4.3.3: Ruby overhanging following text only
Figure 4.3.4: Ruby not allowed to overhang adjacent text
Name: | 'ruby-span' |
---|---|
Value: | attr(x) | none |
Initial: | none |
Applies to: | elements with display: ruby-text |
Inherited: | no |
Percentages: | N/A |
Media: | visual |
Computed value: | specified value (except for initial and inherit) |
This property controls the spanning behavior of annotation elements. This property allows non XHTML languages to specify a spanning behavior for elements with 'display: ruby-text'. XHTML applications only need to use the rbspan attribute to get the same effect. Possible values:
Conforming CSS3 user agents may not implement the 'ruby-span' property if they only support XHTML applications.
The following example shows an XML example using the 'display' property values associated with the 'ruby structure and the 'ruby-span' property
myruby { display: ruby-base; } myrbc { display: ruby-base-container; } myrb { display: ruby-base; } myrtc { display: ruby-text-container; } myrt { display: ruby-text; ruby-span: attr(rbspan); } ... <myruby> <myrbc> <myrb>10</myrb> <myrb>31</myrb> <myrb>2002</myrb> </myrbc> <myrtc> <myrt>Month</myrt> <myrt>Day</myrt> <myrt>Year</myrt> </myrtc> <myrtc> <myrt rbspan="3">Expiration Date</myrt> </myrtc> </myruby>
In addition to the specified values, all properties take the 'inherit' and 'initial' values.
Name | Values | Initial | Applies to | Inh. | Percentages | Media groups |
---|---|---|---|---|---|---|
'ruby-align' | auto | start | left | center | end | right | distribute-letter | distribute-space | line-edge | auto | all elements and generated content | yes | N/A | visual |
'ruby-overhang' | auto | start | end | none | none | the parent of elements with display: ruby-text | yes | N/A | visual |
'ruby-position' | before | after | right | inline | see individual properties | the parent of elements with display: ruby-text | yes | N/A | visual |
'ruby-span' | attr(x) | none | none | elements with display: ruby-text | no | N/A | visual |
There are two modules defined by this chapter:
CSS3 Simple Ruby model
CSS3 Complex Ruby model.
They both contain all the properties specified by this CSS chapter, i.e. 'ruby-align', 'ruby-overhang', 'ruby-position' and 'ruby-span'. They differ by the required 'display' property values. The Simple Ruby model requires the values: 'ruby', 'ruby-base' and 'ruby-text'. The Complex Ruby model requires in addition the values: 'ruby-base-container' and 'ruby-text-container'.
This specification would not have been possible without the help from:
Stephen Deach, Martin Dürst, Hideki Hiura, Masayasu Ishikawa, Chris Pratley, Takao Suzuki, Frank Tang, Chris Thrasher, Masafumi Yabe, Steve Zilles.