Module:ja-ruby/documentation

This module handles ruby texts. It converts between the following 4 forms:

1. Wikitext

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

   (振ふり仮が名な)

2. Texts of the term and the ruby

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

   ふりが%な
   

3. []() markup

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

4. Lua table, used by modules

   local example_ruby_table = {
       {
           text = {
               {text = '振', ruby = 'ふ'},
               {text = 'り'},
           }, linkto = "振る"
       },
       {
           text = {
               {text = '仮', ruby = 'か'},
               {text = '名', ruby = 'な'},
           }, linkto = "仮名"
       },
   }
   

(The generated documentation is located at the module page.)