Mercurial > hg > Applications > casawiki

comparison plugin.txt @ 0:a2f0a2c135cf

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
hg init
author Shoshi TAMAKI <shoshi@cr.ie.u-ryukyu.ac.jp>
date Sun, 06 Jun 2010 22:00:38 +0900
parents
children
comparison
equal deleted inserted replaced
-1:000000000000 0:a2f0a2c135cf
1 YukiWikiプラグイン
2
3 -------------------------------------------------
4 ■はじめに
5 -------------------------------------------------
6
7 この文書はYukiWikiのプラグインに関する情報をまとめたものです。
8
9 -------------------------------------------------
10 ■プラグインとは
11 -------------------------------------------------
12
13 プラグインは、YukiWiki本体に手を入れることなく機能拡張するための機構です。
14 プラグインの作成にはPerlの知識が必要です。
15
16 YukiWikiのプラグイン機能を実現しているのは
17 Yuki::PluginManagerモジュールです。
18 YukiWiki本体(wiki.cgi)起動時にYuki::PluginManagerモジュールが初期化され、
19 そのタイミングでインストール済みのプラグインがロードされ、
20 利用可能になります。
21
22 管理者以外のYukiWiki利用者がプラグインをインストールすることはできません。
23
24 -------------------------------------------------
25 ■プラグインの種別
26 -------------------------------------------------
27
28 プラグインには以下の三種類があります。
29
30 ・インラインタイプ
31 &bold(ここを太字) のようにWikiページ内に記述します。
32 HTMLのインライン要素に対応します。
33 ・ブロックタイプ
34 #recent() のようにWikiページ内に記述します。
35 HTMLのブロック要素に対応します。
36 ・フィルタタイプ
37 Wikiのページ内部に記述するのではなく、
38 コンテンツ全体を変換するときに使います。
39
40 -------------------------------------------------
41 ■プラグインのファイル
42 -------------------------------------------------
43
44 プラグインのファイルは、
45
46 プラグイン名.pl
47
48 という名前にします。特にフィルタタイプのプラグインの場合には、
49
50 filter_プラグイン名.pl
51
52 という名前にします。
53 プラグインのファイルはPerlで記述し、
54 wiki.cgiの$modifier_dir_pluginで指定したディレクトリに置きます。
55
56 -------------------------------------------------
57 ■プラグインのプログラミング
58 -------------------------------------------------
59
60 YukiWikiに同梱されているプラグインを参考にしてください。