[[Help]] | [[PukiWiki]]
#hr

#nomenubar
#norelated
#multilang(ja){{
* プラグインマニュアル
#contents
}}
#multilang(ko_KR){{
*플러그인 설명서
#contents
}}
------------------------------
#ls2(,title)
------------------------------
#multilang(ja){{
** プラグインマニュアルの凡例
プラグインマニュアルは以下の形式で記述されています。

''プラグイン名''

:種別|
~プラグインがどのような方法で呼び出しを行えるかを示します。複数の呼び出し方法をもつプラグインも存在します。
--コマンド - コマンド形式の呼び出しが可能であることを示します。内部的に呼び出されるため、説明を省いている場合はカッコで括られています。
--ブロック型プラグイン - ブロック型プラグインでの呼び出しが可能である事を示します。
--インライン型プラグイン - インライン型プラグインでの呼び出しが可能である事を示します。
--擬似ブロック型プラグイン - PukiWiki本体で実現されている機能であることを示します。記述方式がブロック型プラグインと同じであるため、便宜上プラグインのマニュアルに含めています。
:重要度|
~そのプラグインの一般的な利用頻度や有用性の目安を示します。さほど重要でない場合は ★☆☆☆☆ が、重要なプラグインの場合は ★★★★★ です。
:書式|
~プラグインでの引数指定方法です。引数の指定方法の表現のため、下記の記述書式を使っています。
--[] - 省略可能で必要に応じて記述する箇所です。
--| - |で区切られた複数の項目のうち、指定できるのは1つである事を示します。
--{} - 中カッコ内のみ引数の指定順序が任意である事を示します。
:概要|
~そのプラグインの機能概要です。
:引数|
~引数の詳細な説明です。
:プラグイン内設定|
~プラグインのソース中で定義されている定数の一覧です。引数で変更できない詳細なカスタマイズが可能となります。
:備考|
~プラグインに関する参考情報です。
}}

#multilang(ko_KR){{
*설명서 범례
플러그인 설명서는 아래의 형식으로 되어있습니다.

''플러그인 이름''

:종류|
~플러그인이 어떠한 방법으로 호출 되는가 표시 합니다. 여러가지 호출 방법을 가진 플러그인도 있습니다.
--커맨드 - 커맨드형식의 부름이 가능함을 표시합니다. 내부적으로는 내부적으로 호출 되므로 설명을 괄호에括られています。
--블록형플러그인  - 블록형 플러그인의 호출이 가능함을 표시합니다.
--인라인형 플러그인 - 인라인형플러그인으로 호출이 가능함을 표시합니다.
--유사블록형플러그인 - PukiWiki 프로그램 내부에서 구현되어 있는 기능임을 표시합니다. 표시 방법이 블록형 플러그인과 같기 때문에, 편의상 플러그인 설명서에 포함되어 있습니다.

:중요도|
~그 플러그인의 일반적인 이용빈도나 유용성 정도를 표시합니다. 그다지 중요하지 않은 경우는 ★☆☆☆☆、중요한 플러그인의 경우는 ★★★★★ 입니다.
:서식|
~플러그인에서의 인수지정법입니다. 인수의 지정방법의 표현때문에 아래 와 같이 표시 하고 있습니다.
--[] - 생략 가능하고 필요에 따라 지정
--| - |로 구분된 복수의 항목중, 지정할수 있는것은 한개뿐임을 나타냅니다.
--{} - 중괄호 안쪽의 내용만 인수 지정 순서가 임의인 것을 나타냅니다.
:개요|
~그 플러그인의 기능적 개요입니다.
:인수|
~인수의 상세한 설명입니다.
:플러그인 내부 설정|
~플러그인의 소스중에서 정의되어 있는 정수의 목록입니다. 인수로 변경할수 없는 상세한 커스터마이즈가 가능합니다.
:비고|
~플러그인에 관한 기타 정보입니다.
}}