Ruby
| Description | Represents a ruby annotation that provides pronunciation or other linguistic hints alongside the base text, commonly used in East Asian typography. |
|---|---|
| Namespace | 1.7 2.0 |
| Category | inline |
Attributes
Specifies how the element is placed relative to surrounding content (e.g., block-level or inline flow).
Defines the direction of text flow (e.g., left-to-right, right-to-left, or vertical).
Sets the background color for the element’s content area.
Specifies the color of the border around the element.
Indicates the style of the border (e.g., solid, dashed, dotted).
Defines the thickness of the border line in user space units (such as points).
Determines the space between the element’s border (or boundary) and its inner content.
Applies the primary color (fill or stroke) for the text or graphic content.
Main indicator of type. This semantic association allows tools to present and support interaction with the object in a manner that is consistent with user expectations about other objects of that type.
Differences
Well tagged PDF:
The 'Ruby' element in Well-Tagged PDF is used for ruby annotations, typically providing phonetic guides or supplementary pronunciation information for base text in East Asian languages.
Ruby annotations should be clearly associated with the base text and correctly nested within the text flow to support proper content extraction and reflow.
PDFUA:
In PDF/UA, the 'Ruby' element ensures that supplementary reading aids, such as furigana, are accessible, clarifying pronunciation and meaning for users.
Ruby elements must be properly tagged and include associated metadata to allow assistive technologies to present the annotations in context.
Use cases
Tag Relationships
Permitted Child Tags
Click on any tag to view its details.
Related Matterhorn Protocol checkpoints
- Tags are not in logical reading order.
- Structure elements are nested in a semantically inappropriate manner. (e.g. a table inside a heading).
- The structure type (after applying any role-mapping as necessary) of a structure element is not semantically appropriate.
- A Ruby-related structure element is used in a way that does not conform to Table 338 in ISO 32000-1.