模板:Ambox/doc

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

它用于构建条目消息框。它提供若干种不同的颜色, 当无图像参数给出时使用预设图像, 以及一些其他特点。

常用参数

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

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

name

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

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

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

subst

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

small

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

{{Ambox
  | small = left
  | issue = 这是一个靠左显示的小型模板。
}}

一般情况下本信息框显示的结果如下:

{{Ambox
  | issue = 这是一个标准的信息框格式。
}}

其他参数设置方式:

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

type

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

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

image

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

提示:

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

sect

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

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

issue 和 fix

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

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

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

talk

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

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

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

提示:

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

date

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

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

info

此参数用于指定附加信息。你在这里添加的任何内容都会在 data 参数之后出现。

removalnotice

如果将此参数定义 |removalnotice=yes, 则以下提醒将会被显示在日期和信息文本之后:

• Learn how and when to remove this template message.

cat

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

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

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

all

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

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

其他参数

{{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            = 
}}

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

imageright

无参数 = 如果不指定imageright参数的话, 会返回右侧不带图像的模板。

一张图像 = 应该是一幅带有常见维基符号的图像。通常为40px－50px的宽度, 这取决于图像的长宽比。（但消息框可应付各种尺寸的图像。）例如：

imageright = [[File:Nuvola apps bookcase.png|40px]]

任何东西 = 任何你想在模板右侧显示的其他内容。

smallimage 和 smallimageright

|smallimage= 指定小消息框的左侧图像;

|smallimageright= 指定小消息框的右侧图像。

class

指定信息框的CSS类, 用于样式、机器人或者别的什么。

style 和 textstyle

|style= 指定消息框的CSS样式。

|textstyle= 指定信息框文本的CSS样式。

text 和 smalltext

|text= 可以替代issue参数指定信息框的主文本。

|smalltext= 可以替代fix参数指定信息框的次要文本。

plainlinks

指定信息框的外链是否显示图标

cat2, cat3, all2 和 all3

多种分类, 方法详见上面的 cat 和 all 参数。

技术细节

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

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

• 通常不需要上面示例中围绕文本的<div>标记。但是, 如果文本包含换行符, 那么有时我们会得到奇怪的行距。使用垂直虚线列表时, 尤其会发生这种情况。发生时使用div标签修复该问题。
• 此模板在Module:Message_box/styles.css中定义其外观, 因此它完全可自定义。
• 此模板调用Module:Message box, 其中包含{{Ambox}}的大部分代码, 而{{Ambox}}本身进行参数预处理。
• 在内部, 此元模板使用HTML标记而不是表格代码的Wiki标记。这是我们制作元模板的常用方法, 因为Wiki标记有几个缺点。例如, 它使得在参数中使用解析器函数和特殊字符变得更加困难。
• 此元模板的默认图像为png格式, 而不是svg格式。主要原因是RIA | Wiki不支持svg文件格式。
• 有关更多技术细节, 请参见原讨论页面。由于此模板的工作原理几乎与{{Cmbox}}, {{Imbox}}, {{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	指定所有引用此消息框的条目的分类	字符串	可选