本模板用于生成一个导航框。本模板是元模板,主要用于制作其他模板。
基本参数列表
导航框使用小写的参数名称。所有的参数都是可选的。
基本的和最常见的参数如下所示(参见下方查看完整的列表,这些参数都是可省略的):
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}}:用来制作有相同后缀条目名称列表,多用于显示同一件事多年份的条目表。不建议使用。