模板:Navbox/doc

来自节奏医生中文百科
跳到导航 跳到搜索
这个模板引用自PRTS,并可能进行了修改。感谢所有编辑们做出的贡献。

相对于英文维基百科版本的本地变动(供之后更新的管理员参考):

  • 行数增加至35([1]
  • 由于中文字符较宽,navbar和collapseButton均扩展到8em以避免文字换行([2]及Common.css中的更改)
  • 文字大小被缩放至80%,生成的占位符必须设置同样的文字大小以保证8em的宽度一致([3]
  • collapseButton总有0.5em的margin-left,navbar也有,但不使用navbar时的占位符应该设置同样的margin-right来平衡([4]
  • 翻译分类名([5]

相对于英文维基百科版本的本地变动(供之后更新的管理员参考):

  • 行数增加至35([6]
  • 由于中文字符较宽,navbar和collapseButton均扩展到8em以避免文字换行([7]及Common.css中的更改)
  • 文字大小被缩放至80%,生成的占位符必须设置同样的文字大小以保证8em的宽度一致([8]
  • collapseButton总有0.5em的margin-left,navbar也有,但不使用navbar时的占位符应该设置同样的margin-right来平衡([9]
  • 翻译分类名([10]

本模板允许通过提供一个或多个链接列表相对快速地建立一个RDWIKI导航模板。它配备了缺省样式,这些样式应能对付大多数导航模板。不建议改变缺省样式,尽管这是可以的。为了导航模板的标准化,也为了便于使用,强烈建议使用这个模板,或者它的「Navbox系列」姊妹模板中的某一个。

用法

请移除置空不用的参数。

{{Navbox
| state      = autocollapse <!--autocollapse、uncollapsed、collapsed、plain、off-->
| name       = {{subst:PAGENAME}}
| class      = <!--附加到table的class-->
| title      = 
| image      = 
| above      = 
| abovestyle = 
| listclass  = hlist
| group1     = 
| list1      = 
| group2     = 
| list2      = 
| group3     = 
| list3      = 
| group4     = 
| list4      = 
| group5     = 
| list5      = 
| group6     = 
| list6      = 
| group7     = 
| list7      = 
| group8     = 
| list8      = 
| group9     = 
| list9      = 
| group10    = 
| list10     = 
| group11    = 
| list11     = 
| group12    = 
| list12     = 
| group13    = 
| list13     = 
| group14    = 
| list14     = 
| group15    = 
| list15     = 
| group16    = 
| list16     = 
| group17    = 
| list17     = 
| group18    = 
| list18     = 
| group19    = 
| list19     = 
| group20    = 
| list20     = 
| belowstyle = 
| below      = 
}}

参数列表

Navbox使用小写的参数名称,如上面框中所示。如果省略其他参数,必需的nametitle会创建一个单行方框。

请注意“group1”(等等)是可选的,命名为“above/below”的部分也是可选的。

基本的和最常见的参数如下所示(参见下方查看完整的列表):

name - 模板的名称(“Template:”后面的部分,注意不是模板的标题)。
title - 标题栏的文字,像[[化学分支]]。
state - autocollapse、uncollapsed、collapsed:方框的折叠状态,其中“autocollapse”会自动隐藏被堆叠的多个导航框。
titlestyle - 一个用于标题栏的CSS样式,像:background:gray;
groupstyle - 一个用于分组单元格的CSS样式,像:background:#eee;
image - 一个可选的右侧图片(以完整的image标签的形式编码:[[File:XX.jpg|90px]])。
imageleft - 一个可选的左侧图片(编码方式与“image”参数相同)。
above - 在group/list区段之上显示的文字(可能是一栏综合的维基链接)。
groupn - 左侧的文字,在list-n之前(如果group-n被省略,list-n从方框的左侧开始)。
listn - 列出维基链接的文字,通常以圆点符号模板分隔开来,像:[[A]]{{·}} [[B]]
below - 在group/list区段之下显示的可选文字。

进一步的细节,以及复杂的约束,在下方参数描述章节作了解释。参见其他的一些替代导航格式:表格布局

参数描述

下面是用于Navbox的参数的一个完整清单。在大多数情况下,只要有参数nametitlelist1就可以了,尽管子导航框甚至不需要设置那些参数。

Navbox与它的姊妹模板Navbox with columnsNavbox with collapsible groups共用很多常用的参数名称,以提高一致性与易用性。带一个标记的参数适用于所有这三个主模板。

设置参数

name
模板的名称。为了在所有使用了所生成模板的页面上,“檢 · 论 · 编”链接都能正确地工作,就需要设置这个参数。你可以输入{{subst:PAGENAME}}作为这个参数的值,这也是个快捷的方法。此参数是必需的。
state [autocollapse、uncollapsed、collapsed、plain、off]
  • 缺省为autocollapse。如果在使用了其他可折叠表格的同一个页面上有两个或更多表格,那么该页面上的带autocollapse的导航框一开始就会折叠起来。否则,该导航框会被展开。要了解技术上的实现,请参见MediaWiki:Common.js
  • 如果设置为collapsed,该导航框总会在开始时以折叠起来的状态展现。
  • 如果设置为plain,该导航框总会在被展开时不带右侧的“隐藏”链接,并且标题会保持居中(通过使用补白来偏移查 • 论 • 编 • 历链接)。
  • 如果设置为off,该导航框总会在被展开时不带右侧的“隐藏”链接,但是没有补白会被用来保持标题居中。这只是为了高级用法;“plain”选项应能满足大多数需要将“显示”/“隐藏”按钮隐藏起来的应用。
  • 如果设置为除autocollapsecollapsedplainoff之外的其他值(像“uncollapsed”),该导航框总会在开始时以展开的状态出现,但是带有“隐藏”按钮。
若要在独处(未被包含)时显示框体,而在一个条目中时自动隐藏内容,可以将“uncollapsed”置于<noinclude>标签之内:
  • state = <noinclude>uncollapsed</noinclude>
  • 如此设置会强制框体在单独出现时(甚至是后面有其他导航框时)展开,显示“隐藏”按钮,而当被堆叠在一个条目中时自动折叠框体。
很多时候,对于一个导航框,编辑者会想要一个缺省的初始状态,并且在条目中它可以被覆写。要做到这一点,这里有个窍门:
在你的居间模板里,创建一个参数也命名为“state”作为一个传递,像这样:
  • | state = {{{state<includeonly>|你想要的初始状态</includeonly>}}}
  • <includeonly>|会使得当查看模板页面本身时,模板会被展开。
  • 示例:{{土星的卫星}}带autocollapse作为其缺省的初始状态。条目土卫三十五嵌入包含了它,并且只有一个导航框架。因此该页面的“土星的卫星”导航框显示了出来。条目土卫一有两个导航框。因此该页面的“土星的卫星”导航框折叠了起来。另外,也可以在条目中使用带state参数的引用形式(如{{土星的卫星|state=collapsed}})来覆写其折叠状态。
  • 示例:{{阿拉伯语言}}带expanded作为其缺省的初始状态。所有嵌入包含它的条目缺省情况下会显示其内容,除非有一个假定的条目在嵌入包含它时指定了state = collapsed。
navbar
缺省为Navbar。如果设置为plain,在标题栏左侧的查 • 论 • 编链接不会显示出来,而且补白会被自动应用以保持标题居中。设置为off可以移除查 • 论 • 编链接,但是不会应用补白(这只是为了高级用法;“plain”选项应能满足大多数不想要导航栏的应用。)强烈建议使用者不要隐藏导航栏,为的是使用户编辑该模板更加容易,并且可以贯穿各个页面都有一个标准的风格。

单元格

title
显示在表格顶端一行居中位置的文字。它通常是该模板的主题,也就是主体内容的一个简要描述。这应该是单独的一行,但是如果需要第二行,请使用{{brClear}}来保证正确的居中。本参数从技术上来说不是必需的,但是使用Navbox而不带标题是相当没有意义的。
groupn
(即group1group2等等)如果被指定,文字会显示在位于listn左侧的抬头单元格中。如果被省略,listn占用表格的全部宽度。
listn
(即list1list2等等)该模板的主体,通常为一栏链接。格式为内联;然而,如果整个列表被装入<div> </div>之内,文字能够被输入到不同的行中。最少需要一个list参数;每个附加的list被显示在一个单独的表格行中。每个listn可能在其前面有一个相对应的groupn参数,如果提供了的话(参见下方)。
image
一张图片,会显示在标题(title)之下、主体(group/list)之右侧的一个单元格中。为使图片能正确地显示,必须指定list1参数。image参数接受标准的维基代码来显示图片,即:
image = [[File:Example.jpg|100px]]
imageleft
一张图片,会显示在标题(title)之下、主体(list)之左侧的一个单元格中。为使图片能正确显示,必须指定list1参数,而且不能指定分组(group)。imageleft参数接受标准的维基代码来显示图片,即:
imageleft = [[File:Example.jpg|100px]]
above
一个全宽度单元格,显示在标题栏与第一个group/list之间,也就是位于该模板的主体(group、list和image)之上。在一个不带图片的模板中,above与不带group1参数的list1参数以同样的方式运作。
below
一个全宽度单元格,显示在该模板主体(group、list和image)的下方。在一个不带图片的模板中,below与该模板最后面的不带groupn参数的listn参数以同样的方式运作。

样式参数

一般不建议更改样式,以保持维基百科中模板和网页的一致性。然而,修改样式的选项还是有的。

style
指定应用到模板主体的CSS样式。bodystyle参数也有下面举例的同样效果,并能被用来代替这个style参数。此选项应谨慎使用,因为它可以导致视觉上的不一致。举例:
style = background:#nnnnnn;
style = width:N [em/%/px or width:auto];
style = float:[left/right/none];
style = clear:[right/left/both/none];
titlestyle
应用到title的CSS样式,最常见的有导航栏的背景颜色:
titlestyle = background:#nnnnnn;
titlestyle = background:name;
groupstyle
应用到groupN单元格的CSS样式。该选项覆写应用于整个表格的任何样式。举例:
groupstyle = background:#nnnnnn;
groupstyle = text-align:[left/center/right];
groupstyle = vertical-align:[top/middle/bottom];
liststyle
应用到所有list的CSS样式。若指定了下面的oddstyleevenstyle参数,则它们的优先级高于本参数。
oddstyle
evenstyle
应用到奇数/偶数编号的列表。会推翻由liststyle定义的样式。缺省的表现是分别添加条纹状的颜色(白色和灰色)到奇数/偶数行,以提高可读性。除了在非常特别的情况下,这些设置不应更改。
abovestyle
belowstyle
CSS样式,应用到顶端单元格(通过above参数指定)和底端单元格(通过below参数指定)。典型地被用来设置背景颜色或文本对齐方式:
abovestyle = background:#nnnnnn;
abovestyle = text-align:[left/center/right];
缺省样式

这里列出的样式设置是使用导航框的编辑者最经常更改的那些设置。其他更加复杂的样式设置被排除在这个列表之外,以保持它简单。大多数样式是在MediaWiki:Common.css中设置。

bodystyle = background:#fdfdfd; width:100%; vertical-align:middle;
titlestyle = background:#ccccff; padding-left:1em; padding-right:1em; text-align:center;
abovestyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
belowstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:center;
groupstyle = background:#ddddff; padding-left:1em; padding-right:1em; text-align:right;
liststyle = background:transparent; text-align:left/center;
oddstyle = background:transparent;
evenstyle = background:#f7f7f7;

由于liststyleoddstyle是透明的,奇数列表有bodystyle的颜色,其缺省值是#fdfdfd(白色带有少许灰色)。一个list有text-align:left;设定,如果它有一个group的话;否则,它有text-align:center;设定。由于只有bodystyle有一个垂直对齐(vertical-align)属性,所 有其他样式继承其vertical-align:middle;设定。

表格的布局

Navbox不带imageabovebelow参数生成的表格(添加了灰色的列表背景色仅仅是为了演示):


Navbox带有imageabovebelow参数生成的表格(添加了灰色的列表背景色仅仅是为了演示):


Navbox带有imageimageleftlists,且不带groupsabovebelow生成的表格(添加了灰色的列表背景色仅仅是为了演示):

示例

不带图片

{{Navbox
|listclass=hlist
|name={{PAGENAME}}
|state=uncollapsed
|title=[[火蓝之心]]
|group1=主舞台
|list1=<li>[[OF-ST1 摇滚起来]]</li><li>[[OF-1 火山制造]]</li><li>[[OF-ST2 冲破藩篱]]</li><li>[[OF-2 演出继续]]</li><li>[[OF-3 竞走赛]]</li><li>[[OF-4 他是将军]]</li><li>[[OF-ST3 压力之下]]</li><li>[[OF-5 别阻止我]]</li><li>[[OF-6 杀手女皇]]</li><li>[[OF-ST4 爱某个人]]</li><li>[[OF-7 一锤定音]]</li><li>[[OF-8 汐斯塔狂想曲]]</li><li>[[OF-ST5 此生挚爱]]</li>
|group2=嘉年华
|list2=<li>[[OF-F1 水上滑梯]]</li><li>[[OF-F2 激流勇进]]</li><li>[[OF-F3 旋转木马]]</li><li>[[OF-F4 火山攀岩]]</li>
|group3=额外节目
|list3=<li>[[OF-EX1 预热活动]]</li><li>[[OF-EX2 盛大开幕]]</li><li>[[OF-EX3 采访环节]]</li><li>[[OF-EX4 渐入佳境]]</li><li>[[OF-EX5 高潮迭起]]</li><li>[[OF-EX6 完美落幕]]</li>
}}


带图片,不带分组

{{Navbox
|listclass=hlist
|name={{PAGENAME}}
|state=uncollapsed
|title=[[火蓝之心]]
|image=[[文件:Alive专辑封面.png|140px]]
|list1=<li>[[OF-ST1 摇滚起来]]</li><li>[[OF-1 火山制造]]</li><li>[[OF-ST2 冲破藩篱]]</li><li>[[OF-2 演出继续]]</li><li>[[OF-3 竞走赛]]</li><li>[[OF-4 他是将军]]</li><li>[[OF-ST3 压力之下]]</li><li>[[OF-5 别阻止我]]</li><li>[[OF-6 杀手女皇]]</li><li>[[OF-ST4 爱某个人]]</li><li>[[OF-7 一锤定音]]</li><li>[[OF-8 汐斯塔狂想曲]]</li><li>[[OF-ST5 此生挚爱]]</li><li>[[OF-F1 水上滑梯]]</li><li>[[OF-F2 激流勇进]]</li><li>[[OF-F3 旋转木马]]</li><li>[[OF-F4 火山攀岩]]</li><li>[[OF-EX1 预热活动]]</li><li>[[OF-EX2 盛大开幕]]</li><li>[[OF-EX3 采访环节]]</li><li>[[OF-EX4 渐入佳境]]</li><li>[[OF-EX5 高潮迭起]]</li><li>[[OF-EX6 完美落幕]]</li>
}}


带两张图片,不带分组,多重列表

{{Navbox
|listclass=hlist
|name={{PAGENAME}}
|state=uncollapsed
|title=[[火蓝之心]]
|image=[[文件:Alive专辑封面.png|140px]]
|imageleft=[[文件:DDD专辑封面.png|140px]]
|list1=<li>[[OF-ST1 摇滚起来]]</li><li>[[OF-1 火山制造]]</li><li>[[OF-ST2 冲破藩篱]]</li><li>[[OF-2 演出继续]]</li><li>[[OF-3 竞走赛]]</li><li>[[OF-4 他是将军]]</li><li>[[OF-ST3 压力之下]]</li>
|list2=<li>[[OF-5 别阻止我]]</li><li>[[OF-6 杀手女皇]]</li><li>[[OF-ST4 爱某个人]]</li><li>[[OF-7 一锤定音]]</li><li>[[OF-8 汐斯塔狂想曲]]</li><li>[[OF-ST5 此生挚爱]]</li>
|list3=<li>[[OF-F1 水上滑梯]]</li><li>[[OF-F2 激流勇进]]</li><li>[[OF-F3 旋转木马]]</li><li>[[OF-F4 火山攀岩]]</li>
|list4=<li>[[OF-EX1 预热活动]]</li><li>[[OF-EX2 盛大开幕]]</li><li>[[OF-EX3 采访环节]]</li><li>[[OF-EX4 渐入佳境]]</li><li>[[OF-EX5 高潮迭起]]</li><li>[[OF-EX6 完美落幕]]</li>
}}


带有图片、分组、上方注释、下方注释

{{Navbox
|listclass=hlist
|name={{PAGENAME}}
|state=uncollapsed
|title=[[火蓝之心]]
|image=[[文件:DDD专辑封面.png|140px]]
|above=上方文字放这里
|group1=主舞台
|list1=<li>[[OF-ST1 摇滚起来]]</li><li>[[OF-1 火山制造]]</li><li>[[OF-ST2 冲破藩篱]]</li><li>[[OF-2 演出继续]]</li><li>[[OF-3 竞走赛]]</li><li>[[OF-4 他是将军]]</li><li>[[OF-ST3 压力之下]]</li><li>[[OF-5 别阻止我]]</li><li>[[OF-6 杀手女皇]]</li><li>[[OF-ST4 爱某个人]]</li><li>[[OF-7 一锤定音]]</li><li>[[OF-8 汐斯塔狂想曲]]</li><li>[[OF-ST5 此生挚爱]]</li>
|group2=嘉年华
|list2=<li>[[OF-F1 水上滑梯]]</li><li>[[OF-F2 激流勇进]]</li><li>[[OF-F3 旋转木马]]</li><li>[[OF-F4 火山攀岩]]</li>
|group3=额外节目
|list3=<li>[[OF-EX1 预热活动]]</li><li>[[OF-EX2 盛大开幕]]</li><li>[[OF-EX3 采访环节]]</li><li>[[OF-EX4 渐入佳境]]</li><li>[[OF-EX5 高潮迭起]]</li><li>[[OF-EX6 完美落幕]]</li>
|below=[https://ak.hypergryph.com/news/2019084752.html 官网公告]
}}

子导航框

要在一个边框中放置多个导航框,可以使用border参数,或通过将第一个参数指定为“child”来实现。基本用法如下(为第一个组增加了一个子组):

{{Navbox
| name = {{subst:PAGENAME}}
| title = Title

| group1 = [optional]
| list1  = {{Navbox|child
   ...child navbox parameters...
 }}

...
}}

子分组示例

Navbox subgroups

下面的示例展示了子分组的用法。Navbox subgroups是推荐的用法,但通过在Navbox加入border = child或将第一个参数(无名)设为child也可以达到同样的效果。“evenodd”参数用来调整某些子分组中条纹状颜色带的分布,以确保颜色带的排列正确。如果想去除所有的条纹颜色带,可以在每个Navbox中设置liststyle = background:transparent;

一个导航模板下包含其他导航模板

Navbox with collapsible groups

下面的示例中,常规Navbox被用作容器,其list1、list2和list3参数各包含另外的Navbox(设置了1 = child)。“查·论·编”标题链接各通过navbar = plain或直接不填写“name”参数隐藏。(与常规Navbox不同,子Navbox不要求填写“name”参数。)

与其他导航框模板的关系

此导航框模板被特别设计使得能与另外两个姊妹模板协同工作:Navbox with columnsNavbox with collapsible groups。所有这三个模板共用常用的参数,以提高一致性与易用性(此类参数在上面的完整参数列表中用作了标记)。最重要的是,所有这三个模板能互相被用作另一个的子模板(通过使用border = child参数,或将第一个参数(无名)指定为child。例如,使用{{Navbox|child ...}}{{Navbox with columns|child ...}}{{Navbox with collapsible groups|child ...}})。

技术细节

  • 此模板为其大部分外观使用CSS类,因此它完全可以更换皮肤。
  • 欲了解更多技术细节请参见MediaWiki:common.css中的CSS类以及MediaWiki:common.js中用来隐藏框体的可折叠表格。

运作详情

  • 列表单元格宽度初始被设置为100%。因此,如果你想手动设置分组单元格的宽度,你就需要同时指定liststyle使之有width:auto。如果你想设置分组宽度并使用图片,这取决于你已弄明白在groupstyle、liststyle、imagestyle和imageleftstyle参数中的CSS,以使所有部件都工作正常。以下两行是设置分组宽度的示例:
groupstyle = width:10em;
liststyle = width:auto;
  • 相邻的导航框在它们之间仅有一个1px的边框(除了在IE6中,因其不支持必需的CSS)。如果你设置了style/bodystyle的顶端外边距(top margin)或底顶端外边距(bottom margin),那么此特性就不运作了。
  • 外层导航框表格的缺省的左外边距(margin-left)和右外边距(margin-right)被设置为“auto;”。如果你想使用导航框作为一个浮动对象(float),你需要手动设置左外边距和右外边距的值,因为自动外边距(auto margins)会阻止浮动(float)选项。例如,添加下列代码来使用导航框作为一个浮动对象:
style = width:22em;float:right;margin-left:1em;margin-right:0em;