「テンプレート:Navbox/doc」を編集中 (節単位)

== パラメータ ==
=== TemplateData ===
<noinclude>{{TemplateData header}}
<templatedata>
{
	"params": {
		"name": {
			"label": "ページ名",
			"type": "wiki-page-name",
			"required": true,
			"autovalue": "{{subst:PAGENAME}}",
			"description": "テンプレートが使われている全てのページで「表・話・編・歴」（表示・会話・編集・履歴）リンクが正しく機能するために必須"
		},
		"title": {
			"label": "タイトル",
			"type": "line",
			"required": true
		},
		"list1": {
			"aliases": [
				"body"
			],
			"label": "リスト1",
			"type": "content",
			"required": true
		}
	},
	"format": "block",
	"description": "リンク先リストからナビゲーション用リストを作れるテンプレート"
}
</templatedata></noinclude>

=== 必須 ===
; ''name''
: テンプレートの名前は、テンプレートが使われている全てのページで「表・話・編・歴」（"表示・会話・編集・履歴"）リンクが正しく機能するために必須です。値には<code><nowiki>{{subst:PAGENAME}}</nowiki></code>を用いると便利です。
; ''title''
: 表の最上部中央に表示されるテキストです。通常はテンプレートの主題、つまり表本体の簡潔な説明です。これは一行でなければなりませんが、二行目が必要な場合は、センタリングが正しく行われる様、<code><nowiki>{{-}}</nowiki></code>を使ってください。
; '''''list<sub>n</sub>''''' ('''''body''''' may be used in place of '''''list1''''')
: （''list1''、''list2''、など）テンプレート本体、通常はリンク先のリストです。書式はインラインですが、<code><nowiki><div> </div></nowiki></code>でリスト全体を囲めば複数行での入力もできます。最低でも''list''パラメータは一つ必要です。以降の''list''は、それぞれ表の別の行に表示されます。''group<sub>n</sub>''パラメータが指定されていると、個々の ''list<sub>n</sub>'' の前にそのグループが表示されます （下記参照）。

=== 任意 ===
==== セル ====
; ''group<sub>n</sub>''
: （''group1''、''group2''、など）指定されたテキストが''list<sub>n</sub>''の左、ヘッダセルに表示されます。指定がなければ、''list<sub>n</sub>''は表の全幅を使います。
; ''image''
: タイトルバーの下、本体 (group/list) の右に指定された画像を表示します。''list1''の指定は適切な表示に必須です。画像の指定には、
:* <code><nowiki>[[ファイル:Example.jpg|100px]]</nowiki></code>
: といった、画像表示に用いられる標準的ウィキコードを用います。
; ''imageleft''
: タイトルバーの下、本体 (group/list) の左に指定された画像を表示します。''list1''の指定は適切な表示に必須です。画像の指定には、
:* <code><nowiki>[[ファイル:Example.jpg|100px]]</nowiki></code>
: といった、画像表示に用いられる標準的ウィキコードを用います。
; ''above''
: タイトルバーと最初の group/list との間、すなわちテンプレート本体（group、list または image）の ''above'' （上）に表示される全幅セルです。画像のないテンプレートの場合、''above''は''group1''パラメータなしの''list1''と同様に表示されます。''above'' パラメータの使用例としては、{{tl|Navbox Musical artist}}による {{tl|ビートルズ}}、{{tl|サザンオールスターズ}} 、 {{tl|Navbox with columns}} による {{tl|アメリカ合衆国大統領}} 、{{tl|Navbox}}による {{tl|日本国憲法}}  などがあります（2013年9月現在）。
; ''below''
: テンプレート本体（group、list または image）の ''below'' （下）に表示される全幅セルです。画像のないテンプレートの場合、''below''は''group<sub>n</sub>''パラメータなしの最後の''list<sub>n</sub>''と同様に表示されます。''below'' パラメータの使用例としては、{{tl|Navbox Musical artist}} による {{tl|ベートーヴェンの交響曲}} 、{{tl|Navbox}} による {{tl|イギリス国鉄の蒸気機関車}} 、 {{tl|日本国歴代内閣総理大臣}} などがあります（2013年9月現在）。

==== スタイル（推奨しない） ====
ウィキペディア全体でテンプレートとページの一貫性を保つため、デフォルト以外のスタイルの使用は推奨できません。しかし、必要がある場合に備えスタイルを変更するオプションが用意されています。

===== デフォルトスタイル =====
{{Seealso|MediaWiki:Common.css}}
Navbox を使う際によく変更されるスタイルを示します。よりこみいった他のスタイルは、一覧を単純にするため示していません。

* <code>bodystyle  = background-color:#fdfdfd; width:100%; vertical-align:middle;</code>
* <code>titlestyle = background-color:#ccccff; padding-left:1em; padding-right:1em; text-align:center;</code>
* <code>abovestyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:center;</code>
* <code>belowstyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:center;</code>
* <code>groupstyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:right;</code>
* <code>liststyle  = background:transparent; text-align:left/center;</code>
* <code>oddstyle   = background:transparent;</code>
* <code>evenstyle  = background-color:#f7f7f7;</code>

''liststyle'' と ''oddstyle'' は透明なので、偶数行は ''bodystyle'' と同色、デフォルトでは白です。グループがなく、<code>text-align: center;</code>が指定されていないリストは <code>text-align: left;</code> です。''bodystyle'' だけに垂直アライメントがあるので、他の要素は<code>vertical-align: middle;</code>を継承します。

==== その他 ====
; ''state'' <span style="font-weight: normal;">[<code>autocollapse, collapsed, plain, off, uncollapsed</code>]</span>
: デフォルトは <code>autocollapse</code> です。<code>autocollapse</code> を設定すると、同一ページに折り畳み可能な表 （[隠す] リンクありの表、すなわち後述の <code>plain</code>指定でも <code>off</code>指定でもない表） が複数ある場合には折り畳んで初期表示されますが、それ以外の場合は展開した状態で初期表示されます。技術的詳細は[[MediaWiki:Common.js]]を御覧ください。
: 設定時に <code>autocollapse'''d'''</code> と入力しないように注意してください。<code>autocollapse'''d'''</code> とすると「<code>autocollapse</code>, <code>collapsed</code>, <code>plain</code>, <code>off</code> 以外の値」になってしまいます。
: 空の値を入力した場合も<code>autocollapse</code>になります。
:* <code>collapsed</code> を設定すると、Navbox は折り畳んだ状態で初期表示されます。
:* <code>plain</code> を設定すると、Navbox は右端に [隠す] リンクなしで展開された状態で表示され、タイトルはセンタリングされます。
:* <code>off</code> を設定すると、Navbox は右端に [隠す] リンクなしで展開された状態で表示されますが、タイトルはセンタリングされません。これは上級者向けのオプションで、多くの場合 <code>plain</code> の使用で十分です。
:* <code>autocollapse</code>, <code>collapsed</code>, <code>plain</code>, <code>off</code> 以外の値（例: <code>uncollapsed</code>）<ref group="※">[[Template:collapsible option]]の説明では、<code>expanded</code>を使用しています。</ref>を設定すると、Navbox は [隠す] リンクありで展開された状態で初期表示されます。

:* 例: {{tl|建築}} のデフォルト状態は autocollapse です。 [[建築家]]には Navbox が1つしかないので、展開表示されます。一方、 [[都市計画]] では autocollapse な Navbox が複数使われているので、閉じた状態で表示されます。<!-- テンプレートの使用状況が変わると例にならなくなるので時々チェックと差し替えが必要そうです。-->
:* 初期状態をテンプレート作者の期待する Navbox の初期状態を記事で上書きできる様にする場合は、テンプレートに "state" という名前のパラメータを作成し、次の様にパススルーにします。
:* <code><nowiki>| state = {{{state|<includeonly>希望する初期状態</includeonly>}}}</nowiki></code>
<!-- 対応するテンプレート及び記事が存在しないので訳出せず -->
<!--
:* Example: {{tl|Historical currencies of Hungary}} with expanded as the default initial state. All transcluding articles shows the content by default, unless there were an hypothetical article that specifies state = collapsed when transcluding.
-->
:* <nowiki><includeonly>|</nowiki> により、テンプレート自身を表示する際には展開される様にできます。

; ''navbar''
: デフォルトは <code>Tnavbar</code> です。<code>plain</code> を設定すると、タイトルバー左の {{Tnavbar|Navbox|mini=1|nodiv=1}} リンクは表示されません。

; ''border''
: 指定可能な値には<code>child</code>と<code>none</code>があります。既定値は空白です。<code>child</code>と指定するとテンプレート全体の罫線が非表示になります。任意のNavboxテンプレートを{{tl|Navbox subgroup}}のように別のNavboxテンプレート(親Navbox)の中におけるリストの一つをしてネストしたい場合に<code>child</code>と指定し、親Navboxの<code>list</code>の部分にテンプレートを置きます。{{tlc|Navbox|child|...}}のように引数1に設定しても良い。

; ''titlegroup''
: ''group<sub>n</sub>''セルと同じデフォルトスタイルのグループセルをタイトルの領域に挿入します。これは発展的なメタテンプレートのような例外的な状況でのみ使われるべきで、これを使う際には {{Tl|Navbox}} 内部のコードに関するいくつかの知識が必要ですが、もし使いたい場合は、全てにおいて正確に機能するために手動でCSSスタイルを設定するべきです。このパラメータの利用を考える場合は、あなた自身で変更するか、ノートページで始めに話し合ってください。

; ''listclass''
: デフォルトは指定なしです。これを指定するとlistを{{Tl|Flatlist}}のように横リストとして表示することができますが、リストは[[Help:ページの編集#箇条書き|「*」を用いた箇条書き]]で記述する必要があります。これは[[MediaWiki:Common.css|Common.css]]で指定されている hlist クラスを利用しています。指定できる引数は次の通りです。
:* <code>hlist</code> - 一般的な横リストを作成するときに使用します。項目の区切りに「'''·'''」（[[中黒#符号位置|中点（ラテン）]]）を使います。
:* <code>hlist hlist-pipe</code> - 項目の区切りに「'''|'''」（バーティカルバー、パイプ記号）を使います。
:* <code>hlist hlist-hyphen</code> - 項目の区切りに「'''-'''」（ハイフンマイナス）を使います。
: このクラスが指定されていると、2階層以降のリスト階層ごとに「（ ）」（括弧）でくくられ、階層ごとに指定された項目の区切りで表示されます。