![[PukiWiki]](image/pukiwiki.png "[PukiWiki]")
#author("2025-06-06T14:39:12+00:00","","") #author("2025-06-06T15:02:24+00:00","","") #nofollow #norelated * Plugin Manual [#v0ed77c7] ------------------------------ #contents ------------------------------ #ls2(,title) ------------------------------ ** Plugin Manual - Introduction [#vf3c6f93] The Plugin Manual is written in the following format: ''Plugin Name'' :Class| ~Indicates the method by which the plugin is called/invoked. There exist plugins with multiple call methods. --Command － Indicates the possible command formats for calling the plugin. For calling internally, this will be enclosed in parentheses if the explanation is omitted. --ブロック型プラグイン － ブロック型プラグインでの呼び出しが可能である事を示します。 --インライン型プラグイン － インライン型プラグインでの呼び出しが可能である事を示します。 --擬似ブロック型プラグイン － PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。 :重要度| ~そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。 :書式| ~プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。 --[] － 省略可能で必要に応じて記述する箇所です。 --| － |で区切られた複数の項目のうち、指定できるのは１つである事を示します。 --{} － 中カッコ内のみ引数の指定順序が任意である事を示します。 :概要| ~そのプラグインの機能概要です。 :引数| ~引数の詳細な説明です。 :プラグイン内設定| ~プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。 :備考| ~プラグインに関する参考情報です。 :Classification| ~Indicates the method(s) in which the plugin is called/invoked. There exist plugins with multiple call methods. --Command － Indicates that the plugin can be called as a command. If called internally, "Command" will be enclosed in parentheses if the explanation is omitted. --Block-type Plugin － Will be written if the plugin can be called as a block element. --Inline-type Plugin － Will be written if the plugin can be called as an inline element. --Pseudo-Block-type Plugin － Indicates that the plugin is realized by PukiWiki itself. Since the description method is the same as that of a Block-type Plugin, it is included in the Plugin Manual for convenience. :Priority| ~Provides an estimate of the plugin's general use frequency / usefulness, e.g. not very important: ★☆☆☆☆ highly important: ★★★★★ :Format| ~The method of assigning arguments to the plugin, as denoted by the following formats: --[] － Optional and as-needed for description. --| － Multiple items divided with a "|" indicate that only one thereof can be selected ("OR"). --{} － Indicates that the order of the argument(s) specified within is optional. :Summary| ~Outline of the plugin's functionality. :Arguments| ~Detailed explanation of the plugin's argument(s). :Internal Settings| ~List of defined constants in the plugin's source. Allows fine-tuning not possible with arguments. :Notes| ~Reference information related to the plugin.
