B.95. ruby-overhang

Ruby text is a new addition in the XHTML 1.1 recommendation and is described by the Ruby Annotation Recommendation of the W3C. Commonly used in Japan and China, ruby text generally appears in a smaller font over the main text as a pronunciation guide, or to provide some other explanatory annotation.

This property controls whether ruby text is allowed to extend over adjacent text or whitespace, if it is longer than the base text it annotates.

Inherited: No

See also: Section B.94ruby-align, Section B.96ruby-position

B.95.1. Value

This property accepts any of the following constants:

• auto

• none

• whitespace

For the meanings of each of these constants, see the CSS3 Ruby module working draft and the Microsoft Internet Explorer documentation for this property.

Initial value: auto

B.95.2. Compatibility

CSS Version: n/a

This property is supported only in Internet Explorer for Windows version 5 or later. In that browser, this property must be applied to the ruby element that contains the ruby text (rt) element for which you wish to set the alignment.

Equivalent functionality is planned for inclusion in CSS3, and the current working draft suggests that this property will be as documented here. To follow the work on this front, see the CSS Working Group Web site.

B.95.3. Example

This style rule allows ruby text to overhang whitespace adjacent to the base text only:

ruby {
  ruby-overhang: whitespace;
}