Template:Tnavbar/doc
 | これはTemplate:Tnavbarの解説サブページです。 使用方法、カテゴリ、およびその他テンプレート自体に含まれない情報を収容しています。 |
このテンプレート tnavbar (template navigation bar) はテンプレートへリンクするためのものです。テンプレート自身に埋め込んで、そのノートページなどへのリンクを作ることができます。テンプレートが使われているページから、読者が直ちにテンプレートページへたどり着けるようになり、便利です。
（2023年9月更新）Template名前以外のページ（Wikipedia名前空間やPortal名前空間、利用者名前空間など）で当テンプレートを使用することが可能になりました。以前はTemplate名前以外のページで使うとリンクが正しく機能しませんでした。
使用法
[編集]{{Tnavbar|Tnavbar/doc}} と記述すると
という表示が得られます。
以下から適当なものを選んで、目的のテンプレートに貼り付ければそのまま利用することができます。
→ 記述例
|
表示 |
|---|---|
{{Tnavbar|{{subst:FULLPAGENAME}}}}
|
|
{{Tnavbar|{{subst:FULLPAGENAME}}|plain=yes}}
|
|
{{Tnavbar|{{subst:FULLPAGENAME}}|mini=yes}}
|
|
{{Tnavbar|{{subst:FULLPAGENAME}}|brackets=yes}}
|
|
{{Tnavbar|{{subst:FULLPAGENAME}}|plain=yes|brackets=yes}}
|
|
{{Tnavbar|{{subst:FULLPAGENAME}}|mini=yes|brackets=yes}}
|
|
{{Tnavbar|template={{subst:FULLPAGENAME}}|plain=yes}}
|
|
{{Tnavbar|template={{subst:FULLPAGENAME}}|mini=yes}}
|
記述例中の {{subst:FULLPAGENAME}} は、テンプレートの編集を保存した際にそのテンプレートのページ名に置換されます。
また、ほとんどの場合でこのテンプレートを直接使用するより、{{Navbox}}、{{Infobox}} といったラッパーを利用するほうが簡便です。ご検討ください。
引数
[編集]以下の引数の説明におけるyesという値については、y、true、t、1、onとしても同じ効果があります。
| 引数 | 指定内容 | 既定値 | 説明 |
|---|---|---|---|
| 1 template |
テンプレート名 | なし | 必須。tnavbar からリンクするテンプレートのページ名です。Template名前空間で使用する場合は名前空間プレフィックス (Template:) を付けても付けなくても構いません。Template名前空間以外で使用する場合はWikipedia:○○のように必ず名前空間プレフィックスを付けてください。|template=でページ名を指定した場合はデフォルトで「表示」以外のリンクが表示されなくなりますが、追加の引数を指定することでリンクの種類を増やすことができます（後述）。
|
| plain | 「このボックス:」表示の有無 | 表示あり | |plain=yesと指定すると、ナビゲーションの前に「このボックス:」という文章を表示されなくなります。
|
| mini | 短縮版にするか | 非短縮版 | |mini=yesと指定すると、ナビゲーションの前に「このボックス:」という文章を表示されなくなり、さらに各種リンク文字列が一文字になります。
|
| viewplain | テンプレートページのみにリンクする | テンプレートページのみにリンクし、ノートページなどへのリンクは表示しないシンプルな形式です。
| |
| brackets | リンクの前後に角括弧を付けるか | 括弧を付けない | |brackets=yesとすると、リンク文字列の手前と直後に半角角括弧を挿入します。|plain=や|mini=と同時に指定することも可能です。
|
| text | 「このボックス:」のカスタマイズ | このボックス: | 「このボックス:」というテキストを別のテキストに置き換えます。
|
| style | スタイル指定 | なし | このテンプレートが出力するdiv要素のstyle属性値を指定します。 |
| fontstyle | フォントのスタイル指定 | なし | フォントのスタイルを指定します。ハイパーリンクのデフォルト文字色などを上書きできます。 |
| fontcolor | 文字色 | 指定なし | 文字色を指定します。ハイパーリンクのデフォルト文字色を上書きします。 |
リンクの種類をカスタマイズする
[編集]「表示」のリンクは常に表示されますが、それ以外のリンクについては追加の引数を使うことで選択的に表示させることができます。この機能を{{Tnavbar}}で使うには呼び出し元のページ名を|1=ではなく|template=で指定する必要がありますが、ショートカットテンプレートの{{V}}と{{View}}を使えばこの制約がなくなるので、より簡単です。{{V}}は|mini=yes、{{View}}は|plain=yesとした場合と同等の表示になります。
→ 記述例
|
表示 |
|---|---|
{{Tnavbar|template=テスト}}
|
|
{{V|テスト}}
|
|
{{View|テスト}}
|
|
{{V|テスト|e}}
|
|
{{V|テスト|edit}}
|
|
{{V|テスト|t|h}}
|
|
{{V|テスト|talk|hist}}
|
|
{{View|テスト|t|e|h|m|w}}
|
|
{{View|テスト|talk|edit|hist|move|watch}}
|
|
{{V|テスト|t|e|h|m|w}}
|
マークアップ
[編集]2023年8月以前はspan要素をdiv要素（|nodiv=1とした場合はspan要素）で囲うようなマークアップになっており、|nodiv=を指定しないとテンプレートの出力の前後で強制的に改行されていました。
2023年9月の更新により、このテンプレートはhlistクラス付きのul要素をdiv要素で囲うようなマークアップに変更されました。外側のdiv要素にはdisplay:inline;というスタイルが適用されているため、テンプレートの出力の前後で強制的に改行されるということはなくなりました。
ul要素をspan要素の子要素とすることはHTMLのルールに違反するという事情があることから、2023年9月以降|nodiv=は無視されます。よって当テンプレートの呼び出しを<span>...</span>で囲うようなことはしないでください。そのようなことをするとdiv-span-flipのLintエラーが発生します。
関連するテンプレート
[編集]- {{tnavbar-header}}
- tnavbar を右に float して表示します。ナビゲーションテンプレートの見出し部分に便利です。
- {{tnavbar-collapsible}}
- collapsible tables を利用しているテンプレートで利用できます。
以下はナビゲーションテンプレート作成の際に利用できるメタテンプレートの一覧です。
| 折畳モード | タイトル色 | 画像 | グループ | スタイル パラメータ |
例テンプレート | |
|---|---|---|---|---|---|---|
| {{Navbox}} | collapsible | navbox | Left/Right of body | Yes | Yes | {{イギリスの電車}} |
| {{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes | {{都道府県知事}} |
| {{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes | {{日本近代地震}} |
| {{Navbox subgroup}} | collapsible | navbox | No | Yes | Yes | {{日本百名山}} |
| {{NavboxYears}} {{NavboxYears2}} |
collapsible | navbox | No | No | No | {{全豪オープン}} |
| 種類 | CSSクラス | Javascript | 畳まれるとき | Custom initial state |
ネスト | タイトル色 | フォントサイズ |
|---|---|---|---|---|---|---|---|
| Collapsible table | collapsible, navbox | Common.jsにて定義 | 2個以上 | Yes | No | #ccccff | 90% |