<pre class='metadata'>

Title: CSS Ruby Annotation Layout Module Level 1

Shortname: css-ruby

Level: 1

Status: ED

Work Status: Revising

Group: csswg

ED: https://drafts.csswg.org/css-ruby-1/

TR: https://www.w3.org/TR/css-ruby-1/

Test Suite: https://w3c.github.io/i18n-tests/results/css-ruby

Previous Version: https://www.w3.org/TR/2021/WD-css-ruby-1-20211202/

Previous Version: https://www.w3.org/TR/2021/WD-css-ruby-1-20210310/

Previous Version: https://www.w3.org/TR/2020/WD-css-ruby-1-20200429/

Previous Version: https://www.w3.org/TR/2014/WD-css-ruby-1-20140805/

Previous Version: https://www.w3.org/TR/2013/WD-css3-ruby-20130919/

Editor: Elika J. Etemad / fantasai, Apple, http://fantasai.inkedblade.net/contact, w3cid 35400

Editor: Koji Ishii, Google, kojiishi@gmail.com, w3cid 45369

Editor: Xidorn Quan, Mozilla https://www.mozilla.org/, https://www.upsuper.org/, w3cid 73936

Editor: Florian Rivoal, Invited Expert, https://florian.rivoal.net/, w3cid 43241

Abstract: “Ruby”, a form of interlinear annotation, are short runs of text alongside the base text.

Abstract: They are typically used in East Asian documents to indicate pronunciation or to provide a short annotation.

Abstract: This module describes the rendering model and formatting controls related to displaying ruby annotations in CSS.

WPT Path Prefix: /css/css-ruby/

</pre>

<pre class=link-defaults>

spec:css-box-4; type:dfn; text:content area

spec:css-text-3; type:dfn; text:character

spec:css-text-3; type:dfn; text:other space separators

spec:css-text-4; type:dfn;

text:fullwidth opening punctuation

text:fullwidth closing punctuation

text:fullwidth middle dot punctuation

spec:css-writing-modes-4; type:dfn; text:bidi isolation

spec:html-ruby-extensions; type:element;

text:rp

text:rtc

text:ruby

</pre>

<style>

/* ASCII diagram colors */

.base { color: blue; }

.annot { color: red; }

.column { color: gray; }

.flagtxt1 { color: green; }

.flagtxt2 { color: #ae4a00; }

.flagbg1 { background: green; opacity: 0.3; }

.flagbg2 { background: orange; opacity: 0.3; }

</style>

<h2 id="intro">

Introduction</h2>

<h3 id="ruby-def">

What is ruby?</h3>

<em>This subsection is not normative.</em>

<dfn export>Ruby</dfn> is the commonly-used name for a run of text

that appears alongside another run of text (referred to as the “base”)

and serves as an annotation or a pronunciation guide associated with that run of text.

<figure>

<img src="images/ruby-context.png" width="324" height="64"

alt="Hiragana ruby annotations above each kanji in Japanese text">

<figcaption>A run of Japanese text with phonetic ruby annotations indicating the pronunciation of each ideograph.</figcaption>

</figure>

The following figures show two examples of Ruby,

a simple case and one with more complicated structure.

<div class="example">

In this example, a single annotation is used to annotate a base text

consisting of multiple characters.

<div class="figure">

<img src="images/licence.png" width="260" height="66"

alt="Example of ruby applied on top of a Japanese expression">

<p class="caption">Example of ruby used in Japanese (simple case)

</div>

In Japanese typography, this case is sometimes called

taigo ruby (Japanese: <span lang="ja">対語ルビ</span>, i.e. per-word ruby) or group-ruby,

because the annotation as a whole is associated

with multi-character word (as a whole).

</div>

<div class="example">

In this second example,

two levels of annotations are attached to the base text:

the hiragana characters on top refer to the pronunciation of each of the base kanji characters,

while the words “Keio” and “University” on the bottom are give the English translation.

<div class="figure">

<img src="images/ruby-univ.gif" width="277" height="108"

alt="Example showing complex ruby with annotation text over and under the base characters">

<p class="caption">Complex ruby with annotation text over and under the base characters

</div>

Notice that to reflect the correct association

of hiragana characters and their corresponding Kanji base characters,

the spacing within the base-level text is adjusted.

(This happens around the fourth Kanji character in the figure above,

which has a three-character phonetic gloss.)

To avoid variable spacing of the base text in the example above,

the hiragana annotations can be styled as a [=merged annotation=],

which will look more like the group-ruby example earlier.

However because the base-annotation [=pairings=] are recorded in the ruby structure,

if the text breaks across lines, the annotation characters will stay

correctly paired with their respective base characters.

</div>

In HTML, ruby structure and markup to represent it is described

in the Ruby Markup Extension specification.

This module describes the CSS rendering model

and formatting controls relevant to ruby layout of such markup.

A more in-depth introduction to [=Ruby=] and its formatting

can be found in the “What is Ruby“ article [[QA-RUBY]].

Extensive information about the main ways [=ruby=] has traditionally been formatted in Japanese

can be found in JIS X-4051 [[JIS4051]] (in Japanese)

and in <a href="https://www.w3.org/TR/jlreq/#ruby_and_emphasis_dots">“Ruby and Emphasis Dots”</a> in <cite>Requirements for Japanese Text Layout</cite> [[JLREQ]] (in English and Japanese);

<cite>Rules for Simple Placement of Japanese Ruby</cite> [[SIMPLE-RUBY]]

also describes (in English) one possible approach for Japanese ruby formatting.

<a href="https://www.w3.org/TR/clreq/#interlinear_annotations">“Interlinear annotations”</a> in <cite>Requirements for Chinese Text Layout</cite> [[CLREQ]]

describes the related practices for Chinese typography (in Chinese and English).

<h3 id="placement">

Module interactions</h3>

This module extends the inline box model of CSS Level 2 [[!CSS2]]

to support ruby.

None of the properties in this module apply to the ''::first-line'' or

''::first-letter'' pseudo-elements;

however 'ruby-position' can inherit through ''::first-line'' to affect

ruby annotations on the first line.

<h3 id="values">

Value Definitions</h3>

This specification follows the <a href="https://www.w3.org/TR/CSS2/about.html#property-defs">CSS property definition conventions</a> from [[!CSS2]]

using the <a href="https://www.w3.org/TR/css-values-3/#value-defs">value definition syntax</a> from [[!CSS-VALUES-3]].

Value types not defined in this specification are defined in CSS Values &amp; Units [[!CSS-VALUES-3]].

Combination with other CSS modules may expand the definitions of these value types.

In addition to the property-specific values listed in their definitions,

all properties defined in this specification

also accept the [=CSS-wide keywords=] keywords as their property value.

For readability they have not been repeated explicitly.

<h3 id="diagram-conventions">

Diagram conventions</h3>

<em>This subsection is not normative.</em>

Many typographical conventions in East Asian typography depend

on whether the character rendered is wide (CJK) or narrow (non-CJK).

There are a number of illustrations in this document

for which the following legend is used:

<dl>

<dt><img alt="Symbolic wide-cell glyph representation" width="39" height="39" src="images/fullwidth.gif">

<dd>

Wide-cell glyph (e.g. Han) that is the <var>n</var>th character in the text sequence.

They are typically sized to 50% when used as annotations.

<dt><img alt="Symbolic narrow-cell glyph representation" width="19" height="39" src="images/halfwidth.gif">

<dd>Narrow-cell glyph (e.g. Roman) which is the <var>n</var>th glyph in the text sequence.

</dl>

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 by the user agent.

Spacing between these characters in the diagrams is incidental,

unless intentionally changed to make a point.

<h2 id="ruby-model">

Ruby Box Model</h2>

The CSS ruby model is based on

the <a href="https://www.w3.org/TR/html5/text-level-semantics.html#the-ruby-element">W3C HTML5 Ruby Markup</a> model

and the <a href="https://www.w3.org/TR/ruby/">XHTML Ruby Annotation Recommendation</a> [[RUBY]].

In this model, a ruby structure consists of

one or more [=ruby base=] elements representing the base (annotated) text,

associated with one or more levels of [=ruby annotation=] elements representing the annotations.

The structure of ruby is similar to that of a table:

there are “rows” (the [=base text level=], each [=annotation level=])

and “[=columns=]” (each [=ruby base=] and its corresponding [=ruby annotations=]).

<figure>

<img src="images/ruby-boxes-simple.png" width="314" height="94"

alt="Ruby structure arranged as a table,

the first “column” containing 上 in a base box with じょう centered below in an annotation box

and the second “column” containing 手 in a separate base box with ず centered below in another annotation box.">

<figcaption>The Japanese compound word “<span lang=ja>上手</span>” annotated with its pronunciation “<span lang=ja>じょうず</span>”. Each syllable is associated individually with its base character.</figcaption>

</figure>

Sets of consecutive bases and their consecutive annotations are grouped together into [=ruby segments=].

Within a [=ruby segment=], a [=ruby annotation=] may span multiple [=ruby bases=].

<figure>

<img src="images/ruby-boxes-complex.png" width="350" height="128"

alt="Ruby structure arranged as a table,

the first “column” containing 旧 in a base box with jiù centered above in an annotation box,

the second “column” containing 金 in a base box with jīn centered above in an annotation box,

the third “column” containing 山 in a base box with .shān centered above it in an annotation box,

and the name San Francisco centered below the entire phrase in an annotation box that spans all three “columns”.">

<figcaption>The Chinese city name “<span lang="zh-Hans">旧金山</span>” annotated with its pronunciation in Pinyin “<span lang="zh-Latn-pinyin">jiùjīnshān</span>” and its English name “San Francisco”. Each Pinyin syllable is associated individually with its base character, however the English name is associated with the name as a whole.</figcaption>

</figure>

Note: In HTML, a single <code>&lt;ruby&gt;</code> element may contain multiple [=ruby segments=].

(In the XHTML Ruby model, a single <code>&lt;ruby&gt;</code> element can only contain one [=ruby segment=].)

<h3 id="ruby-display">

Ruby-specific 'display' Values</h3>

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.

<pre class="propdef partial informative">

Name: display

New values: ruby | ruby-base | ruby-text | ruby-base-container | ruby-text-container

</pre>

The following new 'display' values assign ruby layout roles to an arbitrary element:

<dl dfn-type=value export dfn-for=display>

<dt><dfn>ruby</dfn>

<dd>

Specifies that an element generates a <dfn dfn for lt="ruby container | ruby container box">ruby container box</dfn>.

(Corresponds to HTML/XHTML <code>&lt;ruby&gt;</code> elements.)

<dt><dfn>ruby-base</dfn>

<dd>

Specifies that an element generates a <dfn dfn for lt="ruby base box | ruby base | base | base box">ruby base box</dfn>.

(Corresponds to HTML/XHTML <code>&lt;rb&gt;</code> elements.)

<dt><dfn>ruby-text</dfn>

<dd>

Specifies that an element generates a <dfn dfn for lt="ruby annotation box | ruby annotation | annotation | annotation box">ruby annotation box</dfn>.

(Corresponds to HTML/XHTML <code>&lt;rt&gt;</code> elements.)

<dt><dfn>ruby-base-container</dfn>

<dd>

Specifies that an element generates a <dfn dfn for lt="ruby base container box | ruby base container" local-lt="base container">ruby base container box</dfn>.

(Corresponds to XHTML <code>&lt;rbc&gt;</code> elements; generated as an anonymous box in HTML.)

<dt><dfn>ruby-text-container</dfn>

<dd>

Specifies that an element generates a <dfn dfn for lt="ruby annotation container box | ruby annotation container" local-lt="annotation container">ruby annotation container box</dfn>.

(Corresponds to HTML/XHTML <code>&lt;rtc&gt;</code> elements.)

</dl>

<p class="advisement">Authors using a language (such as HTML)

that supports dedicated ruby markup

should use that markup rather than

styling arbitrary elements (like <code>&lt;span&gt;</code>)

with ruby 'display' values.

Using the correct markup ensures that screen readers

and non-CSS renderers can interpret the ruby structures.

Note: [=Replaced elements=] with a 'display' value of

''ruby-base'',

''ruby-text'',

''ruby-base-container'',

and ''ruby-text-container''

are treated as [=inline-level boxes=],

as per [[css-display-3#layout-specific-display]];

[=replaced elements=] with a 'display' value of ''ruby'' or ''inline ruby''

behave according to their [=outer display type=],

as per [[css-display-3#outer-role]].

(See also [[#block-ruby]].)

<h4 id="formatting-context">

The Ruby Formatting Context</h4>

[=Ruby containers=] are non-atomic [=inline-level=] boxes.

Like regular [=inline boxes=] (see [[css-inline-3#model]]),

they break across lines,

and their [=containing block=] is the nearest [=block container=] ancestor.

And just as the contents of an [=inline box=]

participate in the same [=inline formatting context=] that contains the [=inline box=] itself,

a [=ruby container=] and its base-level contents

participate in the same [=inline formatting context=] that contains the [=ruby container=] itself.

However [=ruby containers=] also establish a <dfn export>ruby formatting context</dfn>

that builds further structure around their segment of the [=inline formatting context=]

in order to host their annotations.

<span class=note>Note: this [=formatting context=] is <em>not</em> an [=independent formatting context=].</span>

[=Ruby bases=], [=ruby annotations=], [=ruby base containers=], and [=ruby annotation containers=]

are <dfn export lt="internal ruby boxes|internal ruby display types">internal ruby boxes</dfn>:

like [=internal table elements=],

they have specific roles in ruby layout,

and participate in their [=ruby container=]’s [=ruby formatting context=].

In addition to their role in the [=ruby formatting context=],

[=ruby bases=] simultaneously participate

in the same base-level [=inline formatting context=] as the [=ruby container=],

while [=ruby annotations=] participate

in separate annotation-level [=inline formatting contexts=]

established by the [=ruby container=].

As with the contents of [=inline boxes=],

the [=containing block=] for the contents of a [=ruby container=] (and all its [=internal ruby boxes=])

is the [=containing block=] of the [=ruby container=].

So floats, for example, are trapped by the [=ruby container=]’s [=containing block=],

not any of the ruby box types.

<h4 id="block-ruby">

Non-Inline Ruby</h4>

If an element has an [=inner display type=] of ''ruby''

and an [=outer display type=] other than ''display/inline'',

then it generates two boxes:

a principal box of the required [=outer display type=] type,

and an inline-level [=ruby container=].

All properties specified on the element apply to the principal box

(and if inheritable, inherit to the [=ruby container box=]).

This allows styling the element as a block,

while correctly maintaining the internal ruby structure.

Note: Absolute positioning or floating an element causes its 'display' value

to compute to a block-level equivalent. (See [[!CSS-DISPLAY-3]] or [[!CSS2]] section 9.7.)

For the [=internal ruby display types=],

this causes their 'display' value to compute to ''display/block''.

<h3 id="box-fixup">

Anonymous Ruby Box Generation</h3>

The CSS model does not require that the document language

include elements that correspond to each of these components.

Missing parts of the structure are implied through the anonymous box generation rules

<a href="https://www.w3.org/TR/CSS2/tables.html#anonymous-boxes">similar to those used to normalize tables</a>. [[!CSS2]]

<ol>

<li id="anon-gen-inlinize"><strong>[=Inlinify=] block-level boxes:</strong>

Any [=in-flow=] boxes directly contained by a

[=ruby container=],

[=ruby base container=],

[=ruby annotation container=],

[=ruby base box=],

or [=ruby annotation box=]

are “[=inlinified=]” per [[!CSS-DISPLAY-3]]),

and their 'display' value computed accordingly,

so that they contain only inline-level content.

For example,

the 'display' property of an in-flow element with ''display: block''

parented by an element with ''display: ruby-text''

computes to ''inline-block''.

<li id="anon-gen-anon-ruby"><strong>Generate anonymous ruby containers:</strong>

Any <a href="https://www.w3.org/TR/CSS2/tables.html#anonymous-boxes">consecutive</a> sequence of

improperly-contained

[=ruby base containers=],

[=ruby annotation containers=],

[=ruby bases=],

and/or

[=ruby annotations=]

(and any intervening [=white space=])

is wrapped in an anonymous [=ruby container=].

For the purpose of this step:

<ul>

<li>an improperly-contained [=ruby base=] is one not parented by a [=ruby base container=] or [=ruby container=]

<li>an improperly-contained [=ruby annotation=] is one not parented by a [=ruby annotation container=] or [=ruby container=]

<li>

an improperly-contained [=ruby base container=] or [=ruby annotation container=]

is one not parented by a [=ruby container=]

</ul>

<li id="anon-gen-bare-inlines"><strong>Wrap misparented inline-level content:</strong>

Any consecutive sequence of text and inline-level boxes

directly parented by a [=ruby container=] or [=ruby base container=]

is wrapped in an anonymous [=ruby base=].

Similarly, any consecutive sequence of text and inline-level boxes

directly parented by a [=ruby annotation container=]

is wrapped in an anonymous [=ruby annotation=].

(For this purpose, misparented [=internal table elements=]

are treated as [=inline-level content=]

since, being parented by ruby boxes,

they will be ultimately wrapped by an [=inline-level=] [=table wrapper box=].)

However, if an anonymous box so constructed contains only [=white space=],

it is considered <dfn>intra-ruby white space</dfn>

and is either discarded

or preserved

as described below.

<li id="anon-gen-trim-space"><strong>Trim leading/trailing white space:</strong>

Any [=intra-ruby white space=]

that is not the sole [=in-flow=] child of its parent

and is the first or last [=in-flow=] child of

a [=ruby container=], [=ruby annotation container=], or [=ruby base container=]

is removed, as if it had ''display: none''

<li id="anon-gen-discard-space"><strong>Remove inter-level white space:</strong>

Any [=intra-ruby white space=]

whose immediately adjacent [=in-flow=] siblings match one of the patterns below

is <dfn noexport>inter-level white space</dfn>

and is removed, as if it had ''display: none''.

<table class="data">

<thead>

<tr><th>Previous box

<th>Next box

<tbody>

<tr><td>any

<td>[=ruby annotation container=]

<tr><td>not [=ruby annotation=]

<td>[=ruby annotation=]

<!--

<tr><td>[=ruby base=] or [=ruby base container=]

<td>[=ruby annotation=] or [=ruby annotation container=]

<tr><td>[=ruby annotation container=]

<td>[=ruby annotation container=]

<tr><td>[=ruby annotation=]

<td>[=ruby annotation container=]

<tr><td>[=ruby annotation container=]

<td>[=ruby annotation=]

-->

</table>

<li id="anon-gen-interpret-space"><strong>Interpret intra-level white space:</strong>

Any [=intra-ruby white space=] box

whose immediately adjacent [=in-flow=] siblings match one of the patterns below

is assigned the box type and subtype defined in the table below:

<table class="data">

<colgroup span=2></colgroup>

<colgroup span=2></colgroup>

<thead>

<tr><th>Previous box

<th>Next box

<th>Box type

<th>Subtype

<tbody>

<tr><td>[=ruby base=]

<td>[=ruby base=]

<td>[=ruby base=]

<td><dfn>inter-base white space</dfn>

<tr><td>[=ruby annotation=]

<td>[=ruby annotation=]

<td>[=ruby annotation=]

<td><dfn>inter-annotation white space</dfn>

<tr><td>[=ruby annotation=] or [=ruby annotation container=]

<td>[=ruby base=] or [=ruby base container=]

<td rowspan=3>[=ruby base=]

<td rowspan=3><dfn>inter-segment white space</dfn>

<tr><td>[=ruby base=] or [=ruby base container=]

<td>[=ruby base container=]

<tr><td>[=ruby base container=]

<td>[=ruby base=] or [=ruby base container=]

</table>

The <dfn>intra-level white space</dfn> boxes defined above

are treated specially for [=pairing=] and layout.

See below.

<li id="anon-gen-unbreak"><strong>Suppress line breaks:</strong>

Convert all forced line breaks inside [=ruby annotations=] (regardless of 'white-space' value)

as defined for collapsible segment breaks in <a href="https://www.w3.org/TR/css-text-3/#line-break-transform">CSS Text Level 3 &sect; 4.1.2</a>.

Issue: The goal of this is to simplify the layout model by suppressing any line breaks within ruby annotations.

Alternatively we could try to define some kind of acceptable behavior for them.

<li id="anon-gen-anon-containers"><strong>Generate anonymous level containers:</strong>

Any consecutive sequence of [=ruby bases=] and [=inter-base white space=]

(and not [=inter-segment white space=])

not parented by a [=ruby base container=]

is wrapped in an anonymous [=ruby base container=].

Similarly, any consecutive sequence of [=ruby annotations=] and [=inter-annotation white space=]

not parented by a [=ruby annotation container=]

is wrapped in an anonymous [=ruby annotation container=].

</ol>

Once all ruby layout structures are properly parented,

the UA can start to associate bases with their annotations.

Note: The UA is not required to create any of these anonymous boxes

(or the anonymous empty [=intra-level white space=] boxes in [[#ruby-pairing]])

in its internal structures,

as long as [=pairing=] and layout behaves as if they existed.

<div class="example">

The following markup diagram representing the various boxes

shows where [=intra-ruby white space=] is preserved or discarded:

<xmp highlight=html style="white-space: normal; overflow-wrap: break-word">

<ruby>×<rbc>×<rb></rb>⬕<rb></rb>×</rbc>☒<rtc>×<rt></rt>⬔<rt></rt>×</rtc>◼<rbc>×<rb></rb>…</rtc>×</ruby>

</xmp>

where

* × represents <a href="#anon-gen-trim-space">discarded leading/trailing white space</a>

* ☒ represents <a href="#anon-gen-discard-space">discarded inter-level white space</a>

* ⬕ represents [=inter-base white space=]

* ⬔ represents [=inter-annotation white space=]

* ◼ represents [=inter-segment white space=]

</div>

<h3 id="ruby-pairing">

Annotation Pairing</h3>

Annotation <dfn>pairing</dfn> is the process of associating

[=ruby annotations=] with [=ruby bases=].

Each [=ruby annotation=] is associated with one or more [=ruby bases=],

and is said to <dfn>span</dfn> those bases.

(A [=ruby annotation=] that [=spans=] multiple bases is called

a <dfn>spanning annotation</dfn>.)

A [=ruby base=] can be associated with

only one [=ruby annotation=] per [=annotation level=].

However, if there are multiple [=annotation levels=],

it can be associated with multiple [=ruby annotations=].

Once [=pairing=] is complete, <dfn local-lt=column>ruby columns</dfn> are defined,

each represented by a single [=ruby base=]

and one [=ruby annotation=] (possibly an empty, anonymous one)

from each [=interlinear=] [=annotation level=] in its [=ruby segment=].

<h4 id="segment-pairing">

Segment Pairing and Annotation Levels</h4>

A ruby structure is divided into <dfn>ruby segments</dfn>,

each consisting of a single [=ruby base container=]

followed by one or more [=ruby annotation containers=].

Each [=ruby annotation container=] in a [=ruby segment=]

represents one <dfn lt="annotation level | level">level</dfn> of annotation for the base text:

the first one represents the first level of annotation,

the second one represents the second level of annotation,

and so on.

The [=ruby base container=] represents the <dfn lt="base level | base text level">base level</dfn>.

The [=ruby base container=] in each segment is thus paired

with each of the [=ruby annotation containers=] in that segment.

In order to handle degenerate cases, some empty anonymous containers are assumed:

<ul>

<li>

If the first child of a [=ruby container=] is a [=ruby annotation container=],

an anonymous, empty [=ruby base container=] is assumed to exist before it.

<li>

Similarly, if the [=ruby container=] contains consecutive [=ruby base containers=],

anonymous, empty [=ruby annotation containers=] are assumed to exist between them.

</ul>

[=Inter-segment white space=] is effectively a [=ruby segment=] of its own.

<h4 id="base-annotation-pairing">

Unit Pairing and Spanning Annotations</h4>

Within a [=ruby segment=],

each [=ruby base=] in the [=ruby base container=]

is paired with one [=ruby annotation=]

from each [=ruby annotation container=] in its [=ruby segment=].

If a [=ruby annotation container=] contains only

a single, anonymous [=ruby annotation=],

then that [=ruby annotation=] is paired with (i.e. [=spans=] across)

all of the [=ruby bases=] in its [=ruby segment=].

Otherwise, each [=ruby annotation=] is paired,

in document order, with the corresponding [=ruby base=] in that segment.

If there are not enough [=ruby annotations=] in a [=ruby annotation container=],

the remaining [=ruby bases=] are paired with anonymous empty annotations

inserted at the end of the [=ruby annotation container=].

If there are not enough [=ruby bases=],

any remaining [=ruby annotations=] pair with empty, anonymous bases

inserted at the end of the [=ruby base container=].

If an implementation supports ruby markup with explicit spanning

(e.g. XHTML Complex Ruby Annotations),

it must adjust the [=pairing=] rules to pair [=spanning annotations=]

to their bases appropriately.

[=Intra-level white space=] does not participate in standard annotation [=pairing=].

However, if the immediately-adjacent [=ruby bases=] or [=ruby annotations=]

are paired

<ul>

<li>

with two [=ruby bases=] or [=ruby annotations|annotations=]

that surround corresponding [=intra-level white space=] in another level,

then the so-corresponding [=intra-level white space=] boxes are also paired.

<li>

with a single spanning [=ruby annotation=],

then the [=intra-level white space=] is also paired to that [=ruby annotation=]

<li>

with two [=ruby bases=] or [=ruby annotations|annotations=]

with no intervening [=intra-level white space=],

then the [=intra-level white space=] box pairs with

an anonymous empty [=intra-level white space=] box assumed to exist between them.

</ul>

<div class="example">

The following diagram shows the pairing of

regular [=base=] and [=annotation=] boxes

as well as the pairing of [=intra-ruby white space=] (represented as <samp>ws</samp>):

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> s p a n n i n g a n n o t a t i o n <span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span>ws<span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a2 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a3 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span>ws<span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a4 <span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span> b1 <span class=base>]</span><span class=column>|</span><span class=base>[</span>ws<span class=base>]</span><span class=column>|</span><span class=base>[</span> b2 <span class=base>]</span><span class=column>|</span><span class=base>[</span>ws<span class=base>]</span><span class=column>|</span><span class=base>[</span> b3 <span class=base>]</span><span class=column>|</span><span class=base>[</span> <span class=base>]</span><span class=column>|</span><span class=base>[</span> b4 <span class=base>]</span><span class=column>|</span>

</pre>

Blue brackets (<samp class=base>[ ]</samp>) represent [=base boxes=],

red brackets (<samp class=annot>[ ]</samp>) represent [=annotation boxes=],

gray bars (<samp class=column>|</samp>) represent the limits of [=ruby columns=],

<samp class=ws>[ws]</samp> represents [=intra-ruby white space=],

and <samp>[]</samp> represents an empty anonymous base or annotation

automatically generated to pair with [=intra-ruby white space=] in another level.

[=Ruby containers=], [=base containers=], and [=annotation containers=] are omitted.

</div>

<!--

No longer needed now that the layout model is better defined,

although we might want this (or something like this) if we want to handle

complex cases for nesting with proper alignment across the nested parts

<h4 id="nested-pairing">

Complex Spanning with Nested Ruby</h4>

When [=ruby containers=] are <dfn lt="nested ruby">nested</dfn>,

[=pairing=] begins with the deepest [=ruby container=],

then expands out.

From the [=pairing=] perspective of the outer [=ruby container=],

each [=ruby container=] nested within another [=ruby container=]

counts as representing a single [=ruby base=]/[=annotation=] per level.

The outer [=ruby container=]’s [=ruby annotations=] paired to the [=nested ruby=]

are therefore paired with (and [=span=]) all of the nested [=ruby container=]’s [=ruby bases=].

Each [=ruby annotation container=] in the nested [=ruby container=]

occupies the same [=annotation level=] in the outer [=ruby container=]

as it does in the inner one

and participates in its layout as if it were directly contained in the outer [=ruby container=].

This process is recursive.

Thus, using nested [=ruby containers=] allows the representation

of complex spanning relationships.

Issue: It's not clear whether this falls out of layout handling of ruby containers inside ruby bases

or needs to be handled specially.

Waiting until layout is better-defined to find out...

-->

<h3 id="hiding" oldids="autohide">

Hiding Annotations: ''visibility: collapse'' and auto-hidden ruby</h3>

A [=ruby annotation=] whose 'visibility' is ''visibility/collapse''

is a <dfn lt="hidden annotation | hidden ruby annotation | hide" local-lt="hidden">hidden annotation</dfn>.

Additionally,

if a [=ruby annotation=] has the exact same text content as its base,

it is automatically [=hidden=]

(<dfn lt="auto-hidden | auto-hide">auto-hidden</dfn>)

by the UA.

[=Hiding=] a [=ruby annotation=] does not affect annotation [=pairing=].

However the [=hidden annotation=] is not visible,

and it has no impact on layout

other than to separate adjacent sequences of [=ruby annotation boxes=] within its level,

as if they belonged to separate segments

and the [=hidden annotation=]’s base were not a [=ruby base=] but an intervening inline.

<div class="example">

Auto-hiding allows correct inlined display of annotations

for Japanese words that are a mix of kanji and hiragana.

For example, the word <span lang=ja>振り仮名</span> should be inlined as

<p class="figure">振り仮名(ふりがな)

and therefore marked up as

<pre highlight=html>

&lt;ruby>

&lt;rb>振&lt;/rb>&lt;rb>り&lt;/rb>&lt;rb>仮&lt;/rb>&lt;rb>名&lt;/rb>

&lt;rp>(&lt;/rp>&lt;rt>ふ&lt;/rt>&lt;rt>り&lt;/rt>&lt;rt>が&lt;/rt>&lt;rt>な&lt;/rt>&lt;rp>)&lt;/rp>

&lt;/ruby></pre>

However, when displayed as ruby, the “り” should be hidden

<div class="figure">

<img src="images/furigana-separate.png" width="160" height="73"

alt="Hiragana annotations for 振り仮名 appear, each pronunciation above its kanji base character.">

<p class="caption">Hiragana ruby for <span lang=ja>振り仮名</span>. Notice there is no hiragana annotation above <span lang=ja>り</span>, since it is already in hiragana.

</div>

</div>

<div class="example">

The Japanese word in this example is composed of three kanji characters,

one of which is taught in first grade,

while the other two are more advanced.

(Characters colored to show base-pair correspondences.)

<xmp highlight=html>

<ruby><rb>昆<rb>虫<rb>記<rt>こん<rt class=easy>ちゅう<rt>き</ruby>

</xmp>

<figure>

<img src="images/ruby-pairing-full.png" width="122" height="55"

alt="昆虫記, with phonetic annotations on all three characters.

Because the middle annotation is wider than its base,

space has been introduced around the base character

to prevent its annotation from colliding with the adjacent annotations.">

<figcaption>Fully annotated three-character word</figcaption>

</figure>

Although some readers might need pronunciation guidance

on all three characters,

for other audiences it is more appropriate

to hide the annotation on the easier character.

Applying ''visibility: collapse'' enables this hiding:

<figure>

<img src="images/ruby-pairing-collapse.png" width="105" height="53"

alt="昆虫記, with phonetic annotations centered over

the first and last characters.">

<figcaption>Middle annotation as ''visibility: collapse''</figcaption>

</figure>

The [=hiding=] behavior of ''visibility: collapse''

differs from ''visibility: hidden''--

which makes the annotation invisible,

but does not remove its impact on layout:

<figure>

<img src="images/ruby-pairing-invisible.png" width="122" height="55"

alt="昆虫記, with phonetic annotations on the first and last characters.

Over the second one, even though no annotation is showing,

space is reserved as if to hold it,

which pushes the base characters apart.">

<figcaption>Middle annotation as ''visibility: hidden''</figcaption>

</figure>

It also differs from ''display: none''

because ''visibility: collapse'' preserves pairing relationships,

whereas ''display: none'' removes the box from the tree entirely,

disturbing the pairing of any annotations after it:

<figure>

<img src="images/ruby-pairing-discard.png" width="107" height="55"

alt="昆虫記, with mispaired phonetic annotations:

the annotation for the second character having been removed,

the annotation for the third character is displayed over the second one.">

<figcaption>Middle annotation as ''display: none''</figcaption>

</figure>

</div>

When the [=computed value=] of 'ruby-merge' on the [=annotation container=]

is ''merge'',

[=hiding=] is disabled.

When that value is ''ruby-merge/auto'',

the user agent may decide whether to disable [=hiding=] of its annotations,

but it is recommended to enable [=hiding=]

if the user agent’s layout algorithm

produces the results similar to ''separate''.

The content comparison for [=auto-hiding=]

takes place prior to white space collapsing ('white-space') and text transformation ('text-transform')

and ignores elements (considers only the <code>textContent</code> of the boxes).

Note: Future levels of CSS Ruby may add controls for [=auto-hiding=],

but in this level it is always forced.

<h3 id="white-space">

White Space Collapsing</h3>

As discussed in [[#box-fixup]],

white space within a ruby structure is <a href="#anon-gen-discard-space">discarded</a>:

<ul>

<li>at the beginning and end of a [=ruby container=], [=annotation container=], or [=base container=],

<li>between a [=base container=] and its following [=annotation container=],

<li>between [=annotation containers=].

</ul>

<div class="example">

For example, the following markup will display without any spaces:

<pre highlight=html>

&lt;ruby>

&lt;rb>東&lt;/rb>&lt;rb>京&lt;/rb>

&lt;rt>とう&lt;/rt>&lt;rt>きょう&lt;/rt>

&lt;rtc>&lt;rt>Tō&lt;/rt>&lt;rt>kyō&lt;/rt>&lt;/rtc>

&lt;/ruby></pre>

</div>

Between [=ruby segments=], between [=ruby bases=], and between [=ruby annotations=], however,

white space is not discarded,

and is maintained for rendering

as [=inter-base white space|inter-base=],

[=inter-annotation white space|inter-annotation=],

or [=inter-segment white space=].

(See <a href="#anon-gen-interpret-space">Interpret intra-level white space</a>, above.)

<div class="example">

The rules preserving white space allow ruby to be used with space-separated scripts such as Latin.

For example,

<pre highlight=html>

&lt;ruby>

&lt;rb>W&lt;/rb>&lt;rb>W&lt;/rb>&lt;rb>W&lt;/rb>

&lt;rt>World&lt;/rt> &lt;rt>Wide&lt;/rt> &lt;rt>Web&lt;/rt>

&lt;/ruby></pre>

They also ensure that annotated white space is preserved. For example,

<pre highlight=html>

&lt;ruby>

&lt;rb>Aerith&lt;/rb>&lt;rb> &lt;/rb>&lt;rb>Gainsborough&lt;/rb>

&lt;rt>エアリス&lt;/rt>&lt;rt>・&lt;/rt>&lt;rt>ゲインズブール&lt;/rt>

&lt;/ruby></pre>

</div>

Where undiscarded white space is [=collapsible white space|collapsible=],

it will collapse across adjacent boxes in each line box

following the standard <a href="https://www.w3.org/TR/css3-text/#white-space-rules">white space processing rules</a> [[!CSS-TEXT-3]].

Annotations in separate [=ruby segments=]

or separated by [=hidden annotations=]

are not considered adjacent;

however all base-level content

(including [=inter-character annotations=],

which are treated as [=atomic inlines=])

is.

For [=collapsible white space=] between [=ruby segments=] ([=inter-segment white space=]),

the contextual text for determining [[css-text-3#line-break-transform|segment break transformations]]

is thus given by the [=ruby bases=] on either side,

not necessarily the text on either side of the white space in source document order

(which could include [=interlinear annotations=]).

<div class="note">

Note: The white space processing rules

cause a white space sequence containing a [=segment break=] (such as a line feed)

to <a href="https://www.w3.org/TR/css3-text/#line-break-transform">collapse to nothing</a> between Han and Kana characters.

This means that Chinese and Japanese ruby can safely use white space for indentation of ruby markup.

For example, the following markup will display without any spaces:

<pre highlight=html>

&lt;ruby>

屋&lt;rt>おく&lt;/rt>内&lt;rt>ない&lt;/rt>

禁&lt;rt>きん&lt;/rt>煙&lt;rt>えん&lt;/rt>

&lt;/ruby></pre>

However, white space that does not contain a [=segment break=] does not collapse completely away,

so this markup will display with a space between the first and second ruby pairs:

<pre highlight=html>

&lt;ruby>

屋&lt;rt>おく&lt;/rt> 内&lt;rt>ない&lt;/rt>

禁&lt;rt>きん&lt;/rt> 煙&lt;rt>えん&lt;/rt>

&lt;/ruby></pre>

</div>

<h2 id="ruby-layout">

Ruby Layout</h2>

When a ruby structure is laid out,

its [=base level=] is initially laid out on the line

exactly as if its [=ruby bases=] were a regular sequence of [=inline boxes=]

and the [=ruby container=] a regular [=inline box=] wrapped around it.

If a [=ruby container=] has any [=inter-character annotations=],

they are laid out into the [=base level=] as detailed in [[#inter-character-layout]].

Subsequently,

the [=base container=] is sized and

[=interlinear annotations=] are laid out

as detailed in [[#interlinear-layout]].

As in other CSS layout models,

relative positioning, transforms, and other graphical effects

apply after this layout of the boxes.

<h3 id="interlinear-layout">

Interlinear Ruby Layout</h3>

[=Interlinear=] [=ruby annotations=] within a level

are initially laid out as if they were [=inline boxes=]

participating in the same [=inline formatting context=],

effectively establishing a [=line box=]

for that [=level=] of annotation in the [=ruby container=].

[=Annotations=] and [=bases=] are aligned to each other

by adjusting their spacing as described below.

<h4 id="interlinear-inline">

Inline-axis Interlinear Layout</h4>

In the inline axis, [=interlinear=] [=ruby annotations=] are aligned

with respect to their [=ruby base boxes=]

in accordance with their [=annotation container=]’s 'ruby-merge' value.

When 'ruby-merge' is ''ruby-merge/separate'',

each [=ruby column=] is sized

to the widest content ([=ruby base=] or [=ruby annotation=]) in that [=column=].

In the case of [=spanning annotations=]

(whether actually spanning or pretending to span per ''ruby-merge: merge''),

if the content of a [=spanning annotation=] would be wider

than the [=columns=] that it spans,

then the difference is distributed equally among the spanned [=columns=].

If a [=ruby segment=] contains multiple [=spanning annotations=],

this distribution of additional space

is performed starting with the [=spanning annotations=]

that span the least number of bases,

and then in increasing number of bases spanned.

Each [=ruby base=] and [=ruby annotation=]

is then sized to exactly span its column(s).

Note: If there are multiple annotations in different levels spanning the same number of bases

that overlap but do not coincide,

the distribution of space is undefined.

Note this is not possible with HTML markup,

but can happen in markup languages with explicit spanning such as in [[RUBY]].

If any [=ruby annotation=] in an [=annotation container=] with ''ruby-merge: auto''

is wider than its [=ruby base|base=],

then [=ruby annotations=] in that [=annotation container=]

may extend outside of their [=column=](s).

When they do, their influence on

the measure of the [=columns=] they intersect

is up to the user agent,

provided that the [=ruby segment=] is made wide enough to fit all its content.

[=Inter-character=] annotations are interleaved between columns:

they factor into measurement of annotations that span both adjacent columns,

but are not included in either column

and are never affected by the sizing or positioning

of [=interlinear annotations=].

Within each [=base=] and [=annotation=] box,

how the extra space is distributed

when its content is narrower than the measure of the box

is specified by its 'ruby-align' property.

<div class=example>

The following diagrams illustrate these rules,

covering typical situations

as well as a few more complex ones.

In each case,

[=base boxes=] and [=annotation boxes=] are assumed to have ''ruby-align: center'',

while <!--[=base containers=] and --> [=annotation containers=] are assumed to have ''ruby-align: space-between''.

Blue brackets (<samp class=base>[ ]</samp>) represent [=base boxes=],

red brackets (<samp class=annot>[ ]</samp>) represent [=annotation boxes=],

and gray bars (<samp class=column>|</samp>) represent the limits of [=ruby columns=].

[=Ruby containers=], [=base containers=], and [=annotation containers=] are omitted.

<dl>

<dt id=ex-separate>Separate / non-spanning:

<dd>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a2 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span>annotation-3<span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span>base 1<span class=base>]</span><span class=column>|</span><span class=base>[</span>base 2<span class=base>]</span><span class=column>|</span><span class=base>[</span> base 3 <span class=base>]</span><span class=column>|</span>

</pre>

Boxes within each [=column=] are sized to match the widest box of that [=column=].

The value of 'ruby-align' on each [=base box=] and [=annotation box=] is used

to distribute the extra space in each box.

<dt id=ex-short-span>Spanning (short):

<dd>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> short span <span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span>base 1<span class=base>]</span><span class=column>|</span><span class=base>[</span>base 2<span class=base>]</span><span class=column>|</span><span class=base>[</span>base 3<span class=base>]</span><span class=column>|</span>

</pre>

When a [=spanning annotation=] is shorter than the spanned [=bases=],

there is no extra space to distribute to these [=bases=].

Extra space within the [=spanning annotation=]

is distributed according to 'ruby-align' on that [=annotation box=],

as for non spanning ones.

<dt id=ex-long-span>Spanning (long):

<dd>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span>spanning annotation<span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span>base 1<span class=base>]</span><span class=column>|</span><span class=base>[</span> base 2 <span class=base>]</span><span class=column>|</span><span class=base>[</span> base 3 <span class=base>]</span><span class=column>|</span>

</pre>

When the [=spanning annotation=] is longer than the spanned [=base boxes=],

the extra space is distributed equally between them.

<dt id=ex-short-merge>Merged (short):

<dd>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span>merged annotation<span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span>base 1<span class=base>]</span><span class=column>|</span><span class=base>[</span>base 2<span class=base>]</span><span class=column>|</span><span class=base>[</span>base 3<span class=base>]</span><span class=column>|</span>

</pre>

A [=merged annotation=] behaves similarly to a [=spanning=] one,

except that distribution of any extra space in it

is determined by the value of 'ruby-align' on the [=annotation container=],

not on any of its [=annotation boxes=].

<!--

<dt id=ex-long-merge>Merged (long):

<dd>

<pre>

|[This is a long merged annotation]| <- no extra space, nothing to align

|[ Base 1 ]|[ Base 2 ]|[ Base 3 ]| <- uses ruby-align on each base like for a spanner?

or maybe (see https://github.com/w3c/csswg-drafts/issues/6004)

|[Base 1 Base 2 Base 3]| <- treats the bases as merged as well?

</pre>

-->

<dt id=ex-multi-level-span>Several levels, with spanning annotation:

<dd>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> annotation-2 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a3 <span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=annot>[</span>long annotation spanning all content<span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span> base 1 <span class=base>]</span><span class=column>|</span><span class=base>[</span> base 2 <span class=base>]</span><span class=column>|</span><span class=base>[</span> base 3 <span class=base>]</span><span class=column>|</span>

</pre>

<pre class=highlight>

<span class=column>|</span><span class=annot>[</span> xx <span class=annot>]</span><span class=column>|</span><span class=annot>[</span>annotation spanning bases<span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=annot>[</span> a1 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> annotation-2 <span class=annot>]</span><span class=column>|</span><span class=annot>[</span> a3 <span class=annot>]</span><span class=column>|</span>

<span class=column>|</span><span class=base>[</span>base 1<span class=base>]</span><span class=column>|</span><span class=base>[</span> base 2 <span class=base>]</span><span class=column>|</span><span class=base>[</span> base 3 <span class=base>]</span><span class=column>|</span>

</pre>

In these two examples with multiple [=levels=],

each [=column=] is sized to its longest content,

and [=spanning annotations=] that are still longer

than the sum of the [=columns=] that they span

grow them further,

adding to each equally.