1.1 Was ist Ruby?

Ruby ist ein Begriff für einen Textbereich, der mit einem anderen Text, der sogenannten Textbasis, verbunden ist. Ruby-Text wird gebraucht, um eine kurze Erläuterung zum verknüpften Basistext zu liefern, meistens jedoch, um gewissermaßen als Ausspracheanleitung die entsprechende Lesart zu definieren. Ruby-Annotationen werden in Japan häufig als Bestandteil vieler Arten von Publikationen (wie Büchern und Zeitschriften) verwendet, aber sie finden ihre Anwendung auch in China, wo sie insbesondere in Schulbüchern herangezogen werden.

Ruby-Text wird gewöhnlich mit kleinerer Schriftart entlang des Basistextes (auch: Textbasis) dargestellt. Der Name »Ruby« stammt ursprünglich vom Namen der 5,5-Punkt-Schriftgröße im britischen Buchdruck, welche lediglich etwa die Hälfte der gewöhnlich verwendeten 10-Punkt-Größe für normalen Text beträgt. Abbildung 1.1 zeigt ein Beispiel anhand von drei Ideogrammen (Kanji) als Textbasis sowie sechs Hiragana, die die Lesart bestimmen (hier: Shinkansen, ein japanischer Hochgeschwindigkeitszug).

Die ostasiatische Typographie hat eine Vielzahl von Besonderheiten hervorgebracht, die nicht in der westlichen erscheinen. Die meisten davon können über Stylesheet-Sprachen wie CSS oder XSL ausreichend angegangen werden – trotzdem ist es notwendig, dass zusätzliches Markup die Verbindung zwischen Basis- und Ruby-Text herstellt.

Diese Spezifikation definiert ein solches Markup, das zusammen mit XHTML verwendet werden und somit im Web ohne besondere Workarounds oder Graphiken zum Einsatz kommen kann. Obwohl diese Spezifikation Beispiele zum gegenwärtigen Rendern liefert, um es den meisten Lesern leichter zu machen, das Markup zu verstehen, sind diese Beispiele nur informeller Natur. Dieses Dokument spezifiziert keinerlei Mechanismen für die Präsentation oder die Formatierung, da dies wie oben beschrieben Aufgabe der gebrauchten Stylesheet-Sprache ist.

Manchmal kann es vorkommen, dass mehr als ein Ruby-Text mit derselben Textbasis assoziiert wird. Ein typisches Beispiel ist, sowohl Bedeutung als auch Aussprache bzw. Lesart für eine Textbasis anzeigen zu wollen. In solchen Fällen können Ruby-Texte auf beiden Seiten der Textbasis erscheinen: Ruby-Text vor der Basis wird oft dazu verwendet, die Lesart darzustellen, während er hinter der Textbasis die Bedeutung aufzeigen soll. Abbildung 1.2 veranschaulicht dies anhand von zwei Ruby-Texten, die sowohl die Lesart via Hiragana als auch die Bedeutung in lateinischen Schriftzeichen festlegen.

Zusätzlich kann jeder Ruby-Text auch mit unterschiedlichen Teilen der Textbasis verknüpft werden, wie es das folgende Beispiel veranschaulicht:

In diesem Beispiel ist der Basistext das Datum »31 10 2002«. Ein Ruby-Text entspricht dem Begriff »Verfallsdatum« und wird dabei auf die komplette Textbasis angewandt, während hingegen der andere Ruby-Text in drei Teile separiert ist: »Tag«, »Monat« und »Jahr«. Jeder Teil hiervon ist mit einem unterschiedlichen Part des Basistextes verknüpft, denn »Tag« wird mit »31« assoziiert, »Monat« mit »10«, und »Jahr« mit »2002«.

1.2 Überblick über Ruby-Markup

Das in dieser Spezifikation definierte Markup wurde entworfen, um alle oben genannten Fälle abzudecken, im einzelnen also Markup für ein oder zwei Ruby-Texte, die zur selben Basis stehen, sowie Markup für Verknüpfungen von Untereinheiten von Ruby-Text mit einzelnen Bestandteilen der Textbasis.

Es gibt zwei Varianten des Ruby-Markups, die als einfaches Ruby-Markup und komplexes Ruby-Markup bezeichnet werden. Einfaches Ruby-Markup verbindet einen einzelnen Ruby-Text mit einem Basistext und bietet zusätzlich als Fallback noch einen Mechanismus, der es Browsern, die Ruby-Markup nicht parsen können, erlaubt, den Ruby-Text darzustellen. Komplexes Ruby-Markup kann zum einen zwei Ruby-Texte mit einer Basis assoziieren, zum anderen erlaubt es aber auch eine feinkörnige Verknüpfung von einzelnen Komponenten eines Ruby-Textes mit Teilen der Textbasis. Das komplexe Ruby-Markup inkludiert jedoch keinen Fallback-Mechanismus für Browser, die das Ruby-Markup nicht verstehen.

Dieser Abschnitt bietet einen Überblick über das in dieser Spezifikation definierte Markup für Ruby. Die vollständig formale Definition befindet sich in Abschnitt 2.

<ruby>
  <rb>WWW</rb>
  <rt>World Wide Web</rt>
</ruby>

<ruby>
  <rb>WWW</rb>
  <rp>(</rp><rt>World Wide Web</rt><rp>)</rp>
</ruby>

<ruby>
  <rbc>
    <rb>31</rb>
    <rb>10</rb>
    <rb>2002</rb>
  </rbc>
  <rtc>
    <rt>Tag</rt>
    <rt>Monat</rt>
    <rt>Jahr</rt>
  </rtc>
  <rtc>
    <rt rbspan="3">Verfallsdatum</rt>
  </rtc>
</ruby>

3.1 Ruby im Web vs. traditionelle typographische Verwendung

Der Begriff »Ruby« wird im Japanischen nur für Text gebraucht, der entlang eines Basistextes gerendert wird. Überlegungen zu solchen Fällen werden in Abschnitt 3.2 (Schriftgröße), Abschnitt 3.3 (Positionierung) und Abschnitt 3.4 (Darstellung von Ruby-Markup) angestellt. Diese Art der Präsentation sollte möglichst überall angewandt werden. Die Einführung von Ruby im Internet könnte jedoch zu besonderen Phänomenen und Problemen führen, die es auf dem Gebiet der traditionellen Typographie so nicht gibt. So kann strukturelles Markup für Ruby, wie es in dieser Spezifikation definiert wird, nicht garantieren, dass Ruby-Text auch immer entlang des Basistextes gerendert wird. Es gibt außerdem eine große Bandbreite an vorhandenen und zukünftigen Ausgabegeräten für Dokumente, deren Markup aus XHTML besteht, was zu folgenden Szenarien und Gründen für unterschiedliches Rendern führen kann:

• Auf non-visuellen User-Agents wie Sprach-Browsern und Braille-User-Agents ist nur sequentielles Rendern möglich; siehe Abschnitt 3.5 für weitere Überlegungen zur non-visuellen Darstellung.
• Bei Anzeigegeräten mit niedriger Auflösung mag das Darstellen von Ruby-Text in der gewöhnlichen Größe nicht realisierbar sein; siehe auch Abschnitt 3.6.
• Zu Bildungszwecken könnte es in bestimmten Fällen interessant sein, den Ruby-Text nicht anzuzeigen und nur als Popup verfügbar zu machen. Dies ist unmöglich auf Papier darzustellen, aber leicht durchführbar auf einem entsprechenden Anzeigegerät.

3.2 Schriftgröße von Ruby-Text

Im gewöhnlichen Gebrauch wird Ruby-Text mit etwa der halben Schriftgröße von der des Basistextes dargestellt. Der Name »Ruby« entspringt ursprünglich dem Namen der 5,5-Punkt-Schriftgröße im britischen Buchdruck, welche lediglich etwa die Hälfte der gewöhnlich verwendeten 10-Punkt-Größe für normalen Text beträgt.

3.3 Positionierung von Ruby-Text

Es gibt diverse Positionen, an denen Ruby-Text in Relation zu seinem Basistext erscheinen kann. Da ostasiatischer Text sowohl vertikal als auch horizontal gerendert werden kann, werden die Begriffe »vor« und »nach« hier eher gebraucht als »über« und »unter« bzw. »rechts« und »links«. Die Begriffe »vor« und »nach« sollten verstanden werden als »vor«/»nach« der Zeile, die den Basistext enthält. Der Zusammenhang wird in der folgenden Tabelle verdeutlicht:

Ruby-Texte werden meistens vor dem Basistext platziert (siehe Abbildung 1.1 und Abbildung 3.2). Manchmal kann Ruby-Text jedoch auch nach (unter) dem Basistext erscheinen, besonders bei zu Bildungszwecken horizontal ausgerichteten Dokumenten, siehe Abbildung 3.1. Auch im Chinesischen ist es eher so, dass Ruby-Text (Pinyin) nach dem Basistext folgt, ebenso in vertikalem Layout, wie es Abbildung 3.3 illustriert. In all diesen Fällen entspricht die Schreibrichtung des Ruby-Textes der des Basistextes, ergo ist sie vertikal, wenn der Basistext vertikal verläuft, und horizontal, wenn dieser horizontal verläuft.

In traditionellen chinesischen Texten kann Bopomofo-Ruby-Text sogar bei horizontaler Ausrichtung rechts entlang der Textbasis verlaufen.

Beachten Sie, dass Bopomofo-Betonungszeichen (in obigem Beispiel in rot gekennzeichnet) sich in einer separaten Spalte zu befinden scheinen (rechts entlang des Bopomofo-Ruby-Textes) und dadurch wie »Ruby in Ruby« aussehen mögen. Letztlich wurden diese Zeichen einfach als Teil des Ruby-Textes kodiert, wobei Details zu dieser Kodierung nicht in diesem Dokument erörtert werden.

3.4 Darstellung von Ruby-Markup

Diese Spezifikation schreibt nicht vor, wie Ruby-Markup dargestellt werden soll. Im Allgemeinen werden Stylesheets dafür verwendet, um das Verhalten des Markups exakt zu determinieren.

Anmerkung: Obwohl das Rendern des Ruby-Textes von Stylesheets kontrolliert werden sollte, wird empfohlen, dass visuelle User-Agents den Ruby-Text vor den Basistext platzieren, sofern nur ein Ruby-Text verwendet wird und keine Style-Informationen von Autor oder Benutzer geliefert werden. Dies sollte ebenfalls für einfaches Ruby-Markup gelten. Wenn zwei Ruby-Texte vorliegen, sollte der erste Text vor und der zweite nach dem Basistext angeordnet werden. Ein beispielhaftes Standard-Stylesheet, welches diese Formatierung beschreibt, wird von [CSS3-RUBY] oder seinem Nachfolgedokument geliefert werden.

Für non-visuelles Rendern wird bei Fehlen von Stylesheet-Informationen empfohlen, dass sowohl Basistext als auch Ruby-Text(e) unter besonderer Hervorhebung (zum Beispiel durch unterschiedliche Stimme oder Tonlage) gerendert werden, um den jeweiligen Status anzuzeigen.

Um Stylesheets zu ermöglichen, einen Stil anwenden zu können, oder um anderen Mechanismen zu erlauben, Ruby-Text in sachgemäßer Form zu rendern, ist es äußerst wichtig, genug Informationen über die Funktion jeder Komponente zu bieten. Das folgende Beispiel illustriert den Gebrauch des class-Attributs, welches Stylesheets gestattet, die exakte Darstellung des Ruby-Textes zu definieren. Die (CSS-)Klasse reading wird auf einen Ruby-Text angewandt, um die Lesart zu definieren; die Klasse annotation wird gebraucht, um anzuzeigen, dass der entsprechende Ruby-Text die Erörterung (Annotation) des Basistextes beinhaltet. Das xml:lang-Attribut zeigt die Sprache des Textes an.

<ruby xml:lang="ja">
  <rbc>
    <rb>斎</rb>
    <rb>藤</rb>
    <rb>信</rb>
    <rb>男</rb>
  </rbc>
  <rtc class="reading">
    <rt>さい</rt>
    <rt>とう</rt>
    <rt>のぶ</rt>
    <rt>お</rt>
  </rtc>
  <rtc class="annotation">
    <rt rbspan="4" xml:lang="en">W3C Associate Chairman</rt>
  </rtc>
</ruby>

Wenn ein Stylesheet gebraucht wird, um horizontalen Text und das Rendern der Lesart vor sowie das Rendern der Erläuterung nach der Textbasis zu definieren, könnte das obige Markup wie folgt gerendert werden:

3.5 Hinweise zum non-visuellen Rendern

Dokumente, die Ruby-Markup verwenden, können in manchen Fällen von non-visuellen User-Agents wie Sprach-Browsern oder Braille-User-Agents gerendert werden. In solchen Fällen ist es wichtig, folgendes zu beachten:

• Je nach Benutzer und Situation können unterschiedliche Arten des Rendern erforderlich sein.
• Ruby-Text, der eine bestimmte Lesart repräsentiert, ist möglicherweise anders zu behandeln als Ruby-Text, der andere Informationen bereitstellt.
• Für sachgemäßes non-visuelles Rendern ist es wichtig, die Funktion jedes Ruby-Text-Bereiches zu verdeutlichen.
• Es gibt häufig Unterschiede zwischen der vom Ruby-Text angezeigten Lesart und der tatsächlichen Aussprache.
• Der Leser mag daran interessiert sein, Informationen über den Basistext (Ideogramme) zu erhalten.

Je nach den Wünschen des Benutzers kann die Art, wie ein Text (vor-)gelesen wird, zwischen schneller und flüchtiger bis hin zu äußerst sorgfältiger und detaillierter Lesart variieren. Dies kann zu verschiedenen Weisen führen, nach denen Ruby-Text beim non-visuellen Rendern behandelt wird, und zwar vom Überspringen des Ruby-Textes bei schneller Lesweise bis hin zu detaillierter Wiedergabe der Ruby-Struktur und der gegenwärtigen Beschaffenheit bei sorgfältiger Lesart.

Im häufig auftretenden Fall, dass Ruby-Texte die Lesart repräsentieren, kann das Rendern sowohl des Basis- als auch des Ruby-Textes zu störenden Duplikaten führen. Ein Sprachsynthesizer könnte hier in der Lage sein, den Basistext aufgrund eines großen Wortschatzes korrekt auszusprechen, und vielleicht kann er in anderen Fällen auch die entsprechende Aussprache anhand der vom Ruby-Text gelieferten Lesart wählen.

Nicht alle Ruby-Texte repräsentieren die Aussprache des jeweiligen Basistextes. Autoren sollten Ruby-Texte, die für andere Zwecke gebraucht werden, entsprechend mit dem class-Attribut kennzeichnen. Dies wird oben anhand der Anwendung von class="reading" auf den Ruby-Text (zum Hervorheben der Lesart) illustriert.

Ruby-Text, der die Lesart anzeigt, mag nicht unbedingt die richtige Aussprache produzieren, selbst wenn das verwendete Skript auf den ersten Blick phonetisch perfekt scheint. Bopomofo beispielsweise wird mit jedem Zeichen des Basistextes unabhängig assoziiert; kontextabhängige Klang- oder Tonveränderungen werden somit nicht widergespiegelt. Ähnlich ist es im Japanischen, wo durchaus Unregelmäßigkeiten in der Schreibweise vorkommen können, etwa bei は (»hiragana ha«) für das Themensuffix, welches わ (»wa«) ausgesprochen wird, oder beim Gebrauch von Vokalen, um die Dehnung hervorzuheben. In solchen Fällen wollen Autoren vielleicht für genau diesen Zweck die tatsächliche Aussprache mit besonderem Markup bereitstellen, oder sie verlassen sich auf ein auditives Rendersystem, das in der Lage ist, solche Fälle korrekt handzuhaben.

3.6 Alternativen zum rp-Element

Wenn der jeweilige Autor sich keine Gedanken um Fallback-Mechanismen für User-Agents macht, die weder etwas über Ruby-Markup wissen noch CSS-2- [CSS2] oder XSL-Stylesheets [XSL] unterstützen, werden rp-Elemente nicht benötigt.

Nichtsdestotrotz ist es möglich, den Ruby-Text als Fallback-Lösung in Klammern zu setzen, wenn sich zum Beispiel die Geräteauflösung nicht gut für das traditionelle Rendern von Ruby eignet. Bei Gebrauch von [CSS2] können die Parenthesen über die content-Eigenschaft ([CSS2], Abschnitt 12.2) und die :before- und :after-Pseudoelemente ([CSS2], Abschnitt 12.1) generiert werden, wie zum Beispiel in dem folgenden Style-Fragment:

rt:before { content: "(" }
rt:after { content: ")" }

In dem obigen Beispiel wird das rt-Element automatisch in Klammern gesetzt. Es wird dabei vorausgesetzt, dass die obigen Style-Regeln zusammen mit anderen Regeln verwendet werden, die den Ruby-Text inline positionieren. Die Erzeugung von Parenthesen ist ebenso einfach mit XSLT [XSLT] realisierbar.