モジュール:ja-ruby/doc

これは、モジュール:ja-rubyの解説サブページです。
使用方法、カテゴリ、そのほかモジュールページそのものに含まれない情報を含んでいます。他のページから呼び出して表示することを意図しているため、相対リンクや条件文などの動作が意図しないものになっていることがあります。
モジュールページ自体は、モジュール:ja-rubyをご覧ください。

このモジュールは、日本語の振り仮名を含む、通常文字の上側に記される小文字であるルビを扱う。ルビは以下四種類の形で出力できる。

1. Wikitext

   [[振る|<ruby>振<rt>ふ</rt></ruby>り]][[仮名|<ruby>仮<rt>が</rt></ruby><ruby>名<rt>な</rt></ruby>]]
   

   (振ふり仮が名な)

2. 通常文字の文字列とルビの文字列。

   [[振る|振り]][[仮%名]]
   

   ふりが%な
   

3. []()記号を使用する文字列。

   [[振る|[振](ふ)り]][[仮名|[仮](が)[名](な)]]
   

4. Luaテーブル、モジュール処理用。

---

出力関数の一覧

• len_text(ruby_table)
• len_ruby(ruby_table)
• to_text(ruby_table)
• to_ruby(ruby_table)
• to_markup(ruby_table, options)
• to_wiki(ruby_table, options)
• parse_markup(markup)
• parse_text(term, kana, options)
• ruby_auto(args)