テンプレート:Pathnav/docのソースを表示

<noinclude>{{Documentation subpage|種類=[[Help:テンプレート|テンプレート]]}}</noinclude>
<includeonly>{{使用箇所の多いテンプレート|60,000以上}}</includeonly>
{{Uses TemplateStyles|Template:Pathnavbox/styles.css}}
[[パンくずリスト]]あるいはトピックパス（[[木構造 (データ構造)|ツリー構造]]を表すナビゲーションリンク）を生成するテンプレート。

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

== 使用基準 ==
本テンプレートを使用するにあたっては、パスの構造が以下の基準を満たしていることが望ましいです。
*'''認知されている''' - [[Wikipedia:信頼できる情報源|信頼できる情報源]]において一般的に使われているツリー構造であること。
*'''中立的''' - [[Wikipedia:中立的な観点|中立的な視点]]に基づくツリー構造であり、ツリー構造に異論の出る余地が少ないものであること。
*'''安定的''' - ツリー構造が一時的なものでなく、将来に渡って比較的安定すると考えられること。
*'''深すぎない''' - 関連性の強い、簡単なツリー構造であること。
*'''浅すぎない''' - 原則として3段以上の階層構造であること。

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

== 使い方 ==
項目の冒頭（[[曖昧さ回避]]の下、[[Template:mbox|メッセージボックス]]の上）に設置します。

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

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

== 使用例 ==
=== 通常 ===
<nowiki>{{Pathnav|日本|東京都|新宿区}}</nowiki>

（[[西新宿]]から呼び出した場合）
{{Pathnav|日本|東京都|新宿区|'''<nowiki>西新宿</nowiki>'''|hide=1|namespace=}}

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

=== 枠なし ===
<nowiki>{{Pathnav|プロジェクト関連文書|スタイルマニュアル}}</nowiki>

（[[Wikipedia:表記ガイド]]から呼び出した場合）
{{Pathnav|プロジェクト関連文書|スタイルマニュアル|'''<nowiki>表記ガイド</nowiki>'''|hide=1|namespace=Wikipedia}}

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

<nowiki> {{Pathnav|主要カテゴリ|…|日本|日本の文化|frame=1|hide=1}}</nowiki>

{{Pathnav|主要カテゴリ|…|日本|日本の文化|frame=1|hide=1|namespace=Category}}

== Template:Pathnavboxとの併用 ==
=== 複数のパスを並べる ===
複数のパンくずリストを並べる場合、それぞれに ''frame'' パラメータを指定すると、枠がそれぞれごとにいくつも生成されてしまいます。これを避け、並べた複数のパンくずリスト全体を一つの枠に納めるためには、{{tl|Pathnavbox}}を使用してください。
<pre>
{{Pathnavbox|
{{Pathnav|foo|bar|baz}}
{{Pathnav|hoge|piyo}}
}}
</pre>
{{Pathnavbox|
{{Pathnav|foo|<nowiki>bar</nowiki>|baz|'''呼出元ページ'''|hide=1}}
{{Pathnav|hoge|piyo|'''呼出元ページ'''|hide=1}}
}}
<pre>
{{Pathnavbox|
{{Pathnav|hide=1|foo|bar|baz}}
{{Pathnav|hide=1|hoge|piyo}}
> '''ページ名''' }}
</pre>
{{Pathnavbox|
{{Pathnav|hide=1|foo|bar|baz}}
{{Pathnav|hide=1|hoge|piyo}}
> '''ページ名''' }}

=== ツリー状に表示する ===
{{tl|Pathnavbox}}の中では、[[Help:ページの編集#箇条書き|箇条書き]]の行頭のマークは表示されません。
<pre>
{{Pathnavbox|
* {{Pathnav|foo|bar|hide=1}}
** {{Pathnav|baz}}
** {{Pathnav|hoge|piyo}}
}}
</pre>
{{Pathnavbox|
* {{Pathnav|foo|<nowiki>bar</nowiki>|hide=1}}
** {{Pathnav|baz|'''呼出元ページ'''|hide=1}}
** {{Pathnav|hoge|piyo|'''呼出元ページ'''|hide=1}}
}}

== 関連項目 ==
* {{tl|子記事}} - 記事内容に親子関係がある場合の、子記事でのパンくずリスト生成

<includeonly>{{Sandbox other||
<!-- Add categories below this line -->
{{デフォルトソート:{{PAGENAME}}}}
[[Category:内部リンク用テンプレート]]
}}</includeonly>