Template:Navbox/doc:修订间差异

删除2,231字节 、​ 2021年3月13日 (星期六)
→‎运作详情:​给说明文档添加分类
(创建页面,内容为“{{本地化未完成}} 本模板允许通过提供一个或多个链接列表相对快速地建立一个导航模板。 ==用法== 请移…”)
 
→‎运作详情:​给说明文档添加分类
标签AWB
 
(未显示2个用户的3个中间版本)
第1行: 第1行:
{{本地化未完成}}
{{本地化未完成}}
 本模板允许通过提供一个或多个链接列表相对快速地建立一个[[:分类: 导航 模板| 导航 模板]]。
 本模板允许通过提供一个或多个链接列表相对快速地建立一个[[:分类: 索引 模板| 索引 模板]]。


==用 ==
== 使 用==
 请移除置空不用的参数。
 请移除置空不用的参数。


第70行: 第70行:
|group2 = {{{group2}}}
|group2 = {{{group2}}}
|list2 = {{{list2}}}
|list2 = {{{list2}}}
|list3 = {{{list3}}}''不带{{{group3}}}''
|list3 = {{{list3}}}
|group4 = {{{group4}}}
|group4 = {{{group4}}}
|list4 = {{{list4}}}
|list4 = {{{list4}}}
第77行: 第77行:
Navbox使用小写的参数名称,如上面框中所示。如果省略其他参数,必需的''name''和''title''会创建一个单行方框。
Navbox使用小写的参数名称,如上面框中所示。如果省略其他参数,必需的''name''和''title''会创建一个单行方框。


 请注意 “group1 (等等) 是可选的 ,命名为“above/below ”的部分 也是可选的。
 请注意 “group 与“list”系列变量 是可选的 ,above/below 也是可选的。
 
基本的和最常见的参数如下所示(参见下方查看完整的列表):
<!--
The navbox uses lowercase parameter names, as shown in the box (''at right'').  The mandatory ''name'' and ''title'' will create a one-line box if other parameters are omitted.
<br/>
 
Notice "group1" (etc.) is optional, as are sections named "above/below".
{{brClear}}
The basic and most common parameters are as follows (see below for the full list):
-->
:<code>name</code> - 模板的名称(“Template:”后面的部分,注意不是模板的标题)。<!--  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>name</code> - 模板的名称(“模板:”后面的部分,注意不是模板的标题)。
:<code>title</code> - 标题栏内的文本,例如<nowiki>[[Arcaea]]</nowiki>。
:<code>state - autocollapse、uncollapsed、collapsed</code>:方框的折迭状态,其中“autocollapse”会自动隐藏被堆迭的多个导航框。
:<code>titlestyle</code> - 一个用于标题栏的CSS样式,例如:<code>background:gray;</code>
:<code>groupstyle</code> - 一个用于分组单元格的CSS样式,例如:<code>background:#eee;</code>
:<code>image</code> - 一个可选的右侧图片(以完整的image标签的形式编码:<nowiki>[[File:Pack arcaea.jpg|90px]]</nowiki>)。
:<code>imageleft</code> - 一个可选的左侧图片(格式与“image”参数相同)。
:<code>above</code> - 在group/list区段之上显示的文字(可能是一栏综合的维基链接)。<!-- text to appear above the group/lst section (could be a list of overall wikilinks). -->
:<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 从方框的左侧开始)。
:<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> - 列出 链的文字,通常以圆点符号模板分隔开来, 例如 :<code><nowiki>[[Antagonism]]{{·}} [[Dantalion]]</nowiki></code>
:<code>list<sub>n</sub></code> - 列出 维基 的文字,通常以圆点符号模板分隔开来, :<!-- text listing wikilinks, often separated by middot templates, such as:  -->[<nowiki/>[A]]<code>{<nowiki/>{·}}</code> [<nowiki/>[B]]
:<code>below</code> - 在group/list区段之下显示的可选文字。
:<code>below</code> - 在group/list区段之下显示的可选文字。<!-- optional text to appear below the group/list section. -->
  更多 细节 约束 参见 下方[[#参数描述|参数描述]]章节。<br> 其他的一些替代导航格式:[[#表格布局|''表格布局'']]。<!--See some alternate navbox formats under: [[#Layout of table|''Layout of table'']]. -->
 
  进一步的 细节 ,以及复杂的 约束 ,在 下方[[#参数描述|参数描述]]章节 作了解释 参见 其他的一些替代导航格式:[[#表格布局|''表格布局'']]。<!-- 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'']]. -->


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


=== 设置参数 ===
=== 设置参数 ===
:; ''name''<sup>†</sup>
:; ''name''<sup>†</sup>
::模板的名称 。为了在所有使用了所生成模板的页面上,“检 · 论 · 编”链接都能正确地工作,就需要设置这个参数 。你可以输入<code><nowiki>{{subst:PAGENAME}}</nowiki></code>作为这个参数的值,这也是个快捷的方法。此参数是必需的。<!-- 仅当<code>title</code>被指定,且<code>border</code>参数未被设置时,此name参数才是必需的。 -->
::模板的名称。你可以输入<code><nowiki>{{subst:PAGENAME}}</nowiki></code>作为这个参数的值,这也是个快捷的方法。此参数是必需的。<!-- 仅当<code>title</code>被指定,且<code>border</code>参数未被设置时,此name参数才是必需的。 -->
:; ''state''<sup>†</sup> <span style="font-weight:normal;">[<code>autocollapse、uncollapsed、collapsed、plain、off</code>]</span>
:; ''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>autocollapse</code>。如果在使用了其他可折迭表格的同一个页面上有两个或更多表格,那么该页面上的带<code>autocollapse</code>的导航框一开始就会折迭起来。否则,该导航框会被展开。技术上 如何 实现参见[[MediaWiki:Common.js]]。
:*如果设置为<code>collapsed</code>,该导航框总会在开始时以折迭起来的状态展现。
:*如果设置为<code>collapsed</code>,该导航框总会在开始时以折迭起来的状态展现。
:*如果设置为<code>plain</code>,该导航框总会在被展开时不带右侧的“隐藏”链接,并且标题会保持居中 (通过使用补白来偏移<small>查 • 论 • 编 • 历</small>链接)
:*如果设置为<code>plain</code>,该导航框总会在被展开时不带右侧的“隐藏”链接,并且标题会保持居中。
:*如果设置为<code>off</code>,该导航框总会在被展开时不带右侧的“隐藏”链接,但是没有补白会被用来保持标题居中。这只是为了高级用法;“plain”选项应能满足大多数需要将“显示”/“隐藏”按钮隐藏起来的应用。
:*如果设置为<code>off</code>,该导航框总会在被展开时不带右侧的“隐藏”链接,但是没有补白会被用来保持标题居中。这只是为了高级用法;“plain”选项应能满足大多数需要将“显示”/“隐藏”按钮隐藏起来的应用。
:*如果设置为除<code>autocollapse</code>、<code>collapsed</code>、<code>plain</code>或<code>off</code>之外的其他值(像“uncollapsed”),该导航框总会在开始时以展开的状态出现,但是带有“隐藏”按钮。
:*如果设置为除<code>autocollapse</code>、<code>collapsed</code>、<code>plain</code>或<code>off</code>之外的其他值(像“uncollapsed”),该导航框总会在开始时以展开的状态出现,但是带有“隐藏”按钮。
第124行: 第111行:
:在你的居间模板里,创建一个参数也命名为“state”作为一个传递。
:在你的居间模板里,创建一个参数也命名为“state”作为一个传递。
:; ''navbar''<sup>†</sup>
:; ''navbar''<sup>†</sup>
::缺省为<code>Navbar</code>。如果设置为<code>plain</code>, 在标题栏左侧的<small>查 • 论 • 编</small>链接不会显示出来,而且 补白会被自动应用以保持标题居中。设置为<code>off</code> 可以移除<small>查 • 论 • 编</small>链接,但是 不会应用补白(这只是为了高级用法;“plain”选项应能满足大多数不想要导航栏的应用。)强烈建议使用者不要隐藏导航栏,为的是使用户编辑该模板更加容易,并且可以贯穿各个页面都有一个标淮的风格。
::缺省为<code>Navbar</code>。如果设置为<code>plain</code>,补白会被自动应用以保持标题居中。设置为<code>off</code>不会应用补白(这只是为了高级用法;“plain”选项应能满足大多数不想要导航栏的应用。)强烈建议使用者不要隐藏导航栏,为的是使用户编辑该模板更加容易,并且可以贯穿各个页面都有一个标淮的风格。
<!--
<!--
 中文模板目前不支持此参数。2008-10-23
 中文模板目前不支持此参数。2008-10-23
第138行: 第125行:
=== 单元格 ===
=== 单元格 ===
:; ''title''<sup>†</sup>
:; ''title''<sup>†</sup>
::显示在表格顶端一行居中位置的文字。它通常是该模板的主题,也就是主体内容的一个简要描述。这应该是单独的一行,但是如果需要第二行,请使用<code><nowiki>{{brClear}}</nowiki></code>来保证正确的居中。本参数从技术上来说不是必需的,但是使用Navbox而不带标题是相当没有意义的。
::显示在表格顶端一行居中位置的文字。它通常是该模板的主题,也就是主体内容的一个简要描述。这应该是单独的一行,但是如果需要第二行,请使用<code><nowiki><div></div></nowiki></code>来保证正确的居中。本参数从技术上来说不是必需的,但是使用Navbox而不带标题是相当没有意义的。
:; ''group<sub>n</sub>''<sup>†</sup>
:; ''group<sub>n</sub>''<sup>†</sup>
::(即''group1''、''group2''等等)如果 被指定 ,文字会显示在位于''list<sub>n</sub>''左侧的抬头单元格中。如果被省略,''list<sub>n</sub>''占用表格的 全部
::(即''group1''、''group2''等等)如果 非空 ,文字会显示在位于''list<sub>n</sub>''左侧的抬头单元格中。如果被省略,''list<sub>n</sub>'' 占用表格的 宽。
:; ''list<sub>n</sub>''<sup>†</sup>
:; ''list<sub>n</sub>''<sup>†</sup>
::(即''list1''、''list2''等等)该模板的主体,通常为 一栏 接。格式为内联 ;然而,如果整个列表被装入<code><nowiki><div> </div></nowiki></code>之内,文字能够被输入到不同的行中。最少需要一个''list''参数;每个附加的''list''被显示在一个单独的表格行中。每个''list<sub>n</sub>''可能在其前面有一个相对应的''group<sub>n</sub>''参数,如果提供了的话(参见下方)。
::(即''list1''、''list2''等等)该模板的主体,通常为 链;然而,如果整个列表被装入<code><nowiki><div> </div></nowiki></code>之内,文字能够被输入到不同的行中。最少需要一个''list''参数;每个附加的''list''被显示在一个单独的表格行中。每个''list<sub>n</sub>''可能在其前面有一个相对应的''group<sub>n</sub>''参数,如果提供了的话(参见下方)。
:; ''image''<sup>†</sup>
:; ''image''<sup>†</sup>
::一张图片,会显示在标题(title)之下、主体(group/list) 右侧的一个单元格中。为使图片能正确地显示,必须指定''list1''参数。''image''参数接受标淮的维基代码来显示图片,即:
::一张图片,会显示在标题(title)之下、主体(group/list)右侧的一个单元格中。为使图片能正确地显示,必须指定''list1''参数。''image''参数接受标淮的维基代码来显示图片,即:
::: <code><nowiki>image = [[File:Example.jpg|100px]]</nowiki></code>
::: <code><nowiki>image = [[File:Example.jpg|100px]]</nowiki></code>
:; ''imageleft''<sup>†</sup>
:; ''imageleft''<sup>†</sup>
第152行: 第139行:
::一个全宽度单元格,显示在标题栏与第一个group/list之间,也就是位于该模板的主体(group、list和image)之上。在一个不带图片的模板中,''above''与不带''group1''参数的''list1''参数以同样的方式运作。
::一个全宽度单元格,显示在标题栏与第一个group/list之间,也就是位于该模板的主体(group、list和image)之上。在一个不带图片的模板中,''above''与不带''group1''参数的''list1''参数以同样的方式运作。
:; ''below''<sup>†</sup>
:; ''below''<sup>†</sup>
::一个全宽度单元格,显示在该模板主体(group、list和image)的下方。在一个不带图片的模板中,''below''与该模板最后面的不带''group<sub>n</sub>''参数的''list<sub>n</sub>''参数以同样的方式运作 。作为一个使用了''below''参数的示例,请参见{{tl|非洲}}
::一个全宽度单元格,显示在该模板主体(group、list和image)的下方。在一个不带图片的模板中,''below''与该模板最后面的不带''group<sub>n</sub>''参数的''list<sub>n</sub>''参数以同样的方式运作。


=== 样式参数 ===
=== 样式参数 ===
第227行: 第214行:
:; ''innerstyle''
:; ''innerstyle''
-->
-->
== 表格 布局 ==
== 表格布局 ==
 由{{tl|Navbox}}'''不带'''''image''、''above''和''below''参数生成的表格( 添加了灰色的 列表背景色仅仅是为了演示):
 由'''不带'''''image''、''above''和''below''参数 的{{tl|Navbox}} 生成的表格(列表背景 色设置为灰 色仅仅是为了演示):
<!--
Table generated by {{tl|Navbox}} '''without''' ''image'', ''above'' and ''below'' parameters (gray list background color added for illustration only):
-->
{{Navbox
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
第245行: 第229行:
|list4 = {{{list4}}}
|list4 = {{{list4}}}
}}
}}
 
 由'''带有'''''image''、''above''和''below''参数 的{{tl|Navbox}} 生成的表格(列表背景 色设置为灰 色仅仅是为了演示):
 
 由{{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
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
第269行: 第248行:




 由{{tl|Navbox}}'''带有'''''image''、''imageleft''、''lists'',且'''不带'''''groups''、''above''、''below''生成的表格( 添加了灰色的 列表背景色仅仅是为了演示):
 由'''带有'''''image''、''imageleft''、''lists'',且'''不带'''''groups''、''above''、''below'' 的{{tl|Navbox}} 生成的表格(列表背景 色设置为灰 色仅仅是为了演示):
<!--
Table generated by {{tl|Navbox}} '''with''' ''image'', ''imageleft'', ''lists'', and '''without''' ''groups'', ''above'', ''below'' (gray list background color added for illustration only):
-->
{{Navbox
{{Navbox
|name = Navbox/doc
|name = Navbox/doc
第285行: 第261行:
|list4 = {{{list4}}}
|list4 = {{{list4}}}
}}
}}


== 技术细节 ==
== 技术细节 ==
第306行: 第281行:
*相邻的导航框在它们之间仅有一个1px的边框(除了在IE6中,因其不支持必需的CSS)。如果你设置了<code>style/bodystyle</code>的顶端外边距(top margin)或底顶端外边距(bottom margin),那么此特性就不运作了。
*相邻的导航框在它们之间仅有一个1px的边框(除了在IE6中,因其不支持必需的CSS)。如果你设置了<code>style/bodystyle</code>的顶端外边距(top margin)或底顶端外边距(bottom margin),那么此特性就不运作了。
*外层导航框表格的缺省的左外边距(margin-left)和右外边距(margin-right)被设置为“auto;”。如果你想使用导航框作为一个浮动对象(float),你需要手动设置左外边距和右外边距的值,因为自动外边距(auto margins)会阻止浮动(float)选项。例如,添加下列代码来使用导航框作为一个浮动对象:
*外层导航框表格的缺省的左外边距(margin-left)和右外边距(margin-right)被设置为“auto;”。如果你想使用导航框作为一个浮动对象(float),你需要手动设置左外边距和右外边距的值,因为自动外边距(auto margins)会阻止浮动(float)选项。例如,添加下列代码来使用导航框作为一个浮动对象:
::<code>style = width:22em;float:right;margin-left:1em;margin-right:0em;</code>
::<code>style = width:22em;float:right;margin-left:1em;margin-right:0em;</code><noinclude>
[[分类:模板说明]]
</noinclude>
3,443

个编辑