plugin/readme.ja.txt

   1 /////////////////////////////////////////////////
   2 // プラグインディレクトリについて
   3
   4   PukiWikiのページのHTMLへのコンバート時と、プラグイン機能からの値を受け取って
   5   処理を行うプラグインを設置することができます。
   6
   7   このテキストは、そのプラグインの記述方法についての説明をします。
   8
   9
  10 /////////////////////////////////////////////////
  11 // ページ内でのプラグインの呼び出し
  12
  13   #プラグイン名
  14   #プラグイン名(arg1,arg2...)
  15
  16     行頭にスペースは含めることはできない。
  17     引数内に括弧()を使用することができる。ただし ) 単体は不可。
  18     引数を指定しなくても呼び出せる
  19
  20
  21 /////////////////////////////////////////////////
  22 // ファイル名
  23
  24   プラグイン名.inc.php
  25
  26
  27 /////////////////////////////////////////////////
  28 // 関数
  29
  30   ■function plugin_プラグイン名_convert()
  31
  32     HTMLへのコンバート時に呼び出される
  33
  34     引数は func_get_args() で配列へ格納できる。([0]～[n])
  35     func_num_args() によって、渡された引数の数を求めることができる。
  36
  37   ■function plugin_プラグイン名_action()
  38
  39     GET・POSTメソッドでpluginを指定されたときに呼び出される
  40
  41     返値に array("msg" => "$1 is page") などを返すと $1 をページ名として
  42     ページタイトルに置換される
  43
  44     die() を実行することにより、ページに戻らないようにできる
  45
  46   ■function plugin_プラグイン名_init()
  47
  48     プラグインが読み込まれる時に呼び出されます。
  49
  50     $_plugin_recent_messages = array(
  51     '_recent_plugin_li'=>'・',
  52     '_recent_plugin_frame '=>'<span align="center"><h5 class="side_label">最新の%d件</h5></span><small>%s</small>'
  53     );
  54     set_plugin_messages($_plugin_recent_messages);
  55
  56     として置くと、*.lngファイルでボタンやメッセージを指定していない場合にのみ
  57     メッセージなどがセットされます。
  58     変数などの初期化も行えますが、PukiWiki 1.3.1(MASUI'z Edition)以降のみ
  59     有効ですので、古いPukiWikiからは呼ばれない可能性があることを気をつけて
  60     ください。
  61     set_plugin_messages関数もPukiWiki 1.3.1(MASUI'z Edition)以降のみです。
  62
  63
  64 /////////////////////////////////////////////////
  65 // ファイル内容
  66
  67   ユーザに設定させる初期値などについては、define で定義する。
  68
  69   コンバート時のGET・POSTの出力内容に必要なものは refer と plugin という値で、
  70   refer : そのページの名前($vars["page"])
  71   plugin : プラグイン名
  72   とします。
  73
  74   以下の値を global でグローバル変数にすることによって値を取得できます。
  75
  76   $script : スクリプト名
  77   $vars : GET・POST両方のメソッドによるHTTPからの引数
  78           ($vars["page"] : 開いているページ名)
  79