Differences

This shows you the differences between two versions of the page.

--- plugin:ruby [2018-05-04 17:45] – Updated hokkaidoperson
+++ plugin:ruby [2019-01-23 08:18] (current) – I moved this plugin's document to my private website. hokkaidoperson
@@ Line 6: / Line 6: @@
 email      : dosankomali@yahoo.co.jp
 type       : Syntax
-lastupdate : 2018-05-04
+lastupdate : 2018-08-08
 compatible : Greebo, 2018-04-22
 similar    : xhtmlruby
@@ Line 12: / Line 12: @@
 downloadurl: https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/archive/master.zip
+bugtracker : https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/issues
+sourcerepo : https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin
 ----
-:!: [[ja:plugin:ruby|このプラグインに関して、日本語版ページがございます。(This page is also available in Japanese)]]
+:!: [[ja:plugin:ruby|このプラグインに関して、日本語版ページがございます。(This page is also available in Japanese)]]\\
-===== Summary =====
+Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-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.
+[[https://www.hkdyukkuri.space/en/dokuwiki/ruby|Visit my private website to see the full document of 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 [[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 =====
-This plugin now contains multiple files, so I started to share them on GitHub.
-Install the plugin using the [[plugin:plugin|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 [[https://jdwiki.hkdyukkuri.space/wiki/syntax|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 [[plugin:config|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 =====
-  * [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin|GitHub Page]]
-=== 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
 ===== Discussion =====