User Tools

Site Tools


Translations of this page:

Info of Pages

Recent 10 Changes

Recently Created 5 pages

Online Measurements

2 people started to see my website in the last 10 minutes.

Accesses to this page
Today: 3 Yesterday: 1
Total: 3022

Wiki Status

  • 105 pages in total

Ruby Plugin


You can add ruby to your text by using this plugin.

"Ruby" is shown on specified characters. Ruby is mainly used to display Japanese Kana on Chinese characters and describe how to read the Chinese characters.

I know that there is a similar plugin plugin:xhtmlruby, but it seems that the plugin is not updated now, so I newly made this plugin.

This plugin is mainly for Japanese surroundings, because other languages may not need "ruby."


Search and install the plugin using the Extension Manager. Refer to :Plugins on how to install plugins manually.

Examples / Usage

For example, if you enter:


then you'll see "(くるま)." Many devices will show small text "くるま" on the text "車" ("車" stands for "car(s)" in Japanese, and is read "kuruma (くるま)").
But some devices doesn't support the ruby syntax. In such devices it'll be shown like "車(くるま)". (Parentheses can be changed. See contents below.)
When the rendering mode is "metadata" (such as making RSS feeds), it'll be also shown like "車(くるま)".


{{ruby|characters|another characters on it}}
  • characters: In many cases, you enter the Chinese characters
  • another characters on it: In many cases, you enter how to read this Chinese characters

Configuration and Settings

You can change following settings by using the Configuration Manager.

OptionDescriptionValue TypeDefault Value
parenthesesPartentheses involving ruby (used for rendering mode "metadata" (such as when rendering RSS feeds) and for devices not supporting ruby syntax)
The first character of the text in this text box will be a left parenthesis, and the second character will be a right one.
The third character and after will be ignored.
If there is only one character in this text box, or the text box is empty, parentheses won't be outputted.


Change Log

  • 2018-04-30
    • Published (with single file)
  • 2018-05-04
    • Started to support some configurations (parentheses used for devices not supporting ruby syntax)
    • Multiple files
  • 2018-05-22
    • Little change
  • 2018-05-23
  • 2018-05-29
  • 2018-06-02
  • 2018-08-08
    • Updated (defined the function when the rendering mode is metadata)

Known Bugs and Issues

No issues now

Contact Me

If you find some problems in this plugin, you can make issue topics on the GitHub page, or if you wanna contact me for other things, you can contact me by:


en/dokuwiki/ruby.txt · Last modified: 2019/02/06 18:09 by 管理人/Admin