Template:Navbox/doc
| 此页面是Template:Navbox的文档子页面。 此页面可能包含了使用说明、分类和其他内容,这些内容不属于原始Template页面。 |
| 此模板使用Lua语言: |
| 本模板使用以下模板样式: |
本模板可快速建立一个导航模板,配备了默认样式,能应付大多数导航模板。本模板也支持 {{Navbox subgroup}}、{{Navbox with collapsible groups}} 和 {{Navbox with columns}}。
用法
请移除置空不用的参数。
{{Navbox
| name = {{subst:PAGENAME}}
| title =
| listclass = hlist
| state = {{{state<includeonly>|autocollapse</includeonly>}}}
| above =
| image =
| group1 =
| list1 =
| group2 =
| list2 =
| group3 =
| list3 =
<!-- ... 最多 35 组 -->
| below =
}}<noinclude>
{{navbox documentation}}
</noinclude>
参数列表
基本的和最常见的参数如下所示:
name– 模板的名称("Template:" 后面的部分)title– 标题栏的文字listclass– list 单元格的 CSS 类,常设为hlist(水平列表)或plainlist(无符号列表)state– 方框的折叠状态(autocollapse / collapsed / expanded / plain / off)titlestyle– 标题栏的 CSS 样式groupstyle– 分组单元格的 CSS 样式above– 在 group/list 区段之上显示的文字image– 可选的右侧图片imageleft– 可选的左侧图片(可与 group 同时使用)groupn– 左侧的文字,在 list-n 之前listn– 列出维基链接的文字(最多支持 35 组)below– 在 group/list 区段之下显示的文字
参数描述
设置参数
name- 模板的名称,用于"查·论·编"链接正确工作。可以输入
{{subst:PAGENAME}}作为快捷值。 state[autocollapse, collapsed, expanded, plain, off]- 默认为
autocollapse。如果页面上同时有两个或更多可折叠表格,则自动折叠。 collapsed– 始终折叠;expanded– 始终展开;plain– 展开且隐藏折叠按钮;off– 展开、无折叠按钮、无标题补白。navbar- 设置为
plain隐藏"查·论·编"链接但保持标题居中;off隐藏链接但不加补白。 border[child, subgroup, none]- 设置为
child或subgroup可将此导航框用作无边框的子导航框嵌入到另一个导航框中。
单元格参数
title- 显示在表格顶端一行的标题文字,通常是该模板的主题。
above- 标题栏与第一个 group/list 之间的全宽度单元格。
groupn- (group1~group35)显示在 listn 左侧的抬头单元格。如果省略,listn 占用表格全部宽度。
listn- (list1~list35)模板的主体,每个导航框至少需要一个 list 参数。条目建议用
*星号分行列出。 image- 标题下方、主体右侧的图片。需同时指定 list1。
imageleft- 标题下方、主体左侧的图片。需同时指定 list1。
below- 主体下方的全宽度单元格。
titlegroup- 【本站特有】在标题行左侧显示一个分组标签。需配合
titlegroupstyle和titlegroupclass使用。
样式参数
bodystyle- 应用到模板主体的 CSS 样式。
basestyle- 同时应用到 title、above、below 和 group 单元格(不应用到 list)。
titlestyle- 应用到 title 的 CSS 样式。
groupstyle- 应用到所有 groupN 单元格的样式。
groupnstyle- 应用到特定 group 的样式。
groupwidth- group 单元格的统一宽度。
liststyle- 应用到所有 list 的样式。oddstyle/evenstyle 优先于此参数。
listnstyle- 应用到特定 list 的样式。
listpadding- 每个 list 单元格的内边距。默认左右 0.25em。
list1padding- 第一个 list 的专用内边距,优先级高于
listpadding。 oddstyle/evenstyle- 奇/偶数行的样式。默认奇数透明、偶数浅灰。
style- 应用到外容器表格的整体 CSS(与
bodystyle类似)。 innerstyle- 应用到内部表格的 CSS,仅在需要同时控制内外两层表格样式时使用。
evenodd[swap, even, odd, off]- 控制奇偶行条纹:
swap反转、even/odd统一颜色、off禁用。 abovestyle/belowstyle- above / below 单元格的样式。
imagestyle/imageleftstyle- 图片单元格的样式。
titlegroupstyle/titlegroupclass- 【本站特有】titlegroup 单元格的样式和 CSS 类。
nowrapitems- 【enwiki 特性】设为
yes时,列表项中由*/:/#/;开头的行将自动套用<span class="nowrap">。
其他参数
bodyclass/listclass/groupclass/aboveclass/belowclass/titleclass/imageclass/navboxclass- 对应单元格的 CSS 类。
listnclass- 每个 list 独立的 CSS 类(如 list1class、list2class 等)。
groupnstyle- 每个 group 独立的 CSS 样式(如 group1style、group2style 等)。
listnstyle- 每个 list 独立的 CSS 样式(如 list1style、list2style 等)。
templatestyles/child templatestyles- 自定义 TemplateStyles 页面,用于覆盖或补充默认样式。
nocat- 设为
true可禁用追踪分类。 tracking- 设为
no可禁用水平列表追踪分类。
子导航框
可以在一个导航框中嵌入多个子导航框。将 list 参数的值设为 child 或 subgroup,然后以 子编号_参数名 的形式指定子导航框的参数:
{{Navbox
| name = {{subst:PAGENAME}}
| title = 标题
| group1 = 分组1
| list1 = list1 内容
| group2 = 分组2
| list2 = child
| 2_group1 = 子分组2.1
| 2_list1 = 子列表2.1
| 2_group2 = 子分组2.2
| 2_list2 = 子列表2.2
}}
也可以使用嵌套模板方式:
{{Navbox
| name = {{subst:PAGENAME}}
| title = 标题
| list1 = {{Navbox|child
...子导航框参数...
}}
}}
子导航框也支持 type = with columns 和 type = with collapsible groups 来使用其他布局。
示例
不带图片
{{Navbox
|listclass=hlist
|name = Navbox 示例
|title = 多媒体超级走廊(马来西亚)
|group1 = 中心
| list1 = 赛柏再也
|group2 = 区域
| list2 = 巴生谷
|group3 = 主要地标
| list3 =
* 双子塔
* 吉隆坡电讯高塔
* 吉隆坡中央车站
* 布城
* 赛柏再也
|group4 = 基础设施
| list4 =
* 快速铁路
* 吉隆坡-布城高速公路
|group5 = 首要应用
| list5 =
* 电子政务
* 大马卡
}}
带图片
{{Navbox
|listclass=hlist
|name = Navbox 示例
|title = 多媒体超级走廊(马来西亚)
|image = [[File:Flag of Malaysia.svg|80px]]
|list1 =
* 双子塔
* 吉隆坡电讯高塔
* 吉隆坡中央车站
* 布城
* 赛柏再也
* 吉隆坡国际机场
}}
技术细节
- "查·论·编"链接由 Module:Navbar 生成。
- 分组与列表之间 2px 宽的边框使用列表单元格的左边框(border-left)绘制。如果改变模板背景色,需同步调整边框颜色。
- 相邻导航框之间仅有 1px 边框。设置
bodystyle的上下外边距会破坏此特性。 - 最多支持 35 组 group/list(group1~group35、list1~list35)。
- 直接调用
{{#invoke:Navbox|navbox}}可替代{{Navbox}},减少模板展开大小。
模板数据
Navbox模板数据
创建一个导航框,用于在页面底部显示相关页面的链接。
| 参数 | 描述 | 类型 | 状态 | |
|---|---|---|---|---|
| 模板名称 | name | 模板的名称,用于"查·论·编"链接正确工作
| 未知 | 推荐 |
| 标题 | title | 标题栏的文字,通常是导航模板的主题 | 未知 | 推荐 |
| 折叠状态 | state | 控制导航框的折叠行为
| 未知 | 推荐 |
| 列表CSS类 | listclass | list单元格的CSS类,常设为 hlist 使用水平列表
| 未知 | 可选 |
| 分组1 | group1 | 显示在list1左侧的标签 | 未知 | 推荐 |
| 列表1 | list1 | 导航框的主体内容,至少需要一个list参数 | 未知 | 必需 |
| 分组2 | group2 | 无描述 | 未知 | 可选 |
| 列表2 | list2 | 无描述 | 未知 | 可选 |
| 分组3 | group3 | 无描述 | 未知 | 可选 |
| 列表3 | list3 | 无描述 | 未知 | 可选 |
| 分组4 | group4 | 无描述 | 未知 | 可选 |
| 列表4 | list4 | 无描述 | 未知 | 可选 |
| 分组5 | group5 | 无描述 | 未知 | 可选 |
| 列表5 | list5 | 无描述 | 未知 | 可选 |
| 上方内容 | above | 标题栏与第一个group/list之间的全宽度单元格 | 未知 | 可选 |
| 下方内容 | below | 主体下方的全宽度单元格 | 未知 | 可选 |
| 右侧图片 | image | 标题下方、主体右侧的图片 | 文件 | 可选 |
| 左侧图片 | imageleft | 标题下方、主体左侧的图片 | 文件 | 可选 |
| 标题分组 | titlegroup | 在标题行左侧显示一个分组标签 | 未知 | 可选 |
| 标题分组CSS类 | titlegroupclass | 无描述 | 未知 | 可选 |
| 标题分组CSS样式 | titlegroupstyle | 无描述 | 未知 | 可选 |
| 不换行项目 | nowrapitems | 设为 yes 时列表项自动套用 nowrap
| 未知 | 可选 |
| 导航栏状态 | navbar | 控制"查·论·编"链接的显示
| 未知 | 可选 |
| 边框模式 | border | 设为 child 或 subgroup 可嵌入到另一个导航框中
| 未知 | 可选 |
| 主体样式 | bodystyle | 无描述 | 未知 | 可选 |
| 基础样式 | basestyle | 无描述 | 未知 | 可选 |
| 标题样式 | titlestyle | 无描述 | 未知 | 可选 |
| 分组样式 | groupstyle | 无描述 | 未知 | 可选 |
| 列表样式 | liststyle | 无描述 | 未知 | 可选 |
| 分组宽度 | groupwidth | 无描述 | 未知 | 可选 |
| 列表内边距 | listpadding | 无描述 | 未知 | 可选 |
| 奇数行样式 | oddstyle | 无描述 | 未知 | 可选 |
| 偶数行样式 | evenstyle | 无描述 | 未知 | 可选 |
| 奇偶行控制 | evenodd | 无描述
| 未知 | 可选 |
| 上方样式 | abovestyle | 无描述 | 未知 | 可选 |
| 下方样式 | belowstyle | 无描述 | 未知 | 可选 |
| 图片样式 | imagestyle | 无描述 | 未知 | 可选 |
| 左侧图片样式 | imageleftstyle | 无描述 | 未知 | 可选 |
| 外容器样式 | style | 应用到外容器表格的整体 CSS | 未知 | 可选 |
| 内部表格样式 | innerstyle | 应用到内部表格的 CSS | 未知 | 可选 |
| 列表1内边距 | list1padding | 第一个 list 的专用内边距,优先级高于 listpadding | 未知 | 可选 |
| 主体CSS类 | bodyclass | 无描述 | 未知 | 可选 |
| 分组CSS类 | groupclass | 无描述 | 未知 | 可选 |
| 上方CSS类 | aboveclass | 无描述 | 未知 | 可选 |
| 下方CSS类 | belowclass | 无描述 | 未知 | 可选 |
| 标题CSS类 | titleclass | 无描述 | 未知 | 可选 |
| 图片CSS类 | imageclass | 无描述 | 未知 | 可选 |
| 导航框CSS类 | navboxclass | 无描述 | 未知 | 可选 |
| 自定义样式页 | templatestyles | 无描述 | 未知 | 可选 |
| 子导航框样式页 | child templatestyles | 无描述 | 未知 | 可选 |
| 禁用分类 | nocat | 设为 true 禁用追踪分类 | 未知 | 可选 |
| 追踪控制 | tracking | 设为 no 禁用水平列表追踪 | 未知 | 可选 |
追蹤分類
- Category:孤立的子导航框(0)
- Category:没有使用水平列表的导航框(0)
- Category:使用背景颜色的导航框(0)
- Category:使用边框的导航框(0)
- Category:name參數和實際不同的導航框(0)
- Category:使用了 columns 但缺少第一列的导航框(0)
参见
- {{Navbox with collapsible groups}} – 可折叠分组导航框
- {{Navbox with columns}} – 多列导航框
- {{Navbox subgroup}} – 子导航框
- {{Navboxes}} – 将多个导航框收纳在一起
- {{Navboxes top}}