4 people following this project (follow)

English | 日本語

Project Description

HTML Ruby adds support for ruby annotation in Firefox. HTML Ruby aims to be a simple, fast, and light-weight alternative to XHTML Ruby Support. It is developed mainly in Javascript, CSS, and other web standards.

HTML Ruby currently supports the basic rendering of the following forms of ruby annotation:
  • HTML4: implemented by IE and the current de facto standard for ruby annotation use
  • XHTML1.1: the first official specification of ruby annotation but failed to gain browser support
  • HTML5: still in draft but gaining support from Webkit (Chrome/Safari)
HTML Ruby does not support the CSS3 ruby module.

Download and Install

Download the Mozilla-approved versions for Firefox from addons.mozilla.org.

If you would like to try the latest and greatest versions, newer releases may be available from the downloads section. Save the file to your desktop and drag it into Firefox to install. Please note that releases not submitted to addons.mozilla.org are not tested as thoroughly and that versions installed in this way will not auto-update.

Please uninstall or disable XHTML Ruby Support while HTML Ruby is enabled (and vice versa) to avoid conflicts.

HTML Ruby is also available for Opera.

User Options

User options are available from HTML Ruby's options panel. Go to Tools -> Add-ons -> Extensions -> HTML Ruby -> Options in Firefox to access them or just simply right click on the HTML Ruby icon in Firefox's status bar.

Because ruby text can become illegibly small in certain situations, setting a minimum font size in Firefox is highly recommended. This will allow ruby text to remain legible while keeping its relative proportion.

FAQ

What is ruby?

Ruby, here, is not the programming language Ruby but the ruby annotation used in web pages. These "ruby" are small texts that are usually displayed above base texts to show the pronunciation of characters used in East Asian languages.

Why is it called HTML Ruby?

This project started out as an Opera UserJS where there already existed a script called XHTML Ruby (separate from the Firefox extension XHTML Ruby Support). XHTML Ruby only handled properly formed XHTML ruby tags, while HTML Ruby aimed to also support the draft specification of the ruby annotation which accepted unclosed tags, or rather, the HTML form of ruby annotation.

Last edited Feb 6 2011 at 12:53 AM by kailapis, version 73