テンプレート:Navbox/doc

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

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

Module:Navbox/former

このテンプレートを使えば、リンク先リストをつくるだけでナビゲーション用テンプレートをかなり素早く作ることができるようになります。多くのナビゲーションテンプレートでそのまま使えるスタイルがデフォルトで提供されています。デフォルトスタイルを変更することは可能ですが、推奨されていません。このテンプレートあるいは右の“Navbox一式”の姉妹テンプレートのいずれかを使うことが、ナビゲーション用テンプレートを標準化したり使いやすくしたりするために強く推奨されています。また、|bodyclass=hlistを指定することにより、リストを*（アスタリスク）を使っての箇条書きで列挙することができます。

使用法[ソースを編集]

グループ数が少ない場合など、使わないパラメータは消去してください。

{{Navbox
|name    = {{subst:PAGENAME}}
|listclass = hlist
|state   = 
|title   = 
|image   = 
|above   = 

|group1  = 
|list1   = 

|group2  = 
|list2   = 

 ...

|group20 = 
|list20  = 

|below   = 
}}

パラメータ[ソースを編集]

必須[ソースを編集]

name: テンプレートの名前は、テンプレートが使われている全てのページで「表・話・編・歴」（"表示・会話・編集・履歴"）リンクが正しく機能するために必須です。値には{{subst:PAGENAME}}を用いると便利です。
title: 表の最上部中央に表示されるテキストです。通常はテンプレートの主題、つまり表本体の簡潔な説明です。これは一行でなければなりませんが、二行目が必要な場合は、センタリングが正しく行われる様、{{-}}を使ってください。

list_n (body may be used in place of list1)

（list1、list2、など）テンプレート本体、通常はリンク先のリストです。書式はインラインですが、<div> </div>でリスト全体を囲めば複数行での入力もできます。最低でもlistパラメータは一つ必要です。以降のlistは、それぞれ表の別の行に表示されます。 group_nパラメータが指定されていると、個々の list_n の前にそのグループが表示されます（下記参照）。

任意[ソースを編集]

セル[ソースを編集]

group_n

（group1、group2、など）指定されたテキストがlist_nの左、ヘッダセルに表示されます。指定がなければ、list_nは表の全幅を使います。

image

タイトルバーの下、本体 (group/list) の右に指定された画像を表示します。list1の指定は適切な表示に必須です。画像の指定には、

[[ファイル:Example.jpg|100px]]

といった、画像表示に用いられる標準的ウィキコードを用います。

imageleft

タイトルバーの下、本体 (group/list) の左に指定された画像を表示します。list1の指定は適切な表示に必須です。画像の指定には、

[[ファイル:Example.jpg|100px]]

といった、画像表示に用いられる標準的ウィキコードを用います。

above

タイトルバーと最初の group/list との間、すなわちテンプレート本体（group、list または image）の above （上）に表示される全幅セルです。画像のないテンプレートの場合、aboveはgroup1パラメータなしのlist1と同様に表示されます。above パラメータの使用例としては、{{Navbox Musical artist}}による {{ビートルズ}}、{{サザンオールスターズ}} 、 {{Navbox with columns}} による {{アメリカ合衆国大統領}} 、{{Navbox}}による {{日本国憲法}} などがあります（2013年9月現在）。

below

テンプレート本体（group、list または image）の below （下）に表示される全幅セルです。画像のないテンプレートの場合、belowはgroup_nパラメータなしの最後のlist_nと同様に表示されます。below パラメータの使用例としては、{{Navbox Musical artist}} による {{ベートーヴェンの交響曲}} 、{{Navbox}} による {{イギリス国鉄の蒸気機関車}} 、 {{日本国歴代内閣総理大臣}} などがあります（2013年9月現在）。

スタイル（推奨しない）[ソースを編集]

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

デフォルトスタイル[ソースを編集]

テンプレート:rellink Navbox を使う際によく変更されるスタイルを示します。他の、よりこみいったスタイルは一覧を単純にするため示していません。

bodystyle = background-color:#fdfdfd; width:100%; vertical-align:middle;

titlestyle = background-color:#ccccff; padding-left:1em; padding-right:1em; text-align:center;

abovestyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:center;

belowstyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:center;

groupstyle = background-color:#ddddff; padding-left:1em; padding-right:1em; text-align:right;

liststyle = background:transparent; text-align:left/center;

oddstyle = background:transparent;

evenstyle = background-color:#f7f7f7;

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

その他[ソースを編集]

state [autocollapse, collapsed, plain, off, uncollapsed]

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

例: {{建築}} のデフォルト状態は autocollapse です。建築家には Navbox が1つしかないので、展開表示されます。一方、都市計画では autocollapse な Navbox が複数使われているので、閉じた状態で表示されます。
初期状態をテンプレート作者の期待する Navbox の初期状態を記事で上書きできる様にする場合は、テンプレートに "state" という名前のパラメータを作成し、次の様にパススルーにします。
| state = {{{state<includeonly>|希望する初期状態</includeonly>}}}
<includeonly>| により、テンプレート自身を表示する際には展開される様にできます。

navbar: デフォルトは Tnavbar です。plain を設定すると、タイトルバー左の表・話・編・歴リンクは表示されません。

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

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

テーブルのレイアウト[ソースを編集]

{{Navbox}}を使い、image, above and below パラメータを指定せずに作成された表（境界は説明のために追加）:

{{Navbox}}を使い、image, above and below パラメータを指定して作成された表（境界は説明のために追加）:

{{Navbox}}を使い、image, imageleft, lists, and without groups, above, below パラメータを指定して作成された表:

使用例[ソースを編集]

画像なし[ソースを編集]

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist

| group1 = Centre
| list1  =
* [[Cyberjaya]]

| group2 = Area
| list2  =
* [[Klang Valley]]

| group3 = Major landmarks
| list3  =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]

| group4 = Infrastructure
| list4  =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Prime applications
| list5  =
* [[EGovernment]]
* [[MyKad]]
}}

画像あり、グループなし[ソースを編集]

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]

| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]
* [[Kuala Lumpur International Airport]]
}}

二画像、グループなし、複数リスト[ソースを編集]

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]
| imageleft = [[File:Flag of Malaysia.svg|80px]]

| list1 =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]

| list2 =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| list3 =
* [[EGovernment]]
* [[MyKad]]

| list4 =
* [[Klang Valley]]
}}

画像、グループ、above, below あり[ソースを編集]

{{Navbox
| name  = Navbox/doc
| title = [[Multimedia Super Corridor|MSC Malaysia]]
| listclass = hlist
| above = Above text goes here
| image = [[File:Flag of Malaysia.svg|80px|link=|alt=]]

| group1 = Centre
| list1  =
* [[Cyberjaya]]

| group2 = Area
| list2  =
* [[Klang Valley]]

| group3 = Major landmarks
| list3  =
* [[Petronas Twin Towers]]
* [[Kuala Lumpur Tower]]
* [[Kuala Lumpur Sentral]]
* [[Technology Park Malaysia]]
* [[Putrajaya]]
* [[Cyberjaya]]

| group4 = Infrastructure
| list4  =
* [[Express Rail Link]]
* [[KL-KLIA Dedicated Expressway]]

| group5 = Prime applications
| list5  =
* [[EGovernment]]
* [[MyKad]]

| below  = Website: {{URL|http://www.msc.com.my/}}
}}

表示・ノート・編集・履歴	折畳モード	タイトル色	画像	グループ	スタイルパラメータ	例テンプレート
{{Navbox subgroup}}	`collapsible`	navbox	No	Yes	Yes	{{日本百名山}}
{{Navbox}}	`collapsible`	navbox	Left/Right of body	Yes	Yes	{{イギリスの電車}}
{{Navbox with columns}}	`collapsible`	navbox	Left/right of columns	No	Yes	{{都道府県知事}}
{{NavboxYears}} {{NavboxYears2}}	`collapsible`	navbox	No	No	No	{{全豪オープンテニス}}
{{Navbox with collapsible groups}}	`collapsible`	navbox	Left/right of body and/or in each list	Yes	Yes	{{日本近代地震}}