Template:Pathnav/doc

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

このテンプレートはテンプレートスタイルを使用しています:

パンくずリストあるいはトピックパス（ツリー構造を表すナビゲーションリンク）を生成するテンプレート。

本テンプレートを使用するにあたっては、事前にその分野で使用について何らかの合意がないかどうか確認してください。（例：プロジェクト:日本の市町村#トピックパス（Pathnav））

使用基準

本テンプレートを使用するにあたっては、パスの構造が以下の基準を満たしていることが望ましいです。

使用にあたってはウィキプロジェクトやウィキポータルなどで事前に合意しておくことが必要です。パス構造が変化した場合にも関係するページ全てでPathnavが正しく表示されるよう、プロジェクトが責任を持って管理しなければなりません。管理できそうにない場合は使用しないでください。

項目の冒頭（曖昧さ回避の下、メッセージボックスの上）に設置します。

{{Pathnav | ページ名1 | ページ名2 | … | ページ名9 | hide = 1 | frame = 1 | namespace = 名前空間名 }}

引数の一覧
引数	指定内容	既定値	説明
1 ～ 9	ページ名	なし	リンクを表示させるページ名を、名前空間を除いて指定します。最大9個まで指定できます。存在しないページ名を指定した場合はリンクせずにそのまま表示します。変数を [[ ]] で囲む必要はありません。
this	ページ名	貼り付け先のページ名	呼出元のページ名の表示名を変えることができます。
hide	空白以外	なし	呼出元のページ名を省略できます。パスをツリー状に表示する場合（後述）に、先頭の行に付けるなどします。
frame	空白以外	なし	枠に囲まれた状態で表示します。 Categoryページなどのパンくずリストに適しています。
namespace	名前空間	貼り付け先の名前空間	リンク先の名前空間を指定します。記事名前空間を指定する場合は空文字列。

（西新宿から呼び出した場合）

日本 > 東京都 > 新宿区 > 西新宿

呼び出し元の名前空間に応じて、自動的にリンクされます。

（Wikipedia:表記ガイドから呼び出した場合）

（Category名前空間のページから呼び出した場合）

複数のパンくずリストを並べる場合、それぞれに frame パラメータを指定すると、枠がそれぞれごとにいくつも生成されてしまいます。これを避け、並べた複数のパンくずリスト全体を一つの枠に納めるためには、{{Pathnavbox}}を使用してください。

{{Pathnavbox|
{{Pathnav|foo|bar|baz}}
{{Pathnav|hoge|piyo}}
}}

foo > bar > baz > 呼出元ページ

hoge > piyo > 呼出元ページ

{{Pathnavbox|
{{Pathnav|hide=1|foo|bar|baz}}
{{Pathnav|hide=1|hoge|piyo}}
> '''ページ名''' }}

foo > bar > baz

hoge > piyo

> ページ名

{{Pathnavbox}}の中では、箇条書きの行頭のマークは表示されません。

{{Pathnavbox|
* {{Pathnav|foo|bar|hide=1}}
** {{Pathnav|baz}}
** {{Pathnav|hoge|piyo}}
}}