Template:Tnavbar/doc
 | This is a documentation subpage for Template:Tnavbar. It contains usage information, categories and other content that is not part of the original template page. |
このテンプレート tnavbar (template navigation bar) はテンプレートへリンクするためのものです。テンプレート自身に埋め込んで、そのノートページなどへのリンクを作ることができます。テンプレートが使われているページから、読者が直ちにテンプレートページへたどり着けるようになり、便利です。
使用法
{{Tnavbar|Tnavbar/doc}} と記述すると
という表示が得られます。
以下から適当なものを選んで、目的のテンプレートに貼り付ければそのまま利用することができます。
→ 記述例
|
表示 |
|---|---|
{{Tnavbar|{{subst:PAGENAME}}}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|plain=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|nodiv=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|plain=1|nodiv=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|mini=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|mini=1|nodiv=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|viewplain=1}}
|
|
{{Tnavbar|{{subst:PAGENAME}}|mini=1|viewplain=1}}
|
記述例中の {{subst:PAGENAME}} は、テンプレートの編集を保存した際にそのテンプレートのページ名に置換されます。
また、ほとんどの場合でこのテンプレートを直接使用するより、{{Navbox}}、{{Infobox}} といったラッパーを利用するほうが簡便です。ご検討ください。
引数
| 引数 | 指定内容 | 既定値 | 説明 |
|---|---|---|---|
| 1 | テンプレート名 | なし | 必須。tnavbar からリンクするテンプレートのページ名です。名前空間部分 (Template:) は除きます。 |
| plain | 「このテンプレートを:」表示の有無 | 表示あり | ナビゲーションの前に「このテンプレートを:」という文章を表示するかどうか指定します。表示しないときは、plain=1 と記述してください。
|
| nodiv | div 要素とするか | div 要素として出力 | このテンプレートが出力するHTML要素を div にするかどうか指定します。規定は div 要素で、nodiv=1 とすると span 要素として出力します。
|
| mini | 短縮版にするか | 非短縮版 | リンク文字列を一文字にし、コンパクトな表示にするかどうか指定します。短縮版にするには mini=1 とします。
|
| viewplain | テンプレートページのみにリンクする | テンプレートページのみにリンクし、ノートページなどへのリンクは表示しないシンプルな形式です。
| |
| style | スタイル指定 | なし | このテンプレートが出力する div または span の style 属性値に追加指定します。 |
| fontstyle | フォントのスタイル指定 | なし | フォントのスタイルを指定します。ハイパーリンクのデフォルト文字色などを上書きできます。 |
| fontcolor | 文字色 | 指定なし | 文字色を指定します。ハイパーリンクのデフォルト文字色を上書きします。 |
ラッパー
- {{tnavbar-header}}
- tnavbar を右に float して表示します。ナビゲーションテンプレートの見出し部分に便利です。
- {{tnavbar-collapsible}}
- collapsible tables を利用しているテンプレートで利用できます。
以下はナビゲーションテンプレート作成の際に利用できるメタテンプレートの一覧です。
| Template | Collapsible | Header color | Image | Groups | Style (body) parameter/s |
|---|---|---|---|---|---|
| {{Navbox}} | collapsible | navbox | Left/right of body | Yes | Yes |
| {{Navbox with collapsible groups}} | collapsible | navbox | Left/right of body and/or in each list | Yes | Yes |
| {{Navbox with columns}} | collapsible | navbox | Left/right of columns | No | Yes |
| Type | CSS classes | JavaScript | Collapses when | Custom initial state |
Nesting |
|---|---|---|---|---|---|
| Collapsible tables | mw-collapsible | Defined in Common.js | 2 or more autocollapse on page | Yes | Yes |