diff plugin.txt @ 0:a2f0a2c135cf

hg init
author Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp>
date Sun, 06 Jun 2010 22:00:38 +0900
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/plugin.txt	Sun Jun 06 22:00:38 2010 +0900
@@ -0,0 +1,60 @@
+YukiWikiプラグイン
+
+-------------------------------------------------
+■はじめに
+-------------------------------------------------
+
+この文書はYukiWikiのプラグインに関する情報をまとめたものです。
+
+-------------------------------------------------
+■プラグインとは
+-------------------------------------------------
+
+プラグインは、YukiWiki本体に手を入れることなく機能拡張するための機構です。
+プラグインの作成にはPerlの知識が必要です。
+
+YukiWikiのプラグイン機能を実現しているのは
+Yuki::PluginManagerモジュールです。
+YukiWiki本体(wiki.cgi)起動時にYuki::PluginManagerモジュールが初期化され、
+そのタイミングでインストール済みのプラグインがロードされ、
+利用可能になります。
+
+管理者以外のYukiWiki利用者がプラグインをインストールすることはできません。
+
+-------------------------------------------------
+■プラグインの種別
+-------------------------------------------------
+
+プラグインには以下の三種類があります。
+
+・インラインタイプ
+    &bold(ここを太字) のようにWikiページ内に記述します。
+    HTMLのインライン要素に対応します。
+・ブロックタイプ
+    #recent() のようにWikiページ内に記述します。
+    HTMLのブロック要素に対応します。
+・フィルタタイプ
+    Wikiのページ内部に記述するのではなく、
+    コンテンツ全体を変換するときに使います。
+
+-------------------------------------------------
+■プラグインのファイル
+-------------------------------------------------
+
+プラグインのファイルは、
+
+    プラグイン名.pl
+
+という名前にします。特にフィルタタイプのプラグインの場合には、
+
+    filter_プラグイン名.pl
+
+という名前にします。
+プラグインのファイルはPerlで記述し、
+wiki.cgiの$modifier_dir_pluginで指定したディレクトリに置きます。
+
+-------------------------------------------------
+■プラグインのプログラミング
+-------------------------------------------------
+
+YukiWikiに同梱されているプラグインを参考にしてください。