DokuWiki

It's better when it's simple

ユーザ用ツール

サイト用ツール


ja:plugin:ruby

差分

このページの2つのバージョン間の差分を表示します。

この比較画面へのリンク

両方とも前のリビジョン前のリビジョン
ja:plugin:ruby [2018-08-08 08:35] – アップデートしました Updated hokkaidopersonja:plugin:ruby [2019-01-23 08:19] (現在) – プラグインの動作例や詳細についての記述を私の個人サイトに移動しました。 hokkaidoperson
行 15: 行 15:
 sourcerepo : https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin sourcerepo : https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin
 ---- ----
- 
-:!:このプラグインは**2018年5月29日**に更新され、**括弧の設定系統**に変更があります。詳細は後述しています。 
- 
-===== 概要 ===== 
-テキストにルビ(振り仮名)を振る事が出来るプラグインです。 
- 
-似たようなプラグインとして[[plugin:xhtmlruby]]があった事は存じ上げていましたが、そのプラグインは長い事更新されず放置されているようだったので、新たに作りました。 
- 
-:!:私はPHP初心者なので、開発(という程の物じゃないけど)にあたっては[[plugin:anchor|anchorプラグイン]]を大いに参考にさせて頂きました。 
- 
-===== 導入 ===== 
  
 [[ja:plugin:plugin|プラグインマネージャー]]と、上記URLを利用すると、プラグインの最新版をインストール出来ます。\\  [[ja:plugin:plugin|プラグインマネージャー]]と、上記URLを利用すると、プラグインの最新版をインストール出来ます。\\ 
-プラグインを手動でインストールする場合は[[ja:Plugins]]をご覧下さい。手動インストールする場合、ローカル上のプラグインディレクトリが、プラグインの名前と同じであるか確認して下さい(このプラグインの場合「ruby」)。そうしないとプラグインが適切に動作しません。 +プラグインを手動でインストールする場合は[[ja:Plugins]]をご覧下さい。
- +
-===== 使用例 / 使い方 ===== +
-:!:**2018/05/22追記**:括弧内の要素を仕切る文字を「**:**」から「**|**」に変更しました(「:」より、あまり馴染みのない文字「|」にした方がいいのかなって思った)。 +
- +
-例えば、 +
-  {{ruby|車|くるま}} +
- +
-と入力すると、「車」の上に「くるま」と小さく表示されます。\\ +
-一部の、ルビ表示に対応していない端末からは「車(くるま)」のように表示されます(括弧の部分を変更出来ます。後述参照)。 +
-出力モードが「metadata」の時(RSSフィード出力の際など)も同様で、「車(くるま)」のように表示されます。 +
- +
-プラグインが動作している様子は[[https://jdwiki.hkdyukkuri.space/wiki/syntax|こちらのページ]]からご確認下さい(日本語ですのでご安心下さい)。 +
- +
-===== 文法 ===== +
- +
-  {{ruby|振り仮名を振る対象|振り仮名}} +
- +
-特に説明する必要も無いでしょう。 +
- +
-===== 設定系統 ===== +
-:!:**2018/05/29追記**:更新により、オプション''parenthesis''と''parenthesisClosing''は使われなくなりました(''parentheses''項目に統合)。 +
- +
-[[ja:plugin:config|設定管理プラグイン]]から、以下の設定を変更出来ます。 +
- +
-^ オプション            ^ 説明                                                                                                                                                                     ^ 値のタイプ   ^ 既定値     ^ +
-| ''parentheses''  | __ルビが入る括弧(レンダリングモードが"metadata"の時〔RSSフィード出力等〕及びルビ表示非対応の環境下で表示する際に使われる設定です)__\\ テキストボックスに入力された1文字目が左括弧、2文字目が右括弧として認識されます。\\ 3文字目以降があった場合は無視されます。\\ また、このテキストボックス内に1文字しか入力されていない場合、もしくはテキストボックスが空欄の場合は、括弧は出力されません。  | string  | ''()'' +
- +
-設定管理で表示される説明は、次の言語で見られます。 +
-  * 英語 +
-  * 日本語 +
- +
-===== 開発 ===== +
- +
-=== 変更履歴 === +
- +
-  * **2018-04-30** +
-    * 公開(当時はファイル1つ) +
-  * **2018-05-04** +
-    * 幾つかの設定を変更出来るようになった(ルビ表示非対応の環境下で、ルビを囲む括弧) +
-    * 配布ファイルが複数に +
-  * **2018-05-22** +
-    * 小変更のアップデート +
-  * **2018-05-23** +
-    * [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/pull/2|Satoshi Saharaさんによるコミット]]を適合し、適切でないコードを修正(機能変更はありません) +
-  * **2018-05-29** +
-    * 更新([[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/issues/3|寄せられた要望]]を実装しました) +
-  * **2018-06-02** +
-    * [[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin/pull/4|Satoshi Saharaさんによるコミット]]を適合し、幾らかコードを最適化(機能変更はありません) +
-  * **2018-08-08** +
-    * 更新(出力モードが「metadata」の時の動作について定義しました) +
- +
-=== 既知のバグや不具合 === +
- +
-現時点ではありません。 +
- +
-===== 連絡先 ===== +
- +
-プラグインに問題が見付かりましたら、[[https://github.com/hokkaidoperson/DokuWiki-Ruby-Plugin|GitHubのページ]]にトピックを作成出来ます(日本語OKです)。他の事で何かありましたら、以下の連絡先をご利用下さい。+
  
-  * <dosankomali@yahoo.co.jp> +[[https://www.hkdyukkuri.space/dokuwiki/ruby|その他、プラグイの動作例や詳細については私の個人サイをご覧下さい。]]
-  * [[https://twitter.com/YukkuriDosanko|Twitterアカウント]]+
  
 ===== 議論 ===== ===== 議論 =====
ja/plugin/ruby.txt · 最終更新: 2019-01-23 08:19 by hokkaidoperson

特に明示されていない限り、本Wikiの内容は次のライセンスに従います: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki