Differences

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

--- plugin:ruby [2018-05-29 10:56] – 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-29
+lastupdate : 2018-08-08
 compatible : Greebo, 2018-04-22
 similar    : xhtmlruby
@@ Line 17: / Line 17: @@
 :!: [[ja:plugin: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.
-===== 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 [[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 [[plugin:anchor|anchor plugin]] when creating my plugin.\\
-===== Installation =====
 Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.
-===== Examples / Usage =====
+[[https://www.hkdyukkuri.space/en/dokuwiki/ruby|Visit my private website to see the full document of this plugin.]]
-:!: May 22, 2018: I changed partitions from ":" to "|", because I thought that "|" is a less common character than ":".
-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 =====
-:!: 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 [[plugin:config|Configuration Manager]].
-^Option^Description^Value Type^Default Value^
-|''parentheses''|Partentheses involving ruby (used 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
-===== 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
-  * **2018-05-22**
-    * Little change
-  * **2018-05-23**
-    * Merged [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/pull/2|commits by Satoshi Sahara]], and fixed improper codes (the function isn't changed)
-  * **2018-05-29**
-    * Updated (responded to [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/issues/3|a request {in Japanese}]])
-=== Known Bugs and Issues ===
-No issues now
-===== Contact Me =====
-If you find some problems in this plugin, you can make issue topics on the [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin|GitHub page]], or if you wanna contact me for other things, you can contact me by:
-  * <dosankomali@yahoo.co.jp>
-  * [[https://twitter.com/YukkuriDosanko|My Twitter]] (Japanese account but English acceptable)
 ===== Discussion =====