模板:Ambox/doc

这是 {{Ambox}} ([A]rticle [m]essage [box]) (条目信息框) 元模板.

它被用于构建条目消息框如{{Ambox Notice Updata often}}. 它提供若干种不同的颜色, 当无图像参数给出时使用预设图像, 它还有其他特点.

{{Ambox}}代表条目消息框 (Article message box) , 这是一个元模板。它用于构建条目中的消息框模板。它提供几种不同的颜色、图像和一些其他功能。

使用

基础用法

下面的源代码显示了{{Ambox}}接受的最常见参数。每种方法的目的如下所述。

{{Ambox
  | name  = 
  | subst = <includeonly>{{subst:substcheck}}</includeonly>
  | small = {{{small|}}}
  | type  = 
  | image = 
  | sect  = {{{1|}}}
  | issue = 
  | talk  = {{{talk|}}}
  | fix   = 
  | date  = {{{date|}}}
  | cat   = 
  | 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|}}}
  | text  = 
  | smalltext = 
  | plainlinks = no
  | removalnotice =
  | cat  = 
  | all  = 
  | cat2 = 
  | all2 = 
  | cat3 = 
  | all3 = 

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

参数

常用参数

name

name 参数指定模板的名字, 不需要加上模板命名空间前缀。例如{{Underlinked}}中填入的参数为 |name=Underlinked。

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

• 如果模板被错误的替换引用, 这个参数能让元模板显示一段警告文字, 将可帮助编辑者修复问题。
• 能让模板在模板页中更有效地展示, 例如在没有填入日期的情况下自动显示日期, 并能让模板准确分类自己。

subst

subst 参数让元模板能检测此模板是否被错误替代引用的, 并显示一段警告文字。同时也会将页面加入Category:错误使用替换引用的页面分类。完全复制上述方框中的代码即可。直接复制上方的模板代码即可。

small

small 参数应通过模板传递, 它可以允许编辑者通过在条目中设置 |small=left 来产生小型消息框:

否则将生成标准格式:

其他变种:

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

参见下面的模板:Section link一节以获得将小型模板 (|small=left) 限定于章节而不是整个条目的更多信息 (推荐这样做以放置条目顶部的显示不一致) 。

type

type 参数定义模板左侧直条的颜色以及默认情况下使用的图像。类型的选择并非基于美观, 而是根据模板内消息的类型来决定。下面展示了其中可用类型和默认图像。

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

image

您可以使用 image 参数来指定模板中显示的图像。图像使用标准wikitext文件语法。图片的宽度约为40-50px。 提示:

• 如果没有指定图像, 模板将会配合 type 参数的内容选择适当的图片。（参见上面的#type）
• 参数设置为 |image=none 时将不会显示任何图片, 消息框内将仅显示文字。
• 如果图像是纯装饰性的, 并属于公共领域, 可以在图像中加上“link=image=”来阻止图像产生链接到文件页面的链接, 从而提升可访问性。

sect

许多条目消息模板开头文字为“此条目...”, 如果此模板用于章节, 则应该更适当地使用“此章节...” 。本参数的值会替换“条目”。一些其他可能的值包括: |sect=列表, |sect=表格, |sect=“流行文化”材料 等。

如果要使用此功能, 请确保已经移除模板文本 (|text=) 中的头两个此 (“此条目”) , 否则它们将会冲突。

促进此功能的常用方法是传递 |sect={{{1|}}}。这会允许编辑者输入章节, 例如, 通过使用第一个未命名参数来改变词语。

另一种方法是传递 |sect={{{section|{{{sect|}}}}}} 以提供一个命名参数。还可以使用 {{Yesno}} 来检测值是不是肯定形式的, 如果是, 那就传递 |sect=section。

这些参数可以且推荐组合使用, 下面的是一份已经准备好使用的代码:

{{#ifeq:{{yesno|def=|1={{{sect|{{{section}}}}}} }}|yes|章节|{{{sect|{{{section|{{{1|}}}}}}}}}}}

将会带来以下功能:

• 与命名参数一起使用的任何 {{Yesno}} 模板的肯定值都可以在基于ambox的模板中生成“章节”而不是“条目”: |section=y, |sect=True 等。推荐允许使用 |sect= 和 |section=, 这样编辑者就不用猜测哪个参数可用。上面的简单代码为你做了这个功能。
• 以所有方式传递的其他的值都会替换“条目”: |章节和它的子章节, |1=列表, |sect=章节, |section=表格 等。

也建议限制 |small= 参数的使用, 使其取决于模板是否应用于某一节 (或任何内容) , 而不是整个条目。这样做是为了防止在条目顶部使用模板的小型版本, 因为它和其他条目范围的清理、争议横幅不一致:

{{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}}}}

在上面的示例中, 只要模板中提供了 |sect= 或它的别名之一, |small= 或 |left= 的任何值都会触发小型、左侧显示功能。这点代码可以复制粘贴并与上述代码块一起使用。

issue和fix

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

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

当模板以紧凑 (放在 {{Multiple_issues}} 内) 或小型状态 (使用 |small=left 参数) 显示时, 只有 issue 参数中的文字会显示。

talk

某些条目消息框模板包含了一个通往其讨论页的链接, 并让编辑者能指定相关议题所在的章节位置。要实现这项功能, 简单地传递 talk 参数就可以了, 即: |talk={{{talk|}}}

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

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

提示:

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

date

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

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

info

此参数用于指定附加信息。在这里添加的任何内容都会在 data 参数之后出现。如果模板被放置在 {{Multiple_issues}} 中, 它不会显示。

removalnotice

如果指定了 |removalnotice=yes, 则以下提醒将会被显示在日期和 info 文本之后:

• 了解何时以及如何移除此模板消息

如果模板被放置在 {{Multiple_issues}} 中, 它不会显示。

cat

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

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

cat 参数不应该被链接, 也不可加上 Category: 前缀。

all

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

all 参数不应该被链接, 也不可加上 Category: 前缀。

其他参数

imageright

可以通过指定此参数来设置一张在消息框右侧显示的图像, 语法与 image 参数相同, 默认不会显示图像。

smallimage和smallimageright

可以通过指定此参数来设置在小型消息框中显示的特定图像, 除非指定了 |small=right, 否则此参数都不会生效。

class

应用于模板的自定义CSS类。如果要添加多个CSS类, 它们应该以空格分隔。例如: |class=template-delete mobile-issue-severity-high

style和textstyle

可选的CSS值, 不带引号 ("...") , 带末尾的冒号 (;) 。

• style 指定消息框整体的CSS样式。可用于定义消息框的宽度、背景色等等。
• textstyle 指定信息框文本单元格的CSS样式。

text和smalltext

可以使用 text 参数替代 issue 和 fix

小型格式的文本可以用 smalltext 指定。

plainlinks

正常情况下, wiki中的外部链接后面会有个箭头图标, 像这样: Example.com。但消息框内的箭头图标默认不会显示, 像这样: Example.com。要获得正常风格的, 带箭头图标的外链, 使用 |plainlinks=no。

cat2, cat3, all2和all3

• cat2 和 cat3 提供附加的每月分类, 见#cat。
• cat2 和 cat3 提供附加的通用分类, 所有使用消息框的页面都会被分类进去, 就像#all。

技术细节

CSS样式

本模板的CSS样式分别定义在:

• Module:Message_box/core.css — 所有消息框通用的核心样式
• Module:Message_box/ambox.css — 条目消息框的主样式
• Module:Message_box/small.css — 小型消息框的样式

特殊字符转义

如果需要在 text 参数中使用特殊字符, 则需要像这样对它们进行转义:

{{Ambox
  | text  = <div>
等号 (=) 和开始和结束大括号 ({ }) 会正常显示。
但是需要这样表示管道符 {{!}} 和两个连续结束大括号<nowiki>}}</nowiki>. 
这样表示连续管道符和结束大括号: <nowiki>|}}</nowiki>.
</div>
}}

通常不需要上面示例中围绕文本的<div>标记。但是, 如果文本包含换行符, 那么有时我们会得到奇怪的行距。使用垂直虚线列表时, 尤其会发生这种情况。发生时使用div标签修复该问题。

与英文维基百科上模板的不同之处

本模板与英文维基百科上的原模板相比, 布局实现上有很大的不同。英文维基百科的原模板采用HTML表格来布局, 而本模板采用的是CSS弹性盒子布局。这可能会导致一些差异。

其他

此模板调用Module:Message_box, 其中包含{{Ambox}}的大部分代码, 而{{Ambox}}本身进行参数预处理。

有关更多技术细节, 请参见原讨论页面和下面的“另见”章节。由于此模板的工作原理几乎与{{Cmbox}}, {{Imbox}}, {{Fmbox}}, {{Tmbox}}和{{Ombox}}相同, 因此它们的讨论页和相关页面也可能包含更多详细信息。

模板数据

这是用于新版可视化编辑器及其他工具的模板数据文档。

Ambox模板数据

Ambox (条目消息框) 元模板, 用于构建条目消息框。

模板参数

此模板有自定义格式。

参数		描述	类型	状态
名称	name	消息框的名称	字符串	推荐
subst	subst	检测模板是否被错误替代引用 默认值 <includeonly>{{subst:substcheck}}</includeonly>	wikitext片段	推荐
小型的	small	设置为 left 可以生成一个小型消息框 默认值 {{{small|}}}	字符串	可选
类型	type	指定消息框类型 默认值 notice	字符串	推荐
图像	image	可以设置消息框左侧的图像	wikitext片段	可选
右侧图像	imageright	可以设置消息框右侧的图像	wikitext片段	可选
小型消息框图像	smallimage	可以设置小型消息框左侧的图像	wikitext片段	可选
小型消息框右侧图像	smallimageright	可以设置小型消息框右侧的图像	wikitext片段	可选
CSS 类	class	可以设置消息框的 CSS 类	字符串	可选
CSS 样式	style	可以设置消息框的 CSS 样式	字符串	可选
文本 CSS 样式	textstyle	可以设置消息框内文本的 CSS 样式	字符串	可选
sect	sect	可以设置消息框前部的...?	字符串	可选
描述	issue	用于描述条目的问题, 请尽量简洁	内容	推荐
详细描述	fix	用于详细描述条目的问题	内容	可选
讨论	talk	设置是否包含一个通往讨论页的链接	字符串	可选
日期	date	可以生成一个加入信息框时的时间的字串符	字符串	可选
文本	text	可以替代 issue 参数生成描述	内容	可选
小型文本	smalltext	可以替代 fix 参数生成详细描述	内容	可选
外部链接图标	plainlinks	可以设置外部链接是否显示一个表明是外部链接的图标	布尔	可选
移除信息	removalnotice	在主题文本后面显示移除提示	布尔	可选
分类	cat	指定引用此消息框的条目的清理分类	字符串	可选
全部分类	all	指定所有引用此消息框的条目的分类	字符串	可选
分类 2	cat2	指定引用此消息框的条目的清理分类	字符串	可选
全部分类 2	all2	指定所有引用此消息框的条目的分类	字符串	可选
分类 3	cat3	指定引用此消息框的条目的清理分类	字符串	可选
全部分类 3	all3	指定所有引用此消息框的条目的分类	字符串	可选