L'annotation ruby

1.1 Qu'est-ce que le ruby ?

Le terme ruby désigne un passage de texte associé à un autre passage de texte, appelé texte de base. Le texte ruby sert à fournir une brève annotation au texte de base associé. Il est utilisé le plus souvent pour fournir une glose (guide de prononciation). Les annotations ruby sont fréquemment utilisées au Japon dans beaucoup de types de publications, y compris les livres et les magazines. On l'utilise également en Chine, notamment dans les livres scolaires.

Le texte ruby se présente habituellement le long du texte de base avec des caractères plus petits. Le nom ruby provient en réalité du nom du corps de police 5,5 pt de la tradition typographique anglaise, correspondant à peu près à la moitié du corps de police 10 pt servant habituellement pour le texte normal. La figure 1.1 est un exemple avec trois idéogrammes (kanji) comme texte de base et six caractères hiragana donnant la glose (shinkansen, c'est-à-dire le train à grande vitesse japonais).

La typographie asiatique orientale a développé plusieurs caractéristiques qui n'apparaissent pas dans la typographie occidentale. Pour la plupart, ces caractéristiques peuvent être traitées adéquatement par les langages de feuille de style, tels que CSS ou XSL. Par contre, il faut un balisage supplémentaire pour définir l'association existant entre le texte de base et le texte ruby.

La présente spécification définit un tel balisage, utilisable avec XHTML, afin que le texte ruby soit disponible sur le Web sans utiliser de palliatifs ou graphiques spéciaux. Bien que cette spécification offre des exemples de restitution réelle, afin que la majorité des lecteurs comprenne mieux le balisage, ils ne sont qu'informatifs. Ce document ne définit aucun mécanisme de présentation ou de style ; cette part revient aux langages de feuille de style respectifs.

Plusieurs textes ruby sont parfois associés au même texte de base. Un exemple typique indiquerait à la fois la signification et la prononciation du même texte de base. Auquel cas, les textes ruby peuvent apparaître des deux côtés du texte de base. Le texte ruby avant le texte de base sert souvent à indiquer la prononciation, celui après le texte de base à indiquer la signification. La figure 1.2 montre un exemple de texte de base avec deux textes ruby, donnant une glose avec des caractères hiragana et des lettres latines.

En outre, chaque texte ruby peut être associé à des parties différentes mais chevauchantes du texte de base, comme dans l'exemple suivant :

Dans cet exemple, le texte de base est la date 31 10 2002. Un texte ruby est la phrase Date d'expiration. Ce texte ruby est associé à la totalité du texte de base. L'autre texte ruby est constitué de trois parties : Jour, Mois et Année. Chacune est associée à une partie différente du texte de base. La partie Jour est associée à 31, la partie Mois à 10, et la partie 2002 à Année.

1.2 Aperçu du balisage ruby

Le balisage définit dans cette spécification est conçu pour couvrir tous les cas précédents, à savoir le balisage d'un ou deux textes ruby associés au même texte de base et le balisage d'associations de sous-chaînes du (ou des) texte(s) ruby aux composants du texte de base.

Il existe deux variantes de balisage ruby, appelés balisage ruby simple et balisage ruby complexe. Le balisage ruby simple associe un seul texte ruby au passage de texte de base. Le balisage ruby simple peut également définir un mécanisme de repli qui permet un affichage du texte ruby par les navigateurs (anciens) ne reconnaissant pas le balisage ruby. Le balisage ruby complexe permet d'associer deux textes ruby à un seul texte de base, et de définir une association de granularité plus fine entre les composants du texte ruby et le texte de base. Par contre, le balisage ruby complexe n'offre aucun mécanisme de repli aux navigateurs qui ne reconnaissent pas le balisage ruby.

Cette section présente un aperçu du balisage ruby défini dans cette spécification. La définition formelle complète se trouve dans la section 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>Jour</rt>
    <rt>Mois</rt>
    <rt>Année</rt>
  </rtc>
  <rtc>
    <rt rbspan="3">Date d'expiration</rt>
  </rtc>
</ruby>

3.1 Le ruby sur le Web contre l'utilisation typographique traditionnelle

Le japonais utilise le terme ruby seulement pour désigner le texte restitué visuellement le long du texte de base. Ces cas sont considérés dans la section 3.2 (le corps de la police), la section 3.3 (le positionnement) et la section 3.4 (la présentation du balisage ruby). On devrait utiliser ce type de présentation à chaque fois que possible. Toutefois, l'introduction de ruby dans le Web peut amener des phénomènes et des problèmes qui n'existent pas dans la typographie traditionnelle. Le balisage structurel de ruby, comme défini dans cette spécification, ne garantit pas toujours une restitution du texte ruby le long du texte de base. Beaucoup de périphériques de sortie divers peuvent traiter ou traiteront les documents balisés avec XHTML. Voici les scénarios et raisons possibles de ces restitutions différentes :

• Pour les agents utilisateurs non visuels comme les navigateurs vocaux et les dispositifs Braille, seule est possible une restitution séquentielle. Cf. la section 3.5 pour des précisions à propos de la restitution non visuelle ;
• Pour les écrans de faible résolution, l'affichage du texte ruby dans le corps de police habituel sera peut-être infaisable. On peut utiliser des solutions de repli. Cf. la section 3.6 pour des précisions ;
• Pour des besoins éducatifs, il sera parfois intéressant de cacher le texte ruby et de le proposer en incrustation. C'est impossible sur du papier mais très facile sur un écran dynamique.

3.2 Le corps de police du texte ruby

En utilisation habituelle, le corps de police du texte ruby fait normalement la moitié de celui du texte de base. En fait, l'origine du nom ruby remonte au nom du corps de police de 5,5 pt de la tradition typographique anglaise, correspondant à environ la moitié du corps de police 10 pt utilisé couramment pour un texte normal.

3.3 Le positionnement du texte ruby

Le texte ruby peut apparaître à des positions différentes par rapport à son texte de base. Comme le texte asiatique oriental peut être restitué tant verticalement qu'horizontalement, on emploie les termes avant et après plutôt que au-dessus et au-dessous, ou à gauche et à droite. On devrait comprendre avant et après comme signifiant avant/après la ligne contenant le texte de base. La correspondance apparaît dans le tableau suivant :

Les textes ruby se placent le plus souvent avant le texte de base (cf. la figure 1.1 et la figure 3.2). Parfois, notamment dans les documents éducatifs horizontaux, le texte ruby peut apparaître après le texte de base, c'est-à-dire au-dessous (cf. la figure 3.1). En chinois, le texte ruby Pinyin apparaît assez couramment après le texte de base. Le texte ruby peut aussi apparaître après le texte de base dans une composition verticale (cf. la figure 3.3). Dans tous ces cas, la direction d'écriture du texte ruby est la même que celle de son texte de base, c'est-à-dire verticale quand le texte de base est vertical, et horizontale quand le texte de base est horizontal.

Dans les textes chinois traditionnels, le texte ruby Bopomofo peut apparaître le long à droite du texte de base, même dans une composition horizontale.

Remarquez que les signes de ton Bopomofo (en rouge dans l'exemple précédent pour la lisibilité) semblent apparaître dans une colonne séparée (le long à droite du texte ruby Bopomofo), et peuvent donc être perçus comme des ruby de ruby. Elles font pourtant partie du codage du texte ruby. Le détail de ce codage n'est pas traité dans ce document.

3.4 La présentation du balisage ruby

Cette spécification ne prescrit pas comment afficher le balisage ruby. On utilisera généralement les feuilles de style pour définir le comportement exact du balisage ruby.

Pour que les feuilles de style puissent s'appliquer, ou que d'autres mécanismes puissent correctement restituer un texte ruby, il est très important de fournir des informations suffisantes à propos de la fonction de chaque composant. L'exemple suivant montre l'utilisation de l'attribut class pour permettre aux feuilles de style de définir la présentation exacte du texte ruby. La classe "prononciation" sert pour un texte ruby indiquant la prononciation. La classe "annotation" sert pour un texte ruby indiquant une annotation. L'attribut xml:lang indique la langue du texte.

<ruby xml:lang="ja">
  <rbc>
    <rb>斎</rb>
    <rb>藤</rb>
    <rb>信</rb>
    <rb>男</rb>
  </rbc>
  <rtc class="prononciation">
    <rt>さい</rt>
    <rt>とう</rt>
    <rt>のぶ</rt>
    <rt>お</rt>
  </rtc>
  <rtc class="annotation">
    <rt rbspan="4" xml:lang="en">Vice-Président du W3C</rt>
  </rtc>
</ruby>

Avec une feuille de style pour définir un texte horizontal, pour restituer la prononciation avant le texte de base et pour restituer l'annotation après le texte de base, le balisage précédent pourrait être restitué ainsi :

3.5 Les considérations de restitution non visuelle

Les documents contenant du balisage ruby seront parfois restitués par des agents utilisateurs non visuels, tels que des navigateurs vocaux et des agents utilisateurs Braille. Pour ces scénarios de restitution, il importe de noter que :

• Des méthodes de restitution différentes peuvent convenir en fonction de l'utilisateur et de la situation ;
• Il faudra peut-être traiter différemment un texte ruby représentant une prononciation et un texte ruby contenant d'autres informations ;
• Pour une restitution non visuelle adéquate, il sera nécessaire d'indiquer la fonction de chaque texte ruby ;
• Il y a souvent des différences entre la prononciation indiquée par le texte ruby et la prononciation réelle ;
• Le lecteur sera peut-être demandeur d'informations concernant le texte de base (idéographique).

Selon les besoins de l'utilisateur, la façon de lire un texte peut varier d'une lecture très rapide et superficielle à une lecture attentionnée et précise. Cela peut conduire à traiter le texte ruby de différentes façons dans une restitution non visuelle, allant de l'abandon du texte ruby en lecture rapide jusqu'à l'exploration détaillée de la structure de ruby et des caractères réels en lecture approfondie.

Dans le cas fréquent du texte ruby représentant une prononciation, la restitution du texte de base et du texte ruby peut produire des répétitions ennuyeuses. Un synthétiseur de parole sera peut-être capable de prononcer correctement le texte de base d'après un dictionnaire volumineux, ou sinon de sélectionner la bonne prononciation en fonction de celle indiquée par le texte ruby.

Les textes ruby ne représentent pas tous des prononciations. Les auteurs devraient distinguer les textes ruby utilisés pour autre chose en utilisant l'attribut class. Cela a été illustré dans l'exemple précédent avec la déclaration class="prononciation" du texte ruby pour indiquer une prononciation.

Le texte ruby indiquant une prononciation ne produira peut-être pas la prononciation exacte, même dans les cas où l'écriture utilisée semble parfaitement phonétique au premier abord. Par exemple, un Bopomofo est associé indépendamment pour chaque caractère du texte de base ; les changements de son ou de tonalité dépendant du contexte ne sont pas reflétés. De même en japonais, il peut se produire des irrégularités de diction, comme utiliser le son は (hiragana ha) pour le suffixe de substantif prononcé わ (wa), ou encore utiliser des voyelles pour indiquer un allongement. Pour ces cas, les auteurs voudront peut-être fournir la prononciation réelle à l'aide d'un balisage spécial conçu pour cet usage, ou compter sur la capacité du système de restitution sonore à manipuler correctement ces cas.

3.6 Les remplacements de l'élément rp

Si l'auteur ne se préoccupe pas de fournir des solutions de repli aux agents utilisateurs ne reconnaissant pas le balisge de ruby ni ne gérant les feuilles de style CSS2 [CSS2] ou XSL [XSL], alors les éléments rp ne sont pas nécessaires.

Néanmoins, il est possible de placer le texte ruby entre parenthèses en solution de repli, par exemple, lorsque la résolution de l'appareil n'est pas adaptée à une restitution traditionnelle de ruby. Dans le cas de [CSS2], les parenthèses peuvent être générées avec la propriété 'content' ([CSS2], section 12.2) et les pseudo-éléments :before et :after ([CSS2], section 12.1), comme par exemple dans le fragment de feuille de style suivant :

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

Dans l'exemple ci-dessus, les parenthèses seront automatiquement créées autour de l'élément rt. Les règles de style précédentes sont censées servir en même temps que des règles de style pour positionner le texte ruby en-ligne. Avec XSLT [XSLT], la génération des parenthèses est directe.