DokuWiki

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

====== Ruby Plugin ======

---- plugin ----
description: 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)
author     : Hokkaidoperson 
email      : dosankomali@yahoo.co.jp 
type       : Syntax
lastupdate : 2018-04-30
compatible : Greebo, 2018-04-22
similar    : xhtmlruby
tags       : ruby, japanese, furigana

----

:!: [[ja:plugin:ruby|このプラグインに関して、日本語版ページがございます。(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.

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 [[plugin:anchor|anchor plugin]] when creating my plugin.\\
:!:I’m not a native English speaker, so this page may contain some mistakes in English sentences.

===== Installation =====

Go to the directory ''<your dokuwiki root directory>/lib/plugins/'' , and make ''ruby'' directory here, then add the following ''syntax.php'' in it.

<code php syntax.php>
<?php
 
if(!defined('DOKU_INC')) define('DOKU_INC',realpath(dirname(__FILE__).'/../../').'/');
if(!defined('DOKU_PLUGIN')) define('DOKU_PLUGIN',DOKU_INC.'lib/plugins/');
require_once(DOKU_PLUGIN.'syntax.php');
 
class syntax_plugin_ruby extends DokuWiki_Syntax_Plugin {
 
    function getType(){
        return 'substition';
    }
 
    function getSort(){
        return 150;
    }

===== Examples / Usage =====

For example, if you enter:
  {{ruby:車:くるま}}

the 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 "車(くるま)"

You can see this plugin working on [[https://jdwiki.hkdyukkuri.space/wiki/syntax|a page in my wiki]] (sorry but this page is available only in Japanese).

===== Syntax =====

* **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 =====

None

=== Change Log ===

* **2018-04-30**
    * Published

=== Known Bugs and Issues ===

No issues now

===== Discussion =====

Please fill all the letters into the box to prove you're human. K L K A R Please keep this field empty:

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International