w3c / w3c/jlreq

Tabular markup not supported for ruby

Open
#175 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc:jlreq gap i:inline_notes l:ja p:basic s:jpan x:blink x:html x:jpan x:webkit
Dominant language
HTML
Stars
138
Forks
18
PR merge metrics
No merged PRs in 30d

Description

This issue is applicable to all languages using ruby annotations. (See: jlreq)

The basic pattern of 'tabular' markup is ruby-base ruby-base ... ruby-text ruby-text .... An advantage to this approach is that it enables you to style the ruby text to appear inline in such a way that all the ruby text for a word follows that word together. Inline styling can be useful in space-constrained situations, where it would be too difficult to read small ruby characters. Read more.

This also makes certain applications of double-sided ruby impossible when the ruby on each side of the base spans a different set of base characters.

When text is marked up in mono-ruby way, searching will not work well. If you have the following markup

<p><ruby>漢<rt>かん</rt>字<rt>じ</rt></ruby></p>

and search for the base text "漢字" in a browser, you will not get a result. Tabular markup could solve this problem. (See https://github.com/w3c/i18n-issues/issues/2 for a similar report raised by Japanese & Chinese users.)

Specs:
issue 1771 rb and rtc element should be removed from the list of obsolete features Open.

html has actually removed markup for rb and rtc elements, which would be needed to make this work. The parser, however, supports the use of the markup still.

css-ruby-1 Describes how the tabular approach will work for CSS.

Tests & results:
i18n test suite, HTML5, the ruby element and its children

Gecko supports display of ruby using the tabular model. Blink, and Webkit do not correctly support display. However, all browsers recognise the rb and rtc elements, and allow them to be styled or manipulated using scripting.

Kindle's ePub implementation also implements the tabular model, although not rtc.

Browser bug reports:
GeckoBlinkWebkit

Priority:
The limitations created by the lack of the tabular model are all basic in nature. None more so that the impairment for searching, since browsers have not been incentivised to fix that in any other way. The obsoletion of the rb and rtc elements by the HTML spec runs the risk that browser engines are not implementing the tabular model.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no repository files or entry point. Begin by reviewing the jlreq ruby material alongside the linked HTML, CSS Ruby, and i18n test references; implementation needs confirmed scope and acceptance criteria before completion can be assessed.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, html
Domain
documentation, internationalization
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.