H62Usar el elemento ruby

Aplicabilidad

HTML

Descripción

El objetivo de esta técnica es usar la anotación ruby para proporcionar información sobre la pronunciación y el significado de una secuencia de texto cuyo significado viene determinado por su pronunciación.

Hay muchos idiomas en los que una secuencia de texto puede significar cosas distintas según cómo se pronuncie. Esto es habitual en las lenguas de Asia oriental, así como en hebreo, árabe y otros idiomas; también ocurre en inglés y en otras lenguas de Europa occidental.

La anotación ruby permite al autor anotar un «texto base», proporcionando una guía de pronunciación y, en algunos casos, también una definición. El ruby se usa habitualmente para textos en japonés y en otras lenguas de Asia oriental.

Hay dos tipos de marcado ruby: simple y complejo. El marcado ruby simple se aplica a una secuencia de texto, como una palabra o frase completa. Esta se conoce como texto «base» (elemento rb). La anotación ruby que indica cómo pronunciar el término (el elemento rt, o texto ruby) se muestra con una fuente más pequeña. (El término «ruby» procede de una fuente pequeña que se usaba con este fin en los textos impresos.) El texto ruby suele mostrarse encima del texto base o inmediatamente antes de él, es decir, justo encima del texto horizontal o justo a la derecha del texto vertical. A veces, en japonés se usa el ruby para dar el significado del texto en el lado del texto base opuesto (visualmente) al de la anotación fonética. El marcado ruby simple también ofrece una opción de «contenido alternativo» (fallback) para los agentes de usuario que no admiten marcado ruby (es decir, agentes de usuario que no admiten HTML).

El marcado ruby complejo permite dividir el texto base en unidades más pequeñas, cada una de las cuales puede asociarse con una anotación ruby independiente. El marcado ruby complejo no admite la opción de contenido alternativo.

La anotación ruby es poco habitual en idiomas como el hebreo, en los que las fuentes Unicode pueden incluir signos diacríticos que transmiten la pronunciación. También es poco habitual en inglés y en las lenguas europeas.

Nota: el motivo principal para indicar la pronunciación mediante ruby o cualquier otro medio es hacer que el contenido sea accesible para las personas con discapacidad que podrían leer y comprender el idioma del contenido si se les proporcionase información sobre la pronunciación. No es necesario proporcionar información sobre la pronunciación para las personas que no están familiarizadas con el idioma del contenido.

Ejemplos

<p>When we talk about these guidelines, we often just call them
  <ruby>
    <rb>WCAG</rb>
    <rp>(</rp>
      <rt>Wuh-KAG</rt>
    <rp>)</rp>
  </ruby>.
</p>

<p>
  <ruby>
    <rb>慶應大学</rb>
    <rp>(</rp>
    <rt>けいおうだいがく</rt>
    <rp>)</rp>
  </ruby>
</p>

Pruebas

Técnicas relacionadas

• G102: Proporcionar la expansión o la explicación de una abreviatura

Recursos

• W3C Ruby Annotation (especificación de anotación ruby del W3C)
• CSS Ruby Annotation Layout Module (módulo de maquetación de anotaciones ruby de CSS)
• W3C Internationalization Techniques: "Using Ruby Markup" (técnicas de internacionalización del W3C: uso del marcado ruby)
• HTML: el elemento ruby
• HTML: el elemento rp
• HTML: el elemento rt