Template:Ambox/doc

来自Rotaeno中文维基

本模板是条目信息框的元模板。用于创造文章信息框模板。此外本模板具有自由选择不同颜色、显示特定预设图片等功能。

请注意:这个模板只用于在条目名字空间使用的模板,其他名字空间使用的模板请不要使用。模板:Ombox适用于其他名字空间。

常用参数

右侧的方框内为本模板最常用的参数。每种参数的说明如下:

常用参数
{{Ambox
| name  = 
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type  = 
| image = 
| sect  = {{{1|}}}
| issue = 
| talk  = {{{talk|}}}
| fix   = 
| date  = {{{date|}}}
| time  = {{{time|}}}
| cat   = 
| all   = 
}}

name

name参数指定模板的名字,不需要加上模板名字空间前缀。

本参数应该模板被移动时更新。本参数的指定有两个目的:

如果模板被错误的替换引用(substituded),这个参数能让元模板显示一段警告文字,将可帮助编辑者修复问题。

能让模板在模板页中更有效地展示,例如在没有填入日期的情况下自动显示日期,并能让模板准确分类。

subst

subst参数让元模板能检测此模板是否被错误替代引用的,并显示一段警告文字。完全复制上述方框中的代码即可。一般情况下,请勿更改本参数内容,直接复制上方的模板代码即可。

small

small参数可让编辑者在条目中使用模板时输入 |small=left 来产生一个小型的模板。

一般情况下本模板的显示效果如下:

其他参数设置方式:

  • 如果模板“永远”不应以缩小的方式显示,请在模板源代码中使用 |small=no
  • 如果模板应“总是”以缩小的方式显示,请在模板源代码中使用 |small=left
  • 如果模板“默认为缩小显示”,请在模板源代码中使用 |small={{{small|left}}}。可让编辑者在条目中输入 |small=no 参数时无效。

type

type 参数能指定的模板默认的左侧直条颜色和图片。本参数的选择并非依据编辑者对颜色的偏好,而是根据模板内讯息的类型来决定。以下是七种可在“type”参数中填入的值:

如果没有指定 type 参数,默认为 notice。

image

您可以使用 image 参数来指定模板中显示的图片。图片的指定语法与维基百科放置图片的默认语法相同(参见:如何放置图片)。一般来说,图片的宽度约为 40-50px。示例如下:

  • {{POV}} 中参数设置为 |image=[[File:Unbalanced scales.svg|40px|link=|alt=]],其显示效果如下:

请注意:

  • 如果没有指定图片,模板将会配合“type”参数的内容选择适当的图片(参见:#type)
  • 如果参数设置为 |image=none 时将不会显示任何图片,讯息框内将仅显示文字。
  • 如果图片仅为装饰功能,并属于公共领域,可如在参数中加上 "|link= 以产生连往图片描述页的链接,以及 |alt=" 来产生替代文字;以上两种做法可提升页面亲和力。

sect

许多条目讯息模板开头文字为“此条目⋯⋯”,如果此模板用于章节,则应该更适当地使用“此章节⋯⋯”。其他可能性包括“此列表⋯⋯”和“此人物传记⋯⋯”。

为了实现这个功能。请使用 |sect={{{1|}}} 参数。这将使编辑者能在第一个无名的参数中输入“章节'”来改变模板所指的条目部分。

在使用这个功能时,在模板源代码中应移除开头的几个字(例如:本条目),否则会造成重复显示。

issue & fix

issue 参数用于描述条目的问题。请尽量保持文字叙述简洁有力(约在 10-20 个字内),并包含一个链接至有关的方针与指引页面。

fix 参数包含描述如何改进条目的指导文字。文字内容可比 issue 参数中所填入的字数多,在大多数情况下,请保持在两句话内叙述完毕。

当模板以集成状态(例如放置在 {{multiple issues}} 中)或小型状态(使用 |small=left 参数)显示时,只有 issue 参数中的文字会显示。例如在 {{citation style}} 模板中的参数设置为:

  • |issue = 本条目的'''引用需要进行清理。'''
  • | fix = 参考文献应符合正确的[[Wikipedia:列明来源|引用]]、[[Wikipedia:脚注|脚注]]及[[Wikipedia:外部链接|外部链接]]格式。

talk

某些条目讯息框模板包含了一个通往其讨论页的链接,并让编辑者能指定相关议题所在的章节位置。如要达成这项功能,请使用 talk 参数,使用方式为 |talk={{{talk|}}}

这项参数将可被编辑者以下述方式使用:

  • |talk=章节标题 - 链接可通往条目讨论页中的特定章节。例如:|talk=西瓜
  • |talk=完整页面名称 - 链接将通往指定的页面。例如:|talk=Talk:香蕉#西瓜

请注意:

  • 当模板中使用本参数时,模板本身将会显示一个通往讨论页的链接(为了显示支持此功能),但仅有在参数被确实定义时才会在条目中的模板内显示。
  • 如果要让模板永远显示一个通往讨论页的链接,请使用 |talk={{{talk|#}}} 参数。
  • 如果讨论页面不存在,无论参数设置为何,都将不会显示任何链接。

date

date 直接发送至元模板可让编辑者(或机器人)自行输入模板被放置在条目中的日期。日期将会以较小的字体在主要文字后显示。

cat 参数同时获得定义时,将 date 参数发送至元模板可实现将条目自动按月分类的功能。

time

timedate用法差不多,但是time可以配合{{#time:c}},例如:

{{ambox|issue=内容|fix=附加文字|date={{subst:#time:c}}}}会显示为:

{{ambox|issue=内容|fix=附加文字|time={{subst:#time:c}}}}会显示为:

cat

这个参数定义了清理分类的名称。使用 |cat=CATEGORY 参数:

  • 并同时使用 |date=DATE,则条目会被自动分类至 Category:自DATE起CATEGORY 中。
  • 若无指定日期,条目会被自动分类至 Category:CATEGORY 中。

all

all 参数可用来指定所有包含模板之条目的分类。

其他参数

右侧方框内展示了此模版的所有参数。由于几乎不可能同时用到所有参数,因此不建议复制此处的空白模版。

完整的所有参数
{{Ambox
| name        = 
| subst       = <includeonly>{{subst:substcheck}}</includeonly>
| small       = {{{small|}}}
| type        = 
| image       = 
| imageright  = 
| smallimage  = 
| smallimageright = 
| class       = 
| style       = 
| textstyle   = 
| sect        = {{{1|}}}
| issue       = 
| talk        = {{{talk|}}}
| fix         = 
| date        = {{{date|}}}
| time        = {{{time|}}}
| text        = 
| smalltext   = 
| cat         = 
| all         = 
| cat2        = 
| all2        = 
| cat3        = 
| all3        = 
}}<noinclude>
{{Documentation}}
</noinclude>

imageright

在讯息框右侧显示图片。填入方式与 image 参数相同,默认为不显示任何图片。

smallimage & smallimageright

可在此参数指定模板缩小显示后所使用的图片。仅在定义 |small=left 时有效。

class

可自行定义使用在讯息框的CSS类型选择器(Class)。

style & textstyle

可选择定义CSS样式,不需加上引号 " ",但必须在结尾加上分号 ;

  • style 为套用至整个讯息框的样式
  • textstyle 为仅套用在文字上的样式

text & smalltext

除了指定 issuefix 参数外,也可使用 text 参数来定义要显示的文字(不建议使用text,不支持移动版)

smalltext 则用来定义要以较小字体显示的文字

其他分类相关参数

  • cat2cat3 可增加按月分类时所用的分类名称,用法与 #cat 参数相同。
  • all2all3 可增加所有包含模板之条目的分类名称,用法与 #all 参数相同。

技术细节

如果你需要在text参数中使用一些特殊字符的话,那么就需要像这样将它们换码:

{{ambox
| text  = 
等号 = 与前后大括号{ }可以正常地使用。
但是管道符{{!}}与两个连着的后大括号<nowiki>}}</nowiki>则不能直接使用。
一起用同样要带nowiki标记<nowiki>|}}</nowiki>。
}}

此模板使用CSS类来确定显示风格,因此可被更换到其他风格。

在此元模板内使用了HTML的表格标示法,而没有使用维基式的表格标示法。在制作元模板时这是一个常见的方法,因为维基式标示法存在一些缺陷。譬如,维基式标示法会加大模板扩展语法及参数中特殊字符使用的难度。

更多的技术细节参见维基百科页面。