本模板用於生成一個導航框。本模板是元模板,主要用於製作其他模板。
基本參數列表
導航框使用小寫的參數名稱。所有的參數都是可選的。
基本的和最常見的參數如下所示(參見下方查看完整的列表,這些參數都是可省略的):
name
:模板的名稱(「Template:」後面的部分,注意不是模板的完整標題)。如果有該值,則標題的左邊會加上一個「查 · 論 · 編」的鏈接導航欄。title
:標題欄的文字,也就是這個導航框的標題。titlestyle
:用於標題欄的CSS樣式。groupstyle
:用於所有分組單元格的CSS樣式。子框表的分組不受此影響。above
:在group/list區段之上顯示的文字。groupn
(其中n是任意非負數):左側分組單元格內的文字。listn
(其中n是任意非負數):右側列表單元格內的文字。你可以在這裡面使用維基文本語法來生成一個無序列表。由於導航框默認添加了hlist類,因此無序列表會顯示為由小圓點隔開的水平列表。below
:在group/list區段之下顯示的文字。groupwidth
:整個導航框的 group 這一欄的寬度,請勿習慣性地在值後面加分號。請勿使用|groupstyle=width:<寬度>
。
參數描述
屬性
name
模板的名稱。為了在所有使用了所生成模板的頁面上,標題欄左側的「檢 · 論 · 編」鏈接都能正確地工作,就需要設置這個參數。你可以輸入{{subst:PAGENAME}}
作為這個參數的值,這也是個快捷的方法。
state
模板是否可摺疊。collapsible
為可摺疊,collapsed
為可摺疊且默認已經摺疊,plain
為不可摺疊(右邊不顯示「展開」「摺疊」按鈕)。默認情況下,除了子框之外,都是可摺疊的。
nocat
設為1可阻止本模板加入#追蹤分類。
單元格
title
顯示在表格頂端一行居中位置的文字。它通常是該模板的主題,也就是主體內容的一個簡要描述。本參數從技術上來說不是必需的,但是使用導航框而不帶標題通常是沒有意義的。
groupn(如group1、group2、group3……)
n為非負數。如果被指定,文字會顯示在位於listn左側的分組單元格中。如果被省略,對應的列表單元格就會占用表格的全部寬度。
listn(如list1、list2、list3……)
n為非負數,該模板的列表單元格,通常含有多個鏈接的無序列表。如果第n個列表不存在,則第n個分組單元格(groupn)也不會顯示,但是不會對後面的列表(若有)造成影響。
groupa-b(a、b均為數字)
將第a個列表單元格設置為一個子導航框,該子導航框的第b個分組。不應與groupa、lista等共存,如果共存,則groupa、lista直接被忽略。
lista-b(a、b均為數字)
將第a個列表單元格設置為一個子導航框,該子導航框的第b個列表。同上,不應與groupa、lista等共存,如果共存,則groupa、lista直接被忽略。
above
一個全寬度單元格,顯示在標題欄之下,分組與列表部分(group、list)之上。
below
一個全寬度單元格,顯示在分組與列表部分(group、list)的下方。
titlea、abovea、belowa
將第a個列表單元格設置為一個子導航框,該子導航框的標題、上方框或下方框。同上,不應與groupa、lista等共存,如果共存,則groupa、lista直接被忽略。
這裡對參數做一個更加形象的展示:
樣式參數
一般不建議更改樣式,以保持Wiki中模板和網頁的一致性。然而,修改樣式的選項還是有的。簡單地說,在單元格參數後面加一個style即為該單元格的樣式。
bodystyle
指定應用到模板主體的CSS樣式。此選項應謹慎使用。亦可簡寫成style
。
titlestyle
應用到標題的CSS樣式。
groupstyle
應用到所有分組單元格的樣式。該選項覆寫應用於整個表格的任何樣式。子框表的分組單元格不受影響。
liststyle
應用到所有列表單元格的CSS樣式。該參數影響子框表的列表單元格。
oddstyle、evenstyle
應用到所有的第奇數/偶數個列表。會與liststyle的樣式(若有)疊加,但優先級更高。缺省的表現是分別添加條紋狀的顏色(白色和灰色)到奇數/偶數行,以提高可讀性。一般不建議修改。
該參數會影響子框表的列表單元格。
注意:奇偶性的判斷是看這個列表在整個根框表中是第幾個,與參數名稱中的標號無關。
abovestyle、belowstyle
應用到頂端單元格(通過above參數指定)和底端單元格(通過below參數指定)。典型地被用來設置背景顏色或文本對齊方式。舉例:
abovestyle = background:#nnnnnn;
abovestyle = text-align:[left/center/right];
groupnstyle、listnstyle
第n個分組或列表的CSS樣式。
groupa-bstyle、lista-bstyle
類似地,第a個列表的子導航框的第b個分組或列表的樣式。
listngroupwidth、lista-bgroupwidth
參考上面的樣式。僅限於在有子導航框的情況下,設置該子導航框的分組單元格寬度。
類參數
與樣式參數類似,設置一類或一個單元格的(類)。這裡不再贅述。其中,bodyclass
等價於class
。
目前有以下類支持調整導航框顯示:
plainbox
:分組單元格顯示在列表單元格上方占用整個寬度,而是顯示在列表單元格左邊。這樣可以避免浪費屏幕空間。vertical
:分組單元格豎着顯示。適用於列表單元格比較龐大的情形。
注意:所有的導航框自帶hlist
類,因此有序列表和無序列表都會水平顯示。
追蹤分類
本導航框目前只適用兩個追蹤分類:
- Category:使用背景顏色的導航框:當標題框的CSS有background屬性時,會自動加入此分類。
- Category:name參數和實際不同的導航框:如果設置了name屬性,但該屬性與模板實際標題不同,則會加入此分類。
添加參數|nocat=1
可以強制禁止自動加入分類。
已棄用的參數
以下這些參數已不再受支持。如果發現有模板仍在使用的,請將其刪除。
navbar
:用於控制導航欄。已不再受支持。titlegroup
、titlegroupclass
、titlegroupclass
:用於在導航框標題前添加一個分組框。當前不支持。image
、imageleft
、imageclass
、imagestyle
:用於在導航框右側或左側添加一個圖片,占用整個導航框的高度。沒必要使用。basestyle
:用於所有單元格的樣式。應分別給各類單元格設置樣式。evenodd
:設為swap
可交換奇數和偶數行框的樣式。暫時不支持。listpadding
、list1padding
:用於設置各列表框的CSS padding屬性。暫不支持。請直接使用liststyle
。tracking
:設為no
可阻止加入任何追蹤分類。目前不受支持,請直接使用|nocat=1
。innerstyle
:整個主體table元素內套的一層內部table元素的樣式。當前版本不再會嵌套一個table,因此該參數無效。
參見
- {{Navbox subgroup}}:舊版的用於創建子導航框的模板。你也可以直接使用navbox模板作為listn的值,而不是navbox subgroup。
- {{Navbox with columns}}:以欄取代組別/列表。該模板仍使用舊版語法,且不建議使用。
- {{Navbox with collapsible groups}}:設置多個可摺疊組的導航框。
- {{NavboxV2}}:Navbox的另一個版本,不能與當前版本混用。
- {{Nowrap begin}}:不建議使用。
{{·}}及{{•}}:分隔列表項目的圓點。已經棄用,因為navbox自帶hlist類,可直接使用無序列表實現。如有已經使用了{{.w}}的,請直接將其改成無序列表。- {{collapsible option}}:提示控制模板的顯示狀態。
- {{NavboxYears}}:用來製作有相同後綴條目名稱列表,多用於顯示同一件事多年份的條目表。不建議使用。