====== ルビ表示プラグイン - Ruby ======
**[[+tab|doku>ja:plugin:ruby|DokuWikiポータルサイト上のページ]]**

===== 概要 =====
テキストにルビ（振り仮名）を振る事が出来るプラグインです。

似たようなプラグインとして[[+tab|doku>plugin:xhtmlruby]]があった事は存じ上げていましたが、そのプラグインは長い事更新されず放置されているようだったので、新たに作りました。

私が一番最初に作ったプラグインです。

===== 導入 =====
[[+tab|doku>ja:plugin:plugin|プラグインマネージャー]]と、上記URLを利用すると、プラグインの最新版をインストール出来ます。
プラグインを手動でインストールする場合は[[+tab|doku>ja:Plugins|こちら]]をご覧下さい。

===== 使用例 / 使い方 =====
例えば、
  {{ruby|車|くるま}}

と入力すると、「{{ruby|車|くるま}}」と表示されます。
大抵の端末では「車」の上に「くるま」と小さく表示されますが、一部の、ルビ表示に対応していない端末からは「車(くるま)」のように表示されます（括弧の部分を変更出来ます。後述参照）。
出力モードが「metadata」の時（RSSフィード出力の際など）も同様で、「車(くるま)」のように表示されます。

===== 文法 =====

  {{ruby|振り仮名を振る対象|振り仮名}}

特に説明する必要も無いでしょう。

===== 設定系統 =====
[[+tab|doku>ja:plugin:config|設定管理プラグイン]]から、以下の設定を変更出来ます。

^オプション^説明^値のタイプ^既定値^
|''parentheses''| __ルビが入る括弧（レンダリングモードが"metadata"の時〔RSSフィード出力等〕及びルビ表示非対応の環境下で表示する際に使われる設定です）__\\ テキストボックスに入力された1文字目が左括弧、2文字目が右括弧として認識されます。\\ 3文字目以降があった場合は無視されます。\\ また、このテキストボックス内に1文字しか入力されていない場合、もしくはテキストボックスが空欄の場合は、括弧は出力されません。|string|''()''|

===== 開発 =====

=== 変更履歴 ===

  * **2018-04-30**
    * 公開（当時はファイル1つ）
  * **2018-05-04**
    * 幾つかの設定を変更出来るようになった（ルビ表示非対応の環境下で、ルビを囲む括弧）
    * 配布ファイルが複数に
  * **2018-05-22**
    * 小変更のアップデート
  * **2018-05-23**
    * [[+tab|https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/pull/2|Satoshi Saharaさんによるコミット]]を適合し、適切でないコードを修正（機能変更はありません）
  * **2018-05-29**
    * 更新（[[+tab|https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/issues/3|寄せられた要望]]を実装しました）
  * **2018-06-02**
    * [[+tab|https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/pull/4|Satoshi Saharaさんによるコミット]]を適合し、幾らかコードを最適化（機能変更はありません）
  * **2018-08-08**
    * 更新（出力モードが「metadata」の時の動作について定義しました）

=== 既知のバグや不具合 ===

現時点ではありません。

===== 連絡先 =====

プラグインに問題が見付かりましたら、[[+tab|https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin|GitHubのページ]]にトピックを作成出来ます（日本語OKです）。他の事で何かありましたら、以下の連絡先をご利用下さい。

  * <dosankomali@yahoo.co.jp>
  * [[+tab|https://twitter.com/YukkuriDosanko|Twitterアカウント]]

\\
[[:dokuwiki|BACK]]