模板:Navbox/doc

来自Arcaea中文维基

本模板允许通过提供一个或多个链接列表相对快速地建立一个索引模板。

使用

请移除置空不用的参数。 

{{Navbox
| state      = autocollapse <!--autocollapse、uncollapsed、collapsed、plain、off-->
| name       = {{subst:PAGENAME}}
| 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      = 
}}

参数列表

{{{title}}}
{{{above}}}
{{{group1}}}
{{{list1}}}
{{{image}}}
{{{group2}}}
{{{list2}}}
{{{list3}}}
{{{group4}}}
{{{list4}}}
{{{below}}}
参见下方的其他替代导航格式：表格布局

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

请注意“group”与“list”系列变量是可选的，above/below等也是可选的。

基本参数如下所示（参见下方查看完整的列表）：

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

更多细节与约束参见下方参数描述章节。
其他的一些替代导航格式：表格布局。

参数描述

下面是用于Navbox的参数的一个完整清单。在大多数情况下，只要有参数name、title和list1就可以了（然而子导航框甚至不需要设置那些参数）。

设置参数

name†
模板的名称。你可以输入{{subst:PAGENAME}}作为这个参数的值，这也是个快捷的方法。此参数是必需的。
state† [autocollapse、uncollapsed、collapsed、plain、off]
  • 缺省为autocollapse。如果在使用了其他可折迭表格的同一个页面上有两个或更多表格，那么该页面上的带autocollapse的导航框一开始就会折迭起来。否则，该导航框会被展开。技术上如何实现参见MediaWiki:Common.js。
  • 如果设置为collapsed，该导航框总会在开始时以折迭起来的状态展现。
  • 如果设置为plain，该导航框总会在被展开时不带右侧的“隐藏”链接，并且标题会保持居中。
  • 如果设置为off，该导航框总会在被展开时不带右侧的“隐藏”链接，但是没有补白会被用来保持标题居中。这只是为了高级用法；“plain”选项应能满足大多数需要将“显示”/“隐藏”按钮隐藏起来的应用。
  • 如果设置为除autocollapse、collapsed、plain或off之外的其他值（像“uncollapsed”），该导航框总会在开始时以展开的状态出现，但是带有“隐藏”按钮。
若要在独处（未被包含）时显示框体，而在一个条目中时自动隐藏内容，可以将“uncollapsed”置于<noinclude>标签之内：
  • state = <noinclude>uncollapsed</noinclude>
  • 如此设置会强制框体在单独出现时（甚至是后面有其他导航框时）展开，显示“隐藏”按钮，而当被堆迭在一个条目中时自动折迭框体。
很多时候，对于一个导航框，编辑者会想要一个缺省的初始状态，并且在条目中它可以被覆写。要做到这一点，这里有个窍门：
在你的居间模板里，创建一个参数也命名为“state”作为一个传递。
navbar†
缺省为Navbar。如果设置为plain，补白会被自动应用以保持标题居中。设置为off不会应用补白（这只是为了高级用法；“plain”选项应能满足大多数不想要导航栏的应用。）强烈建议使用者不要隐藏导航栏，为的是使用户编辑该模板更加容易，并且可以贯穿各个页面都有一个标淮的风格。

单元格

title†
显示在表格顶端一行居中位置的文字。它通常是该模板的主题，也就是主体内容的一个简要描述。这应该是单独的一行，但是如果需要第二行，请使用<div></div>来保证正确的居中。本参数从技术上来说不是必需的，但是使用Navbox而不带标题是相当没有意义的。
groupn†
（即group1、group2等等）如果非空，文字会显示在位于listn左侧的抬头单元格中。如果被省略，listn会占用表格的总宽。
listn†
（即list1、list2等等）该模板的主体，通常为内链；然而，如果整个列表被装入<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样式。若指定了下面的oddstyle和evenstyle参数，则它们的优先级高于本参数。
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;

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

表格布局

由不带image、above和below参数的{{Navbox}}生成的表格（列表背景色设置为灰色仅仅是为了演示）：

{{{title}}}
{{{group1}}}
{{{list1}}}
{{{group2}}}
{{{list2}}}
{{{list3}}} 不带 {{{group3}}}
{{{group4}}}
{{{list4}}}

由带有image、above和below参数的{{Navbox}}生成的表格（列表背景色设置为灰色仅仅是为了演示）：

{{{title}}}
{{{above}}}
{{{group1}}}
{{{list1}}}
{{{image}}}
{{{group2}}}
{{{list2}}}
{{{list3}}} 不带 {{{group3}}}
{{{group4}}}
{{{list4}}}
{{{below}}}


由带有image、imageleft、lists，且不带groups、above、below的{{Navbox}}生成的表格（列表背景色设置为灰色仅仅是为了演示）：

{{{title}}}
{{{imageleft}}}
{{{list1}}}
{{{image}}}
{{{list2}}}
{{{list3}}}
{{{list4}}}

技术细节

运作详情

  • 列表单元格宽度初始被设置为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;
取自“https://arcwiki.mcd.blue/index.php?title=Template:Navbox/doc&oldid=25557”