テンプレート:Pp-template/doc

これはテンプレート:Pp-templateの解説サブページです。
使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。

Luaモジュールを使用しています:

影響が特に大きいため保護されているテンプレートに対し、そのことを示すために使用するテンプレートです。このテンプレートはページの保護レベルを自動的に検知して、適切な表示・カテゴリ付け（Category:編集半保護中のテンプレートなど）を行います。

保護されたテンプレートが{{Documentation}}を使用している場合、そちらの機能により保護アイコンが表示されるため、通常はこのテンプレートを使用する必要はありません。モジュールについてもテンプレート:Tlfを自動的に読み込むため、このテンプレートを使用する必要はありません。

ページの保護は管理者にしか行えません。

使い方

保護されたテンプレート本体で当テンプレートを使用する場合、<noinclude>{{pp-template}}</noinclude>のようにnoincludeタグ内に入れてください。

Template名前空間内のCSSページに対して使用する場合、/* {{pp-template}} */のようにコメントアウトした状態でテンプレート呼び出し構文を記入してください。

いずれの引数も省略可能です。

small – no、n、0、false、fのいずれかを指定した場合、ページの右上にインジケーターアイコンを表示する代わりに、このテンプレートを呼び出した位置でバナーを表示します。{{pp}}とは逆に、この引数を省略した場合はyesが指定されたときと同じ動作（インジケーターアイコンによる表示）になります。
category – no、n、0、falseのいずれかを指定すると、テンプレートが貼られたページに追跡カテゴリを付与しなくなります。

保護レベルについては内部で使用しているモジュールで自動的に取得します。

入力:

{{pp-template|small=no}}

出力:（編集全保護の場合）出力:（編集拡張半保護の場合）出力:（編集半保護の場合）