wiki/50756B6957696B692F312E342F4D616E75616C2F506C7567696E.txt

   1 #freeze
   2 #nofollow
   3 #norelated
   4 * プラグインマニュアル [#v0ed77c7]
   5 ------------------------------
   6 #contents
   7 ------------------------------
   8 #ls2(,title)
   9 ------------------------------
  10 ** プラグインマニュアルの凡例 [#vf3c6f93]
  11 プラグインマニュアルは以下の形式で記述されています。
  12
  13 ''プラグイン名''
  14
  15 :種別|
  16 ~プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
  17 --コマンド － コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
  18 --ブロック型プラグイン － ブロック型プラグインでの呼び出しが可能である事を示します。
  19 --インライン型プラグイン － インライン型プラグインでの呼び出しが可能である事を示します。
  20 --擬似ブロック型プラグイン － PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
  21 :重要度|
  22 ~そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
  23 :書式|
  24 ~プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
  25 --[] － 省略可能で必要に応じて記述する箇所です。
  26 --| － |で区切られた複数の項目のうち、指定できるのは１つである事を示します。
  27 --{} － 中カッコ内のみ引数の指定順序が任意である事を示します。
  28 :概要|
  29 ~そのプラグインの機能概要です。
  30 :引数|
  31 ~引数の詳細な説明です。
  32 :プラグイン内設定|
  33 ~プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
  34 :備考|
  35 ~プラグインに関する参考情報です。