Module:Sandbox/Artoria2e5/Ruby-zh/doc

This is a module for Bopomofo Ruby and their mixed use with "normal" Ruby.

Rationale

Normal Ruby characters go to either the top or the bottom of text, and follow the same horizontal, left-to-right direction that the text being annotated flows. Bopomofo, however, acts differently: it is traditional to put the bopomofo to the right of each character being phonetically labelled, laid out in a vertical direction.^[1] As a result, it is non-trivial to lay out Bopomofo-annotated text.

This module roughly follows the methology established by Han.css in its DOM output.

Usage

{{#invoke:Sandbox/Artoria2e5/Ruby-zh|function_name}}