It's better when it's simple

User Tools

Site Tools


Ruby Plugin

Compatible with DokuWiki

  • 2018-04-22 "Greebo" yes
  • 2017-02-19 "Frusterick Manners" unknown
  • 2016-06-26 "Elenor Of Tsort" unknown
  • 2015-08-10 "Detritus" unknown

plugin Add ruby (normally used to display Japanese Kana on Chinese characters to describe how to read the Chinese characters. This plugin is mainly for Japanese surroundings)

Last updated on

Similar to xhtmlruby

Tagged with furigana, japanese, ruby

:!: このプラグインに関して、日本語版ページがございます。(This page is also available in Japanese)
:!: I’m not a native English speaker, so this page may contain some mistakes in English sentences.

:!: This plugin updated in May 29, 2018, and confs of parentheses has been changed. Read this page for details.


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 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.”

:!: I'm a beginner of PHP programming, so I referred to anchor plugin when creating my plugin.


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

Examples / Usage

:!: May 22, 2018: I changed partitions from “:” to “|”, because I thought that “|” is a less common character than “:”.

For example, if you enter:


then you'll see 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 “車(くるま)”.

You can see this plugin working on a page in my wiki (sorry but this page is available only in Japanese).


{{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

:!: May 29, 2018: It's been updated and options parenthesis and parenthesisClosing will no longer be used (merged to parentheses).

You can change following settings by using the Configuration Manager.

Option Description Value Type Default Value
parentheses Partentheses 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.
string ()

The description of configuration can be shown in:

  • English
  • Japanese


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:


plugin/ruby.txt · Last modified: 2018-08-08 08:32 by hokkaidoperson