Annotazione Ruby

1.1 Cosa è ruby?

Ruby é il termine che viene usato per una piccola riga di testo associata con un´altra riga di testo, chiamata testo base. Il testo Ruby si usa per fornire un´annotazione corta al testo base associato. E molto usato per fornire la lettura (guida di pronuncia). Le annotazioni Ruby si usano spesso in Giappone in diversi tipi di pubblicazioni, inclusi libri e riviste. Ruby si usa anche in Cina, specialmente per libri di testo nelle scuole.

Il testo Ruby si usa, in genere, lungo il testo base, usando una più piccola typeface. Il nome "ruby", di fatto, deriva del nome della fonte 5.5pt della tipografia britannica, cioé quasi la metá della fonte di 10pt usata di solito per testi normali. Figura 1.1 mostra un esempio, tre ideogrammi (kanji) come testo base, e sei hiragana esprimendo la lettura (shinkansen – treno palla giapponese).

La tipografia dell´Asia Orientale ha sviluppato alcuni tratti distintivi che non appaiono nelle tipografie occidentali. La maggioranza può essere direzionata correttamente con linguaggi di fogli di stile come CSS o XSL. Comunque, si richiede una marcatura adizionale per definire l´associazione tra testo base e testo ruby.

Questa specifica definisce quella marcatura, disegnata per essere usata con XHTML, affinchè il testo ruby sia disponibile nella Web senza usare grafichi o complementi speciali. Sebbene questa specifica fornisce esempi di veri presentazioni con lo scopo di far capire meglio la marcatura al numero piú grande possibile di lettori, tutti gli esempi sono soltanto informativi. Questo documento non specifica nessun meccanismo di presentazione o stile, che sono competenza dei rispettivi linguaggi di fogli di stile.

A volte più di un testo ruby é associato con lo stesso testo base. Un esempio tipico é indicare tanto il significato quanto la lettura dello stesso testo base. In questi casi i testi ruby possono apparire in entrambi i lati del testo base. Il testo ruby prima del testo base spesso si usa per indicare la lettura, il testo ruby dopo il testo base spesso si usa per indicare significato. Figura 1.2 é un esempio di testo base con due testi ruby che danno la lettura usando hiragana e lettere latine.

Inoltre, ogni testo ruby può essere associato con diverse, ma sovrapposte, parti del testo base, come nel seguente esempio:

In questo esempio, il testo base é la data "10 31 2002". Un testo ruby é la frase "Data Scadenza". Il testo ruby viene associato con l´intero testo base. L´altro testo ruby ha tre parti: "Mese", "Giorno” e "Anno". Ogni parte si associa con una parte diversa del testo base. "Mese" è associato con "10", "Giorno" con "31", e "Anno" con "2002".

1.2 La marcatura Ruby

La marcatura definita in questa specifica é disegnata per coprire tutti i casi che abbiamo visto, specialmente marcatura per uno o due testi ruby associati con lo stesso testo base e marcatura per associazioni di catene di testo(i) ruby con componenti del testo base.

Vi sono due varianti della marcatura ruby, nominate marcatura ruby semplice (simple ruby markup) e marcatura ruby complessa (complex ruby markup). La marcatura ruby semplice associa un singolo testo ruby con una riga del testo base. La marcatura ruby semplice puó anche specificare un meccanismo di sustituzione per permettere visualizzare i testi ruby nei navigatori piú vecchi che non possono riconoscere la marcatura ruby. La marcatura ruby complessa può associare due testi ruby con un solo testo base e puó definire una associazione piú minuta e accurata tra i componenti del testo ruby e il testo base. Dobbiamo tenere conto che la marcatura ruby complessa non ha un meccanismo di sustituzione per navigatori che non riconoscano la marcatura ruby.

Questa sezione fornisce una visione generale della marcatura definita in questa specifica. Una definizione formale e completa é reperibile nella Sezione 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>10</rb>
    <rb>31</rb>
    <rb>2002</rb>
  </rbc>
  <rtc>
    <rt>Month</rt>
    <rt>Day</rt>
    <rt>Year</rt>
  </rtc>  <rtc>
    <rt rbspan="3">Expiration Date</rt>
  </rtc></ruby>

3.1 Ruby nella Web contro l´uso tipografico tradizionale

Il termine "ruby" in Giapponese si usa soltanto per testi visualizzati lungo il testo base. Nelle sezione 3.2 (dimensioni di fonte), sezione 3.3 (posizionamento), e sezione 3.4 (presentazione della marcatura ruby) si forniscono considerazioni per questi casi. Questo tipo di presentazione deve essere usata sempre che sia possibile. Dobbiamo tenere conto che introdurre ruby nella Web può trarre certi problemi che non compaiono nella tipografia tradizionale. Marcature strutturali per ruby, come le definite in questa specifica, non possono garantire che il test ruby sia sempre presentato lungo il testo base. C´è una varietà molto grande di dispositivi output, attuali e futuri, per documenti marcati con XHTML. I seguenti sono scenari possibili di presentazioni diverse:

• Nei user agents non visuali come voice browsers e braille user agents, soltanto è possibile una presentrazione sequenziale. Vedi sezione 3.5 per più considerazioni sulla presentazione non visuale.
• Nei dispositivi di visualizzazione di bassa risoluzione, visualizzare testi ruby nella dimensione usuale può non essere fattible. Si può ricorrere a meccanismi di sostituzione. Vedi sezione 3.6 per particolari.
• A volte può essere interessante, per motivi educativi, nascondere il testo ruby e che sia disponibili come informazioni che scocchi quando sia preciso. Questo sarebbe impossibile in foglio, e molto facile in un dispositivo di visualizzazione dinamico.

3.2 Dimensione di fonte (Font Size) del testo ruby

La dimensione di fonte tipica del testo ruby è circa la metà della dimensione di fonte del testo base. Di fatto, il nome "ruby" si originò del nome della dimensioni di fonte di 5.5pt font size nella tipografia britannica, cioè circa la metà della dimensione di fonte di 10pt usate per il testo normale.

3.3 Posizionamento del testo ruby

Ci sono molti posizione dove il testo ruby può apparire in relazione al suo testo base. Siccome i testi dell`Asia Orientale si presentano tanto verticalmente quanto orizzontalmente, i termini "prima" e "dopo" si usano qui di preferenza a "sopra" e "sotto" oppure "lato destro" e "lato sinistro". Le parole "prima" e "dopo" devono essere capite come "prima"/"dopo" la linea che contiene il testo base. La corrispondenza si mostra nella seguente tabella:

I testi Ruby si mettono più frequentemente prima del testo base (vedere figura 1.1 e figura 3.2). A volte, specialmente nei documenti educativi orizzontali, il testo ruby può apparire dopo il testo base, ad esempio sotto (vedere figura 3.1). In Cinese, è abbastanza comune che il testo Pinyin ruby appaia dopo il testo base. Il testo Ruby può anche apparire dopo il testo base in una configurazione verticale (vedere figura 3.3). In tutti questi casi, la direzione della scrittura del testo ruby è la medesima di quella del testo base, cioè: verticale se il testo base è verticale, e orizzontale se il testo base è orizzontale.

Nei testi cinesi tradizionali, il testo ruby "Bopomofo" può apparire lungo il lato destro del testo base anche in una configurazzione orizzontale.

Si prenda nota che le marche di tono Bopomofo (nel esempio mostrate in rosso per chiarezza) sembrano apparire in una colonna separata (lungo il lato destro del testo ruby Bopomofo) e quindi sembrano "ruby di ruby". Comunque, sono semplicemente codificate come parte del testo ruby. I particolari di questa codifica non sono disponibili in questo documento.

3.4 Presentazione della marcatura ruby

Questa specifica non prescrive come si visualizzerà la marcatura ruby. In genere, i fogli di stile specificheranno il comportamento della marcatura ruby.

Per permettere che i fogli di stile possano applicare lo stile, o per altri meccanismi di presentare correttamente il testo ruby, è molto importante fornire la informazione che sia sufficiente sulla funzione di ogni componente. L`esempio seguente mostra l`uso degli attributi di classe affinchè i fogli di stile definiscano la presentazione essatta del testo ruby. La classe "reading" si usa per un testo ruby che indica lettura. La classe "annotation" si usa per indicare un testo ruby che si usa per annotazioni. L` attributo xml:lang indica il linguaggio del testo.

<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>

Usando un foglio di stile che specifichi un testo orizzontale, una presentazione della lettura prima del testo base, e una presentazione della annotazione dopo il testo base, la marcatura presentata prima potrebbe presentarsi così:

3.5 Considerazioni per presentazioni non visuali

I documenti che contengono marcatura ruby a volte bisognano essere eseguiti per user agents non visuali come voice browsers e braille user agents. In questi scenari di presentazione, è importante sapere che:

• Secondo l` user agent e la situazione, la maniera di eseguire la presentazione corretta è diversa.
• Testi ruby che rappresentino lettura forse dovranno essere trattati diversamente di quello che contegano altra informazione.
• Per una presentazione non visuale corretta è importante indicare la funzione di ogni testo ruby.
• Spesso vi sono differenze tra la lettura indicata dal testo ruby e la corretta.
• Il lettore può essere interessato in cercare informazione sul testo base (ideografico).

Il modo di lettura del testo può variare tra molto molto veloce e molto attento e dittagliato, secondo le necessità del utente; e per questo i modi di trattare testi ruby in una presentazione non visuale vanno da saltellare in lettura veloce a una esplorazione accurata della struttura ruby e dei caratteri.

Quando i testi ruby rappresentano pronuncia, come accade spesso, presentare tanto il testo base quanto il testo ruby può portare a una duplicazione noiosa. Un sintetizzatore di voce può pronunciare correttamente il testo base grazie a un ampio dizionario o selezionare la pronuncia corretta sulla base della informazione del testo ruby.

Non tutti i testi ruby rappresentano la pronuncia. Gli autori devono distinguere quale sia la funzione dei testi ruby usando l`attributo class. Questo è dimostrato prima usando class="reading" per testi ruby con lo scopo di indicare pronuncia.

I testi ruby che indicano la lettura a volte non la indicano correttamente, anche quando la scrittura usata sembrasse essere perfettamente fonetica. Per esempio, Bopomofo è associato indipendentemente per ogni carattere del testo base; il suono dipendente del contesto o i cambiamenti di tono si perdono. Similmente, in Giapponese, accadono irregolarità nel sillabare, come usare"は" (hiragana ha) per il suffiso tematico pronunciato "わ" (wa), oppure usare vocali per indicare lunghezza. In questi casi, gli autori possono desiderare fornire la vera pronuncia con una marcatura speciale designata per tale scopo o confidarsi nella capacità del sistema di presentazione per maneggiare questi casi correttamente.

3.6 Alternattive al elemento rp

Se l`autore non è interessato sui meccanismi di sostituzione per user agents che nè conoscano la marcatura ruby nè usino i fogli di stile CSS2 [CSS2] o XSL [XSL] non c´è bisogno degli elementi rp.

Tuttavia, è possibile mettere fra parentesi i testi ruby come sostituzione se, ad esempio la risoluzione del dispositivo non permette la tradizionale presentazione ruby. Usando [CSS2], i parentesi possono generarsi tramite 'content' property ([CSS2], sezione 12.2) con gli :before and :after pseudo-elements ([CSS2], sezione 12.1), come nel seguente frammento di stile come esempio:

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

Nel esempio, i parentesi si crearanno automaticamente all´intorno del elemento rt. Si presume che le regole di stile menzionate si devono usare insieme con le regole di stile che posizionano il testo ruby inline. La generazione di parentesi non presenta problemi con XSLT [XSLT].