This is an old revision of the document!
Table of Contents
Ruby Plugin
Compatible with DokuWiki
Greebo, 2018-04-22
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)
This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.
Similar to xhtmlruby
このプラグインに関して、日本語版ページがございます。(This page is also available in Japanese)
Summary
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.
I’m not a native English speaker, so this page may contain some mistakes in English sentences.
Installation
This plugin now contains multiple files, so I started to share them on GitHub.
Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually. The local plugin directory must have the same name as the plugin is named, otherwise the plugin won't work properly.
Examples / Usage
For example, if you enter:
{{ruby:車:くるま}}
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.)
You can see this plugin working on a page in my wiki (sorry but this page is available only in Japanese).
Syntax
{{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.
Option | Description | Value Type | Default Value |
---|---|---|---|
parenthesis | Partenthesis involving ruby (used for devices not supporting ruby syntax) | string | ( |
parenthesisClosing | Closing partenthesis involving ruby (used for devices not supporting ruby syntax) | string | ) |
The configuration of this plugin can be shown in:
- English
- Japanese
Development
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
Known Bugs and Issues
No issues now