跳至內容

模板:導航盒/文檔

首頁 > 說明 > Template:導航盒/文檔
     

本模板「Navbox翻譯版」為允許通過提供一個或多個連結列表,從而相對快速地建立一個導航模板。它配備了預設樣式,這些樣式應能對付大多數導航模板。不建議改變預設樣式,儘管這是可以的。為了導航模板的標準化,也為了便於使用,強烈建議使用這個模板,或者它的「Navbox系列」姊妹模板中的某一個。

使用方法

調用參數

請移除置空不用的參數。

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题=
|图片=
|头栏=

|分组1=
|列表1=

|分组2=
|列表2= 

……

|分组22= 
|列表22= 

|尾栏= 
}}

參數列表

如果省略其他參數,必需的 名稱標題 會創建一個單行方框。

請注意「分組1」(等等)是可選的,命名為「頭欄/尾欄」的部分也是可選的。

基本的和最常見的參數如下所示(參見下方查看完整的列表):

名称 - 模板的名稱。
标题 - 標題欄的文字,像[[化学分支]]。
折叠 - autocollapse、uncollapsed、collapsed:方框的摺疊狀態,其中「autocollapse」會自動隱藏被堆疊的多個導航框。
标题样式 - 一個用於標題欄的CSS樣式,像:background:gray;
分组样式 - 一個用於分組單元格的CSS樣式,像:background:#eee;
图片 - 一個可選的置於右側的圖片(以完整的image標籤的形式編碼:[[File:XX.jpg|90px]])。
左侧图片 - 一個可選的置於左側的圖片(編碼方式與「圖片」參數相同)。
头栏 - 分組/列表 區段之上顯示的文字(可能是一欄綜合的維基連結)。
分组n - 左側的文字,在list-n之前(如果group-n被省略,list-n從方框的左側開始)。
列表n - 列出維基連結的文字,通常以圓點符號模板分隔開來,像:[[A]]<code> · </code> [[B]]
尾栏 - 分組/列表 區段之下顯示的可選文字。

進一步的細節,以及複雜的約束,在下方參數描述章節作了解釋。參見其他的一些替代導航格式:表格布局

參數描述

下面是用於{{導航盒}}的參數的一個完整清單。在大多數情況下,只要有參數名称标题列表1就可以了,儘管子導航框甚至不需要設置那些參數。

{{導航盒}}與它的姊妹模板{{Navbox with columns}}{{Navbox with collapsible groups}}共用很多常用的參數名稱,以提高一致性與易用性。帶一個標記的參數適用於所有這三個主模板。

設置參數

名稱
模板的名稱。為了在所有使用了所生成模板的頁面上,「刷 • 閱 • 編 • 歷」連結都能正確地工作,就需要設置這個參數。你可以輸入{{FULLPAGENAME}}作為這個參數的值,這也是個快捷的方法。此參數是必需的。
摺疊 [autocollapse、uncollapsed、collapsed、plain、off]
  • 預設為autocollapse。如果在使用了其他可摺疊表格的同一個頁面上有兩個或更多表格,那麼該頁面上的帶autocollapse的導航框一開始就會摺疊起來。否則,該導航框會被展開。要了解技術上的實現,請參見MediaWiki:Common.js
  • 如果設置為collapsed,該導航框總會在開始時以摺疊起來的狀態展現。
  • 如果設置為plain,該導航框總會在被展開時不帶右側的「隱藏」連結,並且標題會保持居中(通過使用補白來偏移刷 • 閱 • 編 • 歷連結)。
  • 如果設置為off,該導航框總會在被展開時不帶右側的「隱藏」連結,但是沒有補白會被用來保持標題居中。這只是為了高級用法;「plain」選項應能滿足大多數需要將「顯示」/「隱藏」按鈕隱藏起來的應用。(英文模板已實現。)
  • 如果設置為除autocollapsecollapsedplainoff之外的其他值(像「uncollapsed」),該導航框總會在開始時以展開的狀態出現,但是帶有「隱藏」按鈕。
若要在獨處(未被包含)時顯示框體,而在一個條目中時自動隱藏內容,可以將「uncollapsed」置於標籤之內:
  • 折叠 = <noinclude>uncollapsed</noinclude>
  • 如此設置會強制框體在獨處時(甚至是在跟有其他方框時)可見,顯示「隱藏」按鈕,而當被堆疊在一個條目中時自動摺疊框體。
很多時候,對於一個導航框,編輯者會想要一個預設的初始狀態,並且在條目中它可以被覆寫。要做到這一點,這裡有個竅門:
在你的居間模板里,創建一個參數也命名為「state」作為一個傳遞,像這樣:
  • | 折叠 = {{{折叠<includeonly>|你想要的初始状态</includeonly>}}}
  • The <includeonly>|會使得當查看模板頁面本身時,模板會被展開。

單元格

標題
顯示在表格頂端一行居中位置的文字。它通常是該模板的主題,也就是主體內容的一個簡要描述。這應該是單獨的一行,但是如果需要第二行,請使用{{-}}來保證正確的居中。本參數從技術上來說不是必需的,但是使用{{導航盒}}而不帶標題是相當沒有意義的。
分組n
(即分組1分組2等等)如果被指定,文字會顯示在位於列表n左側的抬頭單元格中。如果被省略,列表n占用表格的全部寬度。
列表n
(即列表1列表2等等)該模板的主體,通常為一欄連結。格式為內聯;然而,如果整個列表被裝入<div> </div>之內,文字能夠被輸入到不同的行中。最少需要一個列表參數;每個附加的列表被顯示在一個單獨的表格行中。每個列表n可能在其前面有一個相對應的分組n參數,如果提供了的話(參見下方)。
圖片
一張圖片,會顯示在 標題 之下、分組/列表 之右側的一個單元格中。為使圖片能正確地顯示,必須指定列表1參數。圖片參數接受標準的維基代碼來顯示圖片,即:
图片 = [[文件:图图图.png|100px]]
左側圖片
一張圖片,會顯示在 標題 之下、列表 之左側的一個單元格中。為使圖片能正確地顯示,必須指定列表1參數,而且不能指定分組左側圖片參數接受標準的維基代碼來顯示圖片,即:
左侧图片 = [[文件:图图图.png|100px]]
頭欄
一個全寬度單元格,顯示在標題欄與第一個 分組/列表之間,也就是位於該模板的主體(分組/列表圖片)之上。在一個不帶圖片的模板中,頭欄與不帶分組1參數的列表1參數以同樣的方式運作。
尾欄
一個全寬度單元格,顯示在該模板主體(分組/列表圖片)的下方。在一個不帶圖片的模板中,尾欄與該模板最後面的不帶分組n參數的列表n參數以同樣的方式運作。

樣式參數

一般不建議更改樣式,以保持維基百科中模板和網頁的一致性。然而,修改樣式的選項還是有的。

樣式
指定應用到模板主體的CSS樣式。主體樣式參數也有下面舉例的同樣效果,並能被用來代替這個樣式參數。此選項應謹慎使用,因為它可以導致視覺上的不一致。舉例:
样式 = background:#nnnnnn;
样式 = width:N [em/%/px or width:auto];
样式 = float:[left/right/none];
样式 = clear:[right/left/both/none];
標題樣式
應用到標題的CSS樣式,最常見的有導航欄的背景顏色:
标题样式 = background:#nnnnnn;
标题样式 = background:name;
分組樣式
應用到分組N單元格的CSS樣式。該選項覆寫應用於整個表格的任何樣式。舉例:
分组样式 = background:#nnnnnn;
分组样式 = text-align:[left/center/right];
分组样式 = vertical-align:[top/middle/bottom];
列表樣式
應用到所有列表的CSS樣式。若指定了下面的奇數樣式偶數樣式參數,則它們的優先級高於本參數。
奇數樣式
偶數樣式
應用到奇數/偶數編號的列表。會推翻由列表樣式定義的樣式。預設的表現是分別添加條紋狀的顏色(白色和灰色)到奇數/偶數行,以提高可讀性。除了在非常特別的情況下,這些設置不應更改。
頭欄樣式
尾欄樣式
CSS樣式,應用到頂端單元格(通過頭欄參數指定)和底端單元格(通過尾欄參數指定)。典型地被用來設置背景顏色或文本對齊方式:
头栏样式 = background:#nnnnnn;
尾栏样式 = text-align:[left/center/right];
預設樣式

這裡列出的樣式設置是使用導航框的編輯者最經常更改的那些設置。其他更加複雜的樣式設置被排除在這個列表之外,以保持它簡單。大多數樣式是在MediaWiki:Common.css中設置。

主体样式 = background:#fdfdfd; width:100%; vertical-align:middle;
标题样式 = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;
头栏样式 = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
尾栏样式 = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
分组样式 = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
列表样式 = background:transparent; text-align:left/center;
奇数样式 = background:transparent;
偶数样式 = background:#f7f7f7;

由於列表樣式奇數樣式是透明的,奇數列表有主體樣式的顏色,其預設值是#fdfdfd(白色帶有少許灰色)。一個列表text-align:left;設定,如果它有一個分組的話;否則,它有text-align:center;設定。由於只有主體樣式有一個垂直對齊(vertical-align)屬性,所 有其他樣式繼承其vertical-align:middle;設定。

表格布局

{{導航盒}}不帶圖片頭欄尾欄參數生成的表格(添加了灰色的列表背景色僅僅是為了演示):


{{導航盒}}帶有圖片頭欄尾欄參數生成的表格(添加了灰色的列表背景色僅僅是為了演示):


{{導航盒}}帶有圖片左側圖片列表,且不帶分組頭欄尾欄生成的表格(添加了灰色的列表背景色僅僅是為了演示):


示例

不帶圖片

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题 = [[英雄图鉴]]
|分组1=战士
|列表1=<ul><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li></ul>
|分组2=法师
|列表2=
*顾小满
*顾小满
*顾小满
*顾小满
|分组3=辅助
|列表3=秘银
}}


帶圖片,不帶分組

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题 = [[英雄图鉴]]
|图片 = [[file:ys_icon.png|link=|80px]]
|分组1=战士
|列表1=<ul><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li></ul>
|分组2=法师
|列表2=
*顾小满
*顾小满
*顾小满
*顾小满
|分组3=辅助
|列表3=秘银
}}


帶兩張圖片,不帶分組,多重列表

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题 = [[英雄图鉴]]
|图片 = [[file:ys_icon.png|link=|80px]]
|左侧图片= [[file:ys_icon.png|link=|80px]]
|列表1=<ul><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li></ul>
|列表2=
*顾小满
*顾小满
*顾小满
*顾小满
|列表3=秘银
}}


帶有圖片、分組、上方注釋、下方注釋

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题 = [[英雄图鉴]]
|图片 = [[file:ys_icon.png|link=|80px]]
|头栏 =此为样例
|分组1=战士
|列表1=<ul><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li><li>丛云</li></ul>
|分组2=法师
|列表2=
*顾小满
*顾小满
*顾小满
*顾小满
|分组3=辅助
|列表3=秘银
|尾栏 =此为样例
}}


子導航框

要在一個邊框中放置多個導航框,可以使用border參數,或通過將第一個參數指定為「child」來實現。基本用法如下(為第一個組增加了一個子組):

{{导航盒
|名称={{subst:FULLPAGENAME}}
|标题=标题

|分组1=[可选]
|列表1={{导航盒|child
   ...子导航内容...
 }}

...
}}

子分組示例

 主頁面:模板:子導航框

下面的示例展示了子分組的用法。{{子導航框}}是推薦的用法,但通過在{{導航盒}}加入border = child或將第一個參數(無名)設為child也可以達到同樣的效果。「evenodd」參數用來調整某些子分組中條紋狀顏色帶的分布,以確保顏色帶的排列正確。如果想去除所有的條紋顏色帶,可以在每個導航盒中設置列表样式 = background:transparent;


一個導航模板下包含其它導航模板

 主頁面:模板:Navbox with collapsible groups

下面的示例中,常規導航盒被用作容器,其列表1列表2列表3參數各包含另外的導航盒(設置了1 = child)。「刷•閱•編•歷」標題連結各通過navbar = plain或直接不填寫「名稱」參數隱藏。(與常規導航盒不同,子導航盒不要求填寫「名稱」參數。)



與其他導航框模板的關係

此導航框模板被特別設計使得能與另外兩個姊妹模板協同工作:{{Navbox with columns}}{{Navbox with collapsible groups}}。所有這三個模板共用常用的參數,以提高一致性與易用性(此類參數在上面的完整參數列表中用一個作了標記)。最重要的是,所有這三個模板能互相被用作另一個的子框。

技術細節

  • 此模板為其大部分外觀使用CSS類,因此它完全可以更換皮膚。
  • 欲了解更多技術細節請參見其MediaWiki:Common.css中的CSS類以及MediaWiki:Common.js中用來隱藏框體的可摺疊表格。

運作詳情

  • 列表單元格寬度初始被設置為100%。因此,如果你想手動設置分組單元格的寬度,你就需要同時指定liststyle使之有width:auto。如果你想設置分組寬度並使用圖片,這取決於你已弄明白在分組樣式列表樣式圖片樣式左側分組樣式參數中的CSS,以使所有部件都工作正常。以下兩行是設置分組寬度的示例:
分组样式 = width:10em;
列表样式 = width:auto;
  • 相鄰的導航框在它們之間僅有一個1px的邊框(除了在IE6中,因其不支持必需的CSS)。如果你設置了样式/主体样式的頂端外邊距(top margin)或底頂端外邊距(bottom margin),那麼此特性就不運作了。
  • 外層導航框表格的預設的左外邊距(margin-left)和右外邊距(margin-right)被設置為「auto;」。如果你想使用導航框作為一個浮動對象(float),你需要手動設置左外邊距和右外邊距的值,因為自動外邊距(auto margins)會阻止浮動(float)選項。例如,添加下列代碼來使用導航框作為一個浮動對象:
样式 = width:22em;float:right;margin-left:1em;margin-right:0em;

參見