Ruby Extension Ruby ExtensionAH Formatter V7.0 is capable of expressing ruby.
See the following for details of ruby. AH Formatter V7.0 implements ruby according to the Requirements for Japanese Text Layout.
Ruby is expressed by the following three elements.
| XSL-FO | HTML | CSS | Meanings |
|---|---|---|---|
| <axf:ruby> | <ruby> | display: ruby | Shows the ruby structure. |
| <axf:ruby-base> | <rb> | display: ruby-base | Shows the base character of ruby. |
| <axf:ruby-text> | <rt> | display: ruby-text | Shows ruby. |
One <axf:ruby-base> maps to one <axf:ruby-text>. A pair of one <axf:ruby-base> and <axf:ruby-text> is called the ruby container. The line can break between a ruby container and another ruby container though the line cannot break within a ruby container.
Ruby has three types and it is classified as follows. (<ruby> <rb> <rt> are used in the following example)
Mono-ruby is expressed as follows.
<ruby><rb>京</rb><rt>きよう</rt></ruby><ruby><rb>都</rb><rt>と</rt></ruby><ruby><rb>府</rb><rt>ふ</rt></ruby>
Mono-ruby can be considered as a group ruby whose base character consists of one character. The ruby container of mono-ruby is independent and ruby characters never overhang the base character of the adjacent ruby.
Group-ruby is expressed as follows.
<ruby><rb>京都府</rb><rt>きようとふ</rt></ruby>
Group-ruby can be considered as a jyukugo (idiom) ruby consisting of one ruby container. Group-ruby is evenly arranged to the entire base characters.
Jukugo-ruby is expressed as follows.
<ruby><rb>京</rb><rt>きよう</rt><rb>都</rb><rt>と</rt><rb>府</rb><rt>ふ</rt></ruby>
Jyukugo-ruby consists of one or more ruby containers. The line can break between ruby containers. The method of arranging Jyukogo-ruby is complex. As a general rule, the ruby container arranges ruby as group-ruby. However when the ruby text is wider than the ruby base characters, ruby text is allowed to partially overhang any adjacent text in addition to its own base to adjust its position.
鬼門の方角を<ruby><rb>凝</rb><rt>ぎよう</rt><rb>視</rb><rt>し</rt></ruby>する。
When ruby is wider than its own base characters, ruby will overhang the adjacent character. In the following cases, ruby cannot overhang the character.
Ruby and emphasis marks can be used together. When the ruby and emphasis marks are put on the same side, emphasis marks will be put outside of ruby. When you want to align emphasis marks to the text without ruby and emphasis marks to ruby, please specify axf:text-emphasis-offset.
... text-emphasis-offset="0.5em">ルビと<ruby><rb>圏点</rb><rt>けんてん</rt></ruby>
With group-ruby, ruby can be put on both sides or it can be nested several times. At this time, only ruby specified on the outside can overhang the adjacent character.
<ruby ruby-position="after"><rb><ruby ruby-position="before"><rb>東南</rb><rt>とうなん</rt></ruby></rb><rt>たつみ</rt></ruby>の方向
In AH Formatter V7.0, ruby has the following restrictions.
Specifies the ruby structure.
Generates and returns the ruby area.
Specifies display: ruby in CSS.
Specifies the base character of ruby.
Generates and returns the text area.
Specifies display: ruby-base in CSS.
Specifies ruby.
Generates and returns the text area. This text area does not impact upon the block progression dimension in the line area.
Within the axf:ruby elements, the Nth axf:ruby-text element addresses to the Nth axf:ruby-base element. The Nth axf:ruby-text element must be placed after the Nth axf:ruby-base element.
Specifies display: ruby-text in CSS.
Specifies the alignment of ruby. [CSS3-Ruby] Ruby alignment: the 'ruby-align' property
| Value: | auto | [[space-between | space-around] || [center | start | end | start-if-vertical]] |
| Initial: | auto |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
Values have the following meanings.
The value specified by ruby-align in the Option Setting File is adopted.
Same as space-around center.
Spaces leading and following the ruby text are made and the ruby text is evenly distributed. If the ruby text consists of one character, then it's center aligned.
Spaces leading and following the ruby text are made and the ruby text is evenly distributed. If the ruby text consists of one character, then it is start aligned.
Same as space-between center.
Spaces leading and following the ruby text are not made and the ruby text is evenly distributed. If the ruby text consists of one character, then it is center aligned.
Spaces leading and following the ruby text are not made and the ruby text is evenly distributed. If the ruby text consists of one character, then it is start aligned.
Ruby is positioned at the center with solid setting.
Ruby is positioned on the start side with solid setting.
Ruby is positioned on the end side with solid setting.
Same as start if the writing-mode is vertical, same as center if the writing-mode is horizontal.
axf:ruby-align decides the alignment of ruby. Originally, center alignment and start alignment are the concept of mono-ruby, however, the same concept is also applied for group-ruby whose base text has 2 or more characters. When ruby is longer than its base characters, ruby will be positioned with solid setting.
Center alignment of mono-ruby can be specified as follows:
Start alignment of mono-ruby can be specified as follows:
The following shows the example of giving spaces leading and following the ruby text in group-ruby. The amount of spaces leading and following the ruby text is half the amount of inter-character space of the ruby text.
The following shows the example of not giving spaces leading and following the ruby text in group-ruby.
Specifies on which side of the base characters the ruby text appears. [CSS3-Ruby] Ruby positioning: the 'ruby-position' property
| Value: | before | after
| [[ over | under | |
| Initial: | before |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
Values have the following meanings.
Ruby appears on the before side.
Ruby appears on the after side.
Ruby appears on the upper side in horizontal writing mode. Same as before.
Ruby appears on the lower side in horizontal writing mode. Same as after.
Ruby appears on the right side in vertical writing mode. Same as before.
Ruby appears on the left side in vertical writing mode. Same as after.
| CAUTION: | inter-character is not supported. |
|---|
Specifies the spacing between the ruby text and its base characters.
| Value: | <number> | <length> | <percentage> |
| Initial: | 0pt |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the font size |
Values have the following meanings.
The used value is this number multiplied by the font size of the ruby text (axf:ruby-font-size).
Specifies the length.
The computed value is this percentage multiplied by the font size of the axf:ruby element (not the font size of the ruby text).
Specifies how ruby overhangs the adjacent base character. [CSS3-Ruby] Ruby overhanging: the 'ruby-overhang' property (“ruby-overhang” has been removed from CSS3-Ruby on and after September 19, 2013)
| Value: | none | auto | [start || end || except-kanji || except-katakana || except-hiragana || except-kana || except-start-open-parenthesis || except-end-close-parenthesis] |
| Initial: | auto |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
Values have the following meanings.
Does not overhang the adjacent base character.
Same as start end except-kanji
Overhangs on the start side of the adjacent base character (if available).
Overhangs on the end side of the adjacent base character (if available).
Does not overhang when the adjacent base character is kanji.
Does not overhang when the adjacent base character is katakana.
Does not overhang when the adjacent base character is hiragana.
Does not overhang when the adjacent base character is kana. Same as except-katakana except-hiragana.
Does not overhang when the open parenthesis is on the start side.
Does not overhang when the close parenthesis is on the end side.
When only except-* is specified and neither start nor end are specified, it is considered as start and end are specified.
Specifies the limit of the amount that ruby overhangs the adjacent base character when ruby is longer than its own base character.
| Value: | <number> | <length> | <percentage> |
| Initial: | 1.0 |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the font size |
Values have the following meanings.
The used value is this number multiplied by the font size of the ruby text (axf:ruby-font-size). The value must be non-negative.
Specifies the length. The value must be non-negative.
The computed value is this percentage multiplied by the font size of the axf:ruby element (not the font size of the ruby text). The value must be non-negative.
This value shows the amount that ruby overhangs the adjacent base character. (It is not the protruding amount.)
Specifies the limit of the amount of spaces leading and following the ruby text when the ruby text is shorter than its base characters.
| Value: | <number> | <length> | <percentage> | none |
| Initial: | 1.0 |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the font size |
Values have the following meanings.
The used value is this number multiplied by the font size of the ruby text (axf:ruby-font-size). The value must be non-negative.
Specifies the length. The value must be non-negative.
The computed value is this percentage multiplied by the font size of the axf:ruby element (not the font size of the ruby text). The value must be non-negative.
Does not limit the amount of the space.
Possible to avoid generating too much spaces leading and following the ruby text because the ruby text is too shorter than its base characters when axf:ruby-align="space-around" is specified. The amount of the space will be limited to the specified value.
Specifies whether to allow using small kana for ruby text.
| Value: | auto | preserve| convert |
| Initial: | auto |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
Values have the following meanings.
Does nothing.
Small kana is converted into regular kana. Only fullwidth (not halfwidth) characters are converted.
It's made available not to use small kana for ruby text. Even if small kana is specified to the ruby text, it will be transformed into regular kana.
When ruby-small-kana="preserve" is specified, there is nothing special. Small kana will appear in the ruby text as is unless text-transform="fullsize-kana" is specified.
Specifies the font family of ruby text.
| Value: | [ <family-name> | <generic-family> ]# |
| Initial: | empty string |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
If nothing is specified, it's considered the same as font-family.
Specifies the font size of ruby text.
| Value: | <number> | <absolute-size> | <relative-size> | <length> | <percentage> |
| Initial: | 0.5 |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the font size |
When <number> is specified, the used value is this number multiplied by the element's font size.
Specifies the minimum font size of ruby text.
| Value: | none | <absolute-size> | <relative-size> | <length> | <percentage> |
| Initial: | none |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the font size |
Specifies the font style of ruby text.
| Value: | normal | italic |
| Initial: | empty |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
If nothing is specified, it's considered the same as font-style.
Specifies the font weight of ruby text.
| Value: | normal | bold | bolder | lighter | 1...1000 |
| Initial: | empty |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
If nothing is specified, it's considered the same as font-weight.
Specifies the font stretching of ruby text.
| Value: | normal | wider | narrower | ultra-condensed | extra-condensed | condensed | semi-condensed | semi-expanded | expanded | extra-expanded | ultra-expanded | <percentage> | <number> |
| Initial: | empty |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the ruby-font-size |
If nothing is specified, it's considered the same as font-stretch.
Specifies the font condense when the ruby text is longer than its base.
| Value: | none | <percentage> | <number> |
| Initial: | none |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | refer to the ruby-font-size |
Condenses ruby by “stretch” so that length of ruby becomes the same as its base characters when ruby is longer than its base characters. The numerical value shows the limit to be shorten at that time. If none is specified, ruby is not condensed.
Specifies the color of ruby text.
| Value: | <color> |
| Initial: | empty |
| Applies to: | axf:ruby |
| Inherited: | yes |
| Percentages: | N/A |
If nothing is specified, it's considered the same as color.