Notacja ruby

1.1. Czym jest ruby?

Ruby to termin określający fragment tekstu skojarzony z innym fragmentem tekstu, określanym mianem tekstu bazowego. Tekst ruby jest używany w celu dostarczenia krótkiej adnotacji do skojarzonego tekstu bazowego. Najczęściej określa się w ten sposób czytanie (wskazówki dotyczące wymowy). Notacja ruby jest używana najczęściej w wielu rodzajach publikacji w Japonii, m.in. w książkach i magazynach. Ruby używa się też w Chinach, zwłaszcza w podręcznikach szkolnych.

Tekst ruby jest zazwyczaj prezentowany wzdłuż tekstu bazowego, przy użyciu mniejszej czcionki. Nazwa „ruby” pochodzi od nazwy od nazwy czcionki wielkości 5,5 pt używanej w brytyjskim drukarstwie, która jest o około połowę mniejsza od czcionki wielkości 10 pt używanej zazwyczaj do normalnego tekstu. Rycina 1.1 przedstawia przykład z trzema ideogramami (kanji) jako tekst bazowy i sześcioma znakami hiragana określającymi czytanie (shinkansen — japoński szybki pociąg).

We wschodnioazjatyckiej typografii wykształciło się wiele cech niewystępujących w typografii zachodniej. Wiele z nich można osiągnąć bezpośrednio za pomocą języków arkuszy stylów, takich jak CSS czy XSL. Jednak do zdefiniowania związków pomiędzy tekstem bazowym a tekstem ruby potrzebne jest dodatkowe oznakowanie.

Niniejsza specyfikacja definiuje takie oznakowanie zaprojektowane do używania z XHTML, dzięki czemu tekst ruby jest dostępny w Sieci bez stosowania specjalnych zabiegów czy grafiki. Choć w specyfikacji tej, w celu ułatwienia zrozumienia oznakowania, podane są przykłady rzeczywistego renderowania, wszystkie one mają jedynie charakter informacyjny. Dokument ten nie określa żadnych mechanizmów prezentacji czy stylizowania; jest to pozostawione odpowiednim językom arkuszy stylów.

Bywa, że z tym samym tekstem bazowym jest skojarzony więcej niż jeden tekst ruby. Typowym przykładem jest wskazanie zarówno znaczenia, jak i czytania dla tego samego tekstu bazowego. W takich wypadkach teksty ruby mogą pojawić się po obu stronach tekstu bazowego. Często tekst ruby przed tekstem bazowym wskazuje czytanie, a po tekście bazowym — znaczenie. Rycina 1.2 przedstawia przykład tekstu bazowego z dwoma tekstami ruby wskazującymi czytanie przy pomocy znaków hiragana i liter alfabetu łacińskiego.

Poza tym każdy z tekstów ruby może być skojarzony z różnymi, lecz zachodzącymi na siebie fragmentami tekstu bazowego, tak jak w następującym przykładzie:

W tym przykładzie tekst bazowy to data „31 10 2002”. Jeden z tekstów ruby to „Data upływu ważności”. Ten tekst ruby jest skojarzony z całością tekstu bazowego. Drugi tekst ruby składa się z 3 części: „Dzień”, „Miesiąc” i „Rok”. Każda część skojarzona jest z innym fragmentem tekstu bazowego. „Dzień” jest skojarzony z „31”, „Miesiąc” jest skojarzony z „10”, a „Rok” jest skojarzony z „2002”.

1.2. Przegląd oznakowania ruby

Oznakowanie zdefiniowane w tej specyfikacji zaprojektowano tak, by obejmowało wszystkie powyższe przypadki, to znaczy oznakowanie dla jednego lub dwóch tekstów ruby skojarzonych z tym samym tekstem bazowym oraz oznakowanie służące do skojarzenia fragmentów tekstu (tekstów) ruby z częściami tekstu bazowego.

Są dwa rodzaje oznakowania ruby: proste oznakowanie ruby oraz złożone oznakowanie ruby. Proste oznakowanie ruby dokonuje skojarzenia pojedynczego tekstu ruby z sekwencją tekstu bazowego. W prostym oznakowaniu ruby można też zastosować mechanizm zabezpieczający, który umożliwia wyświetlenie tekstu ruby przez (starsze) przeglądarki nierozpoznające oznakowania ruby. Złożone oznakowanie ruby może skojarzyć dwa teksty ruby z jednym tekstem bazowym, za jego pomocą można też zdefiniować bardziej szczegółowe skojarzenia pomiędzy częściami tekstu ruby i tekstu bazowego. Złożone oznakowanie ruby nie umożliwia jednak zastosowania mechanizmu zabezpieczającego dla przeglądarek nierozpoznających oznakowania ruby.

Ten rozdział zawiera przegląd oznakowania ruby zdefiniowanego w tej specyfikacji. Pełna formalna definicja znajduje się w rozdziale 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>Dzień</rt>
    <rt>Miesiąc</rt>
    <rt>Rok</rt>
  </rtc>
  <rtc>
    <rt rbspan="3">Data upływu ważności</rt>
  </rtc>
</ruby>

3.1. Ruby w Sieci wobec tradycyjnego typograficznego zastosowania

Termin „ruby” w języku japońskim używany jest tylko w odniesieniu do tekstu renderowanego wizualnie wzdłuż tekstu bazowego. Przypadki takie rozważane są w rozdziale 3.2 (rozmiar czcionki), rozdziale 3.3 (pozycjonowanie) i rozdziale 3.4 (prezentacja oznakowania ruby). Ten rodzaj prezentacji powinien być stosowany, gdzie to tylko możliwe. Wraz z wprowadzeniem ruby do WWW mogą się jednak pojawić pewne zjawiska i problemy niewystępujące w tradycyjnej typografii. Zdefiniowane w tej specyfikacji strukturalne oznakowanie dla ruby nie daje gwarancji, że tekst ruby będzie zawsze renderowany wzdłuż tekstu bazowego. Istniejące obecnie i mogące się pojawić w przyszłości urządzenia do renderowania dokumentów z oznakowaniem XHTML charakteryzują się dużą różnorodnością. Oto możliwe sytuacje, w których uzasadnione jest odmienne renderowanie:

• W niewizualnych programach użytkownika, takich jak przeglądarki głosowe i programy brajlowskie, możliwe jest tylko renderowanie sekwencyjne. Więcej na temat renderowania niewizualnego w rozdziale 3.5.
• Wyświetlanie tekstu ruby o takiej jak zwykle wielkości na ekranach o niskiej rozdzielczości może być niewykonalne. Można wtedy użyć zabezpieczeń. Więcej informacji w rozdziale 3.6.
• W niektórych wypadkach dla celów edukacyjnych może być interesujące ukrycie tekstu ruby z jednoczesnym udostępnieniem go jako pop-up. Jest to niemożliwe na papierze, lecz łatwo wykonalne na urządzeniu z wyświetlaniem dynamicznym.

3.2. Rozmiar czcionki tekstu ruby

W typowym zastosowaniu rozmiar czcionki tekstu ruby jest równy mniej więcej połowie tekstu bazowego. W istocie nazwa „ruby” pochodzi od nazwy czcionki wielkości 5,5 pt używanej w brytyjskim drukarstwie; jest ona około połowę mniejsza od 10-punktowej czcionki zazwyczaj używanej do normalnego tekstu.

3.3. Pozycjonowanie tekstu ruby

Tekst ruby może być usytuowany względem tekstu bazowego na kilka sposobów. Ponieważ teksty wschodnioazjatyckie mogą być renderowane zarówno pionowo, jak i poziomo, używane są tutaj terminy „przed” i „po” zamiast „powyżej” i „poniżej”, czy „na prawo” i „na lewo”. Wyrazy „przed” i „po” powinny być rozumiane jako „przed”/„po” linii zawierającej tekst bazowy. Odpowiedniość między tymi terminami jest ukazana w poniższej tabeli:

Teksty ruby najczęściej umieszczane są przed tekstem bazowym (zobacz: rycina 1.1 i rycina 3.2). Czasami, zwłaszcza w dokumentach edukacyjnych o układzie poziomym, tekst może się pojawiać po tekście bazowym, tj. poniżej (zobacz: rycina 3.1). W języku chińskim tekst ruby z transkrypcją pinyin zazwyczaj umieszczany jest po tekście bazowym. Tekst ruby może pojawiać się po tekście bazowym także w układzie pionowym (zobacz: rycina 3.3). We wszystkich tych przypadkach kierunek pisania tekstu ruby jest taki sam, jak tekstu bazowego — pionowy, jeśli tekst bazowy jest pionowy, poziomy, jeśli tekst bazowy jest poziomy.

W tradycyjnych chińskich tekstach tekst ruby w alfabecie bopomofo może pojawiać się wzdłuż prawej krawędzi tekstu bazowego nawet w układzie poziomym.

Zauważ, że oznaczenia tonów bopomofo (w powyższym przykładzie w kolorze czerwonym) zdają się znajdować w osobnej kolumnie (wzdłuż prawej krawędzi tekstu ruby w bopomofo), mogą być zatem postrzegane jako „ruby na ruby”. Są one jednak zakodowane jako część tekstu ruby. Szczegóły tego kodowania wykraczają poza zakres niniejszego dokumentu.

3.4. Prezentacja oznakowania ruby

Ta specyfikacja nie przesądza o sposobie wyświetlania oznakowania ruby. Do określenia dokładnego zachowania oznakowania ruby na ogół będą używane arkusze stylów.

By umożliwić arkuszom zastosowanie stylów, a innym mechanizmom właściwe renderowanie tekstu ruby, ważne jest udostępnienie odpowiedniej ilości informacji o funkcji każdego ze składników. Następujący przykład ilustruje użycie atrybutu class w celu umożliwienia zdefiniowania przez arkusze stylów dokładnego sposobu prezentacji tekstu ruby. Klasa „czytanie” jest użyta dla tekstu ruby wskazującego czytanie. Klasa „adnotacja” jest użyta do wskazania tekstu ruby używanego do adnotacji. Atrybut xml:lang wskazuje na język tekstu.

<ruby xml:lang="ja">
  <rbc>
    <rb>斎</rb>
    <rb>藤</rb>
    <rb>信</rb>
    <rb>男</rb>
  </rbc>
  <rtc class="czytanie">
    <rt>さい</rt>
    <rt>とう</rt>
    <rt>のぶ</rt>
    <rt>お</rt>
  </rtc>
  <rtc class="adnotacja">
    <rt rbspan="4" xml:lang="pl">Wiceprzewodniczący W3C</rt>
  </rtc>
</ruby>

Przy użyciu arkusza stylów, który określałby pionowy tekst, renderowanie czytania przed tekstem bazowym i renderowanie adnotacji za tekstem bazowym, powyższe oznakowanie mogłoby być renderowane w ten sposób:

3.5. Rozważania dotyczące renderowania niewizualnego

Dokumenty zawierające oznakowanie ruby będą musiały w niektórych przypadkach być renderowane przez niewizualne programy użytkownika, takie, jak przeglądarki głosowe i brajlowskie programy użytkownika. Dla takich scenariuszy renderowania ważne jest zrozumienie, że:

• Właściwe mogą być różne sposoby renderowania, w zależności od użytkownika i od sytuacji.
• Tekst ruby oznaczający czytanie czasem będzie musiał być traktowany inaczej, niż tekst ruby zawierający inne informacje.
• Ważne dla właściwego renderowania niewizualnego jest wskazanie funkcji, jaką pełni każdy z tekstów ruby.
• Czasem występują różnice pomiędzy czytaniem wskazywanym przez tekst ruby a faktyczną wymową.
• Czytelnik może być zainteresowany zasięgnięciem informacji o (ideograficznym) tekście bazowym.

W zależności od potrzeb użytkownika, sposób czytania tekstu może być zróżnicowany: od bardzo szybkiego i pobieżnego do bardzo starannego i szczegółowego. Może to prowadzić różnego traktowania tekstu ruby w renderowaniu niewizualnym, od pomijania tekstu ruby w szybkim czytaniu do szczegółowej analizy struktury ruby i faktycznie użytych znaków w czytaniu starannym.

Gdy, jak się często zdarza, tekst ruby reprezentuje czytanie, renderowanie zarówno tekstu bazowego, jak i tekstu ruby może prowadzić do irytujących powtórzeń. Syntezator mowy może potrafić poprawnie wymawiać tekst bazowy na podstawie rozległego słownika, w innych przypadkach może potrafić wybrać prawidłową wymowę na podstawie czytania określonego przez tekst ruby.

Nie każdy tekst ruby przedstawia wymowę. Autorzy powinni rozróżniać teksty ruby używane do różnych celów przy pomocy atrybutu class. Zademonstrowano to powyżej, używając class="czytanie" dla tekstu ruby wskazującego czytanie.

Tekst ruby wskazujący czytanie może nie prowadzić do prawidłowej wymowy nawet wtedy, gdy użyte pismo na pierwszy rzut oka wygląda na idealnie fonetyczne. Na przykład bopomofo jest kojarzone niezależnie dla każdego znaku tekstu bazowego; nie są przy tym oddawane dźwięki zależne od kontekstu, czy zmiany tonu. Podobnie, w języku japońskim mogą wystąpić nieregularności ortograficzne, takie jak używanie „は” (ha w hiragana) jako przedrostka tematu wymawianego „わ” (wa), bądź używanie samogłosek do wskazywania przedłużenia. W takich przypadkach autorzy mogą chcieć opatrzyć właściwą wymowę stworzonym specjalnie do tego celu oznakowaniem, mogą też zdać się na system renderujący dźwięk potrafiący prawidłowo obsłużyć takie przypadki.

3.6. Alternatywy dla elementu rp

Jeśli autorowi nie zależy na zabezpieczeniach dla programów użytkownika nierozpoznających oznakowania ruby ani nieobsługujących arkuszy stylów CSS2 [CSS2] lub XSL [XSL], elementy rp są niepotrzebne.

Mimo to, możliwe jest zastosowanie zabezpieczenia w postaci objęcia tekstu ruby nawiasami, jeśli na przykład rozdzielczość urządzenia nie jest odpowiednia dla tradycyjnego renderowania ruby. W [CSS2] nawiasy mogą być generowane przy użyciu właściwości content ([CSS2], rozdział 12.2) wykorzystując pseudoelementy :before i :after ([CSS2], rozdział 12.1), tak jak w następującym fragmencie stylu:

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

W powyższym przykładzie nawiasy zostaną automatycznie dodane wokół elementu rt. Zakłada się, że powyższe reguły stylów używane są razem z regułami stylów umieszczającymi tekst ruby wewnątrz wiersza. Generacja nawiasów jest prosta również przy użyciu XSLT [XSLT].