查看“︁模板:Navbox/doc”︁的源代码

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

==用法==
请移除置空不用的参数。
<pre>{{Navbox
|name={{subst:PAGENAME}}
|title=
|image=
|above=

|group1=
|list1=

|group2=
|list2= 

……

|group20= 
|list20= 

|below= 
}}</pre>

==参数列表==
{{Navbox
|name = Navbox/doc
|state = uncollapsed
|image = {{{image}}}
|title = {{{title}}}
|above = {{{above}}}
|group1 = {{{group1}}}
|list1 = {{{list1}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}}''不带{{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
|below = {{{below}}}<br/>参见下方的其他替代导航格式：[[#表格布局|''表格布局'']]<!-- See alternate navbox formats under:[[#Layout of table|''Layout of table'']]  -->
}}
Navbox使用小写的参数名称，如上面框中所示。如果省略其他参数，必需的''name''和''title''会创建一个单行方框。

请注意“group1”（等等）是可选的，命名为“above/below”的部分也是可选的。

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

:<code>name - </code>模板的名称。<!--  the name of the template. -->
:<code>title - </code>标题栏的文字，像<nowiki>[[化学分支]]</nowiki>。<!--  text in the title bar, such as: <nowiki>[[Widget stuff]]</nowiki>. -->
:<code>state - autocollapse、uncollapsed、collapsed</code>：方框的折叠状态，其中“autocollapse”会自动隐藏被堆叠的多个导航框。<!-- : the status of box expansion, where "autocollapse" hides stacked navboxes automatically. -->

:<code>titlestyle - </code>一个用于标题栏的CSS样式，像：<!-- a CSS style for the title-bar, such as:  --><code>background:gray;</code>
:<code>groupstyle - </code>一个用于分组单元格的CSS样式，像：<!-- a CSS style for the group-cells, such as:  --><code>background:#eee;</code>

:<code>image - </code>一个可选的置于右侧的图片（以完整的image标签的形式编码：<nowiki>[[File:XX.jpg|90px]]</nowiki>）。<!-- an optional right-side image (coded as the whole image tag:  ). -->
:<code>imageleft - </code>一个可选的置于左侧的图片（编码方式与“image”参数相同）。<!-- an optional left-side image (code the same was as the "image" parameter). -->

:<code>above - </code>在group/list区段之上显示的文字（可能是一栏综合的维基链接）。<!-- text to appear above the group/lst section (could be a list of overall wikilinks). -->

:<code>group<sub>n</sub> - </code>左侧的文字，在list-n之前（如果group-n被省略，list-n从方框的左侧开始）。<!-- the left-side text before list-n (if group-n omitted, list-n starts at left of box). -->
:<code>list<sub>n</sub> - </code>列出维基链接的文字，通常以圆点符号模板分隔开来，像：<!-- text listing wikilinks, often separated by middot templates, such as:  --><nowiki>[[A]]<code>{{·}}</code> [[B]]</nowiki>
:<code>below - </code>在group/list区段之下显示的可选文字。<!-- optional text to appear below the group/list section. -->

进一步的细节，以及复杂的约束，在下方[[#参数描述|参数描述]]章节作了解释。参见其他的一些替代导航格式：[[#表格布局|''表格布局'']]。<!-- Further details, and complex restrictions, are explained below under section ''[[#Parameter descriptions|Parameter descriptions]]''. See some alternate navbox formats under: [[#Layout of table|''Layout of table'']]. -->

== 参数描述 ==
下面是用于{{t1|Navbox}}的参数的一个完整清单。在大多数情况下，只要有参数<code>name</code>、<code>title</code>和<code>list1</code>就可以了，尽管[[#子导航框|子导航框]]甚至不需要设置那些参数。

{{t1|Navbox}}与它的姊妹模板{{t1|Navbox with columns}}、{{t1|Navbox with collapsible groups}}共-{}-用很多常用的参数名称，以提高一致性与易用性。带一个<sup><span style="font-weight:bold;">†</span></sup>标记的参数适用于所有这三个主模板。
<!-- 
The following is a complete list of parameters for using {{t1|Navbox}}.  In most cases, the only required parameters are <code>name</code>, <code>title</code>, and <code>list1</code>, though [[Template:Navbox/doc#Child_navboxes|child navboxes]] do not even require those to be set.

{{t1|Navbox}} shares numerous common parameter names as its sister templates {{t1|Navbox with columns}} and {{t1|Navbox with collapsible groups}} for consistency and ease of use.  Parameters marked with a cross<sup><span style="font-weight:bold;">†</span></sup> are common to all three master templates.
-->
=== 设置参数 ===
:; ''name''<sup>†</sup>
::模板的名称。为了在所有使用了所生成模板的页面上，“檢{{·}} 论{{·}} 编”链接都能正确地工作，就需要设置这个参数。你可以输入<code><nowiki>{{subst:PAGENAME}}</nowiki></code>作为这个参数的值，这也是个快捷的方法。此参数是必需的。<!-- 仅当<code>title</code>被指定，且<code>border</code>参数未被设置时，此name参数才是必需的。 -->
<!-- 
:: The name of the template, which is needed for the "v{{·}} d{{·}} e" ("view{{·}} discuss{{·}} edit") links to work properly on all pages where the template is used. You can enter <code><nowiki>{{subst:PAGENAME}}</nowiki></code> for this value as a shortcut.  The name parameter is only mandatory if a <code>title</code> is specified, and the <code>border</code> parameter is not set.
-->
:; ''state''<sup>†</sup> <span style="font-weight:normal;">[<code>autocollapse、uncollapsed、collapsed、plain、off</code>]</span>
:*缺省为<code>autocollapse</code>。如果在使用了其他可折叠表格的同一个页面上有两个或更多表格，那么该页面上的带<code>autocollapse</code>的导航框一开始就会折叠起来。否则，该导航框会被展开。要了解技术上的实现，请参见[[MediaWiki:Common.js]]。
:*如果设置为<code>collapsed</code>，该导航框总会在开始时以折叠起来的状态展现。
:*如果设置为<code>plain</code>，该导航框总会在被展开时不带右侧的“隐藏”链接，并且标题会保持居中（通过使用补白来偏移<small>查 • 论 • 编 • 历</small>链接）。（英文模板已实现。）
:*如果设置为<code>off</code>，该导航框总会在被展开时不带右侧的“隐藏”链接，但是没有补白会被用来保持标题居中。这只是为了高级用法；“plain”选项应能满足大多数需要将“显示”/“隐藏”按钮隐藏起来的应用。（英文模板已实现。）
:*如果设置为除<code>autocollapse</code>、<code>collapsed</code>、<code>plain</code>或<code>off</code>之外的其他值（像“uncollapsed”），该导航框总会在开始时以展开的状态出现，但是带有“隐藏”按钮。
<!-- 
:* Defaults to <code>autocollapse</code>. A navbox with <code>autocollapse</code> will start out collapsed if there are two or more tables on the same page that use other collapsible tables. Otherwise, the navbox will be expanded. For the technically minded, see [[MediaWiki:Common.js]].
:* If set to <code>collapsed</code>, the navbox will always start out in a collapsed state.
:* If set to <code>plain</code>, the navbox will always be expanded with no [hide] link on the right, and the title will remain centered (by using padding to offset the <small>v • d • e</small> links).
:* If set to <code>off</code>, the navbox will always be expanded with no [hide] link on the right, but no padding will be used to keep the title centered.  This is for advanced use only; the "plain" option should suffice for most applications where the [show]/[hide] button needs to be hidden.
:*If set to anything other than <code>autocollapse</code>, <code>collapsed</code>, <code>plain</code>, or <code>off</code> (such as "uncollapsed"), the navbox will always start out in an expanded state, but have the "hide" button.
-->
:若要在独处（未被包含）时显示框体，而在一个条目中时自动隐藏内容，可以将“uncollapsed”置于<noinclude>标签之内：
:* <code>state = </code><nowiki><noinclude>uncollapsed</noinclude></nowiki>
:*如此设置会强制框体在独处时（甚至是在跟有其他方框时）可见，显示“隐藏”按钮，而当被堆叠在一个条目中时自动折叠框体。
:很多时候，对于一个导航框，编辑者会想要一个缺省的初始状态，并且在条目中它可以被覆写。要做到这一点，这里有个窍门：
:在你的居间模板里，创建一个参数也命名为“state”作为一个传递，像这样：
:*<tt><nowiki>| state = {{{state<includeonly>|你想要的初始状态</includeonly>}}}</nowiki></tt>
:*The <nowiki><includeonly>|</nowiki>会使得当查看模板页面本身时，模板会被展开。

:; ''navbar''<sup>†</sup>
::缺省为<code>Tnavbar</code>。如果设置为<code>plain</code>，在标题栏左侧的<small>查 • 论 • 编 • 历</small>链接不会显示出来，而且补白会被自动应用以保持标题居中。设置为<code>off</code>可以移除<small>查 • 论 • 编 • 历</small>链接（英文模板已实现），但是不会应用补白（这只是为了高级用法；“plain”选项应能满足大多数不想要导航栏的应用。）强烈建议使用者不要隐藏导航栏，为的是使用户编辑该模板更加容易，并且可以贯穿各个页面都有一个标准的风格。

=== 单元格 ===
:; ''title''<sup>†</sup>
::显示在表格顶端一行居中位置的文字。它通常是该模板的主题，也就是主体内容的一个简要描述。这应该是单独的一行，但是如果需要第二行，请使用<code><nowiki>{{-}}</nowiki></code>来保证正确的居中。本参数从技术上来说不是必需的，但是使用{{t1|Navbox}}而不带标题是相当没有意义的。

:; ''group<sub>n</sub>''<sup>†</sup>
::（即''group1''、''group2''等等）如果被指定，文字会显示在位于''list<sub>n</sub>''左侧的抬头单元格中。如果被省略，''list<sub>n</sub>''占用表格的全部宽度。

:; ''list<sub>n</sub>''<sup>†</sup>
::（即''list1''、''list2''等等）该模板的主体，通常为一栏链接。格式为内联；然而，如果整个列表被装入<code><nowiki><div> </div></nowiki></code>之内，文字能够被输入到不同的行中。最少需要一个''list''参数；每个附加的''list''被显示在一个单独的表格行中。每个''list<sub>n</sub>''可能在其前面有一个相对应的''group<sub>n</sub>''参数，如果提供了的话（参见下方）。

:; ''image''<sup>†</sup>
::一张图片，会显示在标题（title）之下、主体（group/list）之右侧的一个单元格中。为使图片能正确地显示，必须指定''list1''参数。''image''参数接受标准的维基代码来显示图片，即：
::: <code><nowiki>image = [[File:Example.jpg|100px]]</nowiki></code>

:; ''imageleft''<sup>†</sup>
::一张图片，会显示在标题（title）之下、主体（list）之左侧的一个单元格中。为使图片能正确地显示，必须指定''list1''参数，而且不能指定分组（group）。''imageleft''参数接受标准的维基代码来显示图片，即：
::: <code><nowiki>imageleft = [[File:Example.jpg|100px]]</nowiki></code>

:; ''above''<sup>†</sup>
::一个全宽度单元格，显示在标题栏与第一个group/list之间，也就是位于该模板的主体（group、list和image）之上。在一个不带图片的模板中，''above''与不带''group1''参数的''list1''参数以同样的方式运作。

:; ''below''<sup>†</sup>
::一个全宽度单元格，显示在该模板主体（group、list和image）的下方。在一个不带图片的模板中，''below''与该模板最后面的不带''group<sub>n</sub>''参数的''list<sub>n</sub>''参数以同样的方式运作。

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

:; ''style''<sup>†</sup>
::指定应用到模板主体的CSS样式。''bodystyle''参数也有下面举例的同样效果，并能被用来代替这个''style''参数。此选项应谨慎使用，因为它可以导致视觉上的不一致。举例：

::: <code>style = background:#''nnnnnn'';</code>
::: <code>style = width:''N'' [em/%/px or width:auto];</code>
::: <code>style = float:[''left/right/none''];</code>
::: <code>style = clear:[''right/left/both/none''];</code>

:; ''titlestyle''<sup>†</sup>
::应用到''title''的CSS样式，最常见的有导航栏的背景颜色：

::: <code><nowiki>titlestyle = background:</nowiki>''#nnnnnn'';</code>
::: <code><nowiki>titlestyle = background:</nowiki>''name'';</code>

:; ''groupstyle''<sup>†</sup>
::应用到''groupN''单元格的CSS样式。该选项覆写应用于整个表格的任何样式。举例：

::: <code>groupstyle = background:#''nnnnnn'';</code>
::: <code>groupstyle = text-align:[''left/center/right''];</code>
::: <code>groupstyle = vertical-align:[''top/middle/bottom''];</code>

:; ''liststyle''<sup>†</sup>
::应用到所有list的CSS样式。若指定了下面的''oddstyle''和''evenstyle''参数，则它们的优先级高于本参数。

:; ''oddstyle''
:; ''evenstyle''
::应用到奇数/偶数编号的列表。会推翻由''liststyle''定义的样式。缺省的表现是分别添加条纹状的颜色（白色和灰色）到奇数/偶数行，以提高可读性。除了在非常特别的情况下，这些设置不应更改。

:; ''abovestyle''<sup>†</sup>
:; ''belowstyle''<sup>†</sup>
::CSS样式，应用到顶端单元格（通过''above''参数指定）和底端单元格（通过''below''参数指定）。典型地被用来设置背景颜色或文本对齐方式：

::: <code>abovestyle = background:#''nnnnnn'';</code>
::: <code>abovestyle = text-align:[''left/center/right''];</code>

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

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

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

== 表格的布局 ==
由{{tl|Navbox}}'''不带'''''image''、''above''和''below''参数生成的表格（添加了灰色的列表背景色仅仅是为了演示）：
<!-- 
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
-->
{{Navbox
|name = Navbox/doc
|state = uncollapsed
|liststyle = background:silver;
|title = {{{title}}}
|group1 = {{{group1}}}
|list1 = {{{list1}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''不带 {{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
}}


由{{tl|Navbox}}'''带有'''''image''、''above''和''below''参数生成的表格（添加了灰色的列表背景色仅仅是为了演示）：
<!-- 
Table generated by {{tl|Navbox}} '''with''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
-->
{{Navbox
|name = Navbox/doc
|state = uncollapsed
|liststyle = background:silver;
|image = {{{image}}}
|title = {{{title}}}
|above = {{{above}}}
|group1 = {{{group1}}}
|list1 = {{{list1}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}} ''不带 {{{group3}}}''
|group4 = {{{group4}}}
|list4 = {{{list4}}}
|below = {{{below}}}
}}


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

{{Navbox
|name = Navbox/doc
|state = uncollapsed
|liststyle = background:silver;
|image = {{{image}}}
|imageleft = {{{imageleft}}}
|title = {{{title}}}
|list1 = {{{list1}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}}
|list4 = {{{list4}}}
}}

== 示例 ==

== 与其他导航框模板的关系 ==
此导航框模板被特别设计使得能与另外两个姊妹模板协同工作：{{t1|Navbox with columns}}和{{t1|Navbox with collapsible groups}}。所有这三个模板共用常用的参数，以提高一致性与易用性（此类参数在上面的完整参数列表中用一个<sup>'''†'''</sup>作了标记）。最重要的是，所有这三个模板能互相被用作另一个的子框。
<!-- 
This navbox template is specifically designed to work in conjunction two other sister templates: {{t1|Navbox with columns}} and {{t1|Navbox with collapsible groups}}.  All three of these templates share common parameters for consistency and ease of use (such parameters are marked with a <sup>'''†'''</sup> in the complete parameter list above).  Most importantly, all three of these templates can each be used as children of one another (by using the <code>border = child</code> parameter, or by specifying the first unnamed parameter to be <code>child</code> (i.e. use <code><nowiki>{{Navbox|child</nowiki></code>, <code><nowiki>{{Navbox with columns|child</nowiki></code>, or <code><nowiki>{{Navbox with collapsible groups|child</nowiki></code>).  For examples on how this is done, see the page on [[Template:Navbox/doc/Advanced examples|advanced navbox examples]].
-->
== 技术细节 ==
* 此模板为其大部分外观使用CSS类，因此它完全可以更换皮肤。
<!-- * 在内部此元模板使用了HTML标记代替 -->
* 欲了解更多技术细节请参见其[[MediaWiki:common.css]]中的CSS类以及[[MediaWiki:common.js]]中用来隐藏框体的可折叠表格。

=== 运作详情 ===
<!-- 译后试了一下，中文模板无需像英文模板那样额外设置liststyle =。2008-11-04
* 在分组（groups）与列表（lists）之间的2px宽的边框被绘出，是使用列表单元格的左边框（border-left）属性。因此，如果你想改变模板的背景颜色（例如<code>bodystyle = background:purple;</code>），那么你就需要使这个左边框颜色（border-left-color）与该背景色相适配（即<code>liststyle = border-left-color:purple;</code>）。如果你想有一个边框围绕在每一个列表单元格，那么在分组与列表之间的这个2px的边框会消失；你要拿出自己的解决方案。

*The 2px wide border between groups and lists is drawn using the border-left property of the list cell.  Thus, if you wish to change the background color of the template (for example <code>bodystyle = background:purple;</code>), then you'll need to make the border-left-color match the background color (i.e. <code>liststyle = border-left-color:purple;</code>).  If you wish to have a border around each list cell, then the 2px border between the list cells and group cells will disappear; you'll have to come up with your own solution.
-->
* 列表单元格宽度初始被设置为100%。因此，如果你想手动设置分组单元格的宽度，你就需要同时指定liststyle使之有width:auto。如果你想设置分组宽度并使用图片，这取决于你已弄明白在groupstyle、liststyle、imagestyle和imageleftstyle参数中的CSS，以使所有部件都工作正常。以下两行是设置分组宽度的示例：
<!-- 
*The list cell width is initially set to 100%.  Thus, if you wish to manually set the width of group cells, you'll need to also specify the liststyle to have width:auto.  If you wish to set the group width and use images, it's up to you to figure out the CSS in the groupstyle, liststyle, imagestyle, and imageleftstyle parameters to get everything to work correctly.  Example of setting group width:
-->
::<code>groupstyle = width:10em;</code>
::<code>liststyle = width:auto;</code>
*相邻的导航框在它们之间仅有一个1px的边框（除了在IE6中，因其不支持必需的CSS）。如果你设置了<code>style/bodystyle</code>的顶端外边距（top margin）或底顶端外边距（bottom margin），那么此特性就不运作了。
<!-- 
*Adjacent navboxes have only a 1 pixel border between them (except in IE6, which doesn't support the necessary CSS).  If you set the top or bottom margin of <code>style/bodystyle</code>, then this will not work.
-->
*外层导航框表格的缺省的左外边距（margin-left）和右外边距（margin-right）被设置为“auto;”。如果你想使用导航框作为一个浮动对象（float），你需要手动设置左外边距和右外边距的值，因为自动外边距（auto margins)会阻止浮动（float）选项。例如，添加下列代码来使用导航框作为一个浮动对象：
<!-- 
*The default margin-left and margin-right of the outer navbox table are set to "auto;".  If you wish to use navbox as a float, you need to manually set the margin-left and margin-right values, because the auto margins interfere with the float option.  For example, add the following code to use the navbox as a float:
-->
::<code>style = width:22em;float:right;margin-left:1em;margin-right:0em;</code>

== 參見 ==
* {{Wikipedia|lang=zh|name=Template:Navbox|display=Template:Navbox}}

<noinclude>[[Category:模板文档|N]]</noinclude>