Element HTML ruby reprezentuje adnotacje ruby do tekstu, które są umieszczane nad nim, pod nim lub obok niego. Jego głównym zastosowaniem jest pokazywanie wymowy znaków w językach wschodnioazjatyckich, ale może być używany także w innych typach tekstu.
Adnotacje ruby (lub rubi) to małe znaki zapisu fonetycznego, które umieszcza się nad chińskimi lub japońskimi ideogramami lub po ich prawej stronie jako wskazówkę dotyczącą sposobu ich wymowy. W odniesieniu do pisma japońskiego takie adnotacje nazywają się furigana.
Objaśniane ideogramy są umieszczane w elemencie ruby, natomiast dotyczące ich adnotacje umieszcza się w elemencie rt. Dodatkowo można używać elementu rp określającego sposób prezentowania adnotacji w przeglądarkach, które nie obsługują elementu ruby.
Przykład użycia elementu HTML ruby
Japoński ideogram oznaczający słowo „kot” z adnotacją pokazującą jego zapis za pomocą hiragany.<ruby>猫<rt>ねこ</rt></ruby>
Wynik
Kontekst użycia
| Elementy nadrzędne | Elementy, w których można używać elementów treści syntagmatycznej |
|---|---|
| Elementy potomne | Elementy syntagmatyczne |
| Znaczniki | Znaczniki otwierający i zamykający są obowiązkowe |
| Interfejs DOM | HTMLElement |
Atrybuty obowiązkowe
Element ruby nie ma atrybutów obowiązkowych.
Atrybuty opcjonalne
Element ruby obsługuje atrybuty globalne i atrybuty zdarzeniowe.