• List of Backups
  • View the source.
  • PukiWiki/1.4/Manual/Plugin has been deleted.
    • 1 (2014-11-06 (Thu) 15:35:59)
  1. #nofollow
  2. #norelated
  3. * プラグインマニュアル [#v0ed77c7]
  4. ------------------------------
  5. #contents
  6. ------------------------------
  7. #ls2(,title)
  8. ------------------------------
  9. ** プラグインマニュアルの凡例 [#vf3c6f93]
  10. プラグインマニュアルは以下の形式で記述されています。
  11. プラグイン名
  12. :種別|

  13. プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。

  14. --コマンド − コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
  15. --ブロック型プラグイン − ブロック型プラグインでの呼び出しが可能である事を示します。
  16. --インライン型プラグイン − インライン型プラグインでの呼び出しが可能である事を示します。
  17. --擬似ブロック型プラグイン − PukiWiki?本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
  18. :重要度|

  19. そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。

  20. :書式|

  21. プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。

  22. --[] − 省略可能で必要に応じて記述する箇所です。
  23. --| − |で区切られた複数の項目のうち、指定できるのは１つである事を示します。
  24. --{} − 中カッコ内のみ引数の指定順序が任意である事を示します。
  25. :概要|

  26. そのプラグインの機能概要です。

  27. :引数|

  28. 引数の詳細な説明です。

  29. :プラグイン内設定|

  30. プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。

  31. :備考|

  32. プラグインに関する参考情報です。