模板:Imbox/doc

这是 {{Imbox}} ([I]mage [m]essage [box]) (图像消息框) 元模板。

这被用于在文件 (图像) 页构建消息框模板。它提供若干种不同的颜色, 当无图像参数给出时使用预设图像, 它还有其他特点。

该模板的工作原理与 {{Ambox}} 几乎相同，并使用同样的参数。

使用

简单的使用例:

{{Imbox | text = 一些文字。}}

一些文字。

复杂的例子:

{{Imbox
  | type      = style
  | style     = max-width: 400px;
  | image     = [[File:Emblem-question-yellow.svg|40px]]
  | textstyle = font-style: italic; font-weight: bold; color: red; 
  | text      = 消息文本。
}}

文件:Emblem-question-yellow.svg

消息文本。

图像消息框的类型

下面的例子使用了不同的 type 参数但是未使用 image 参数, 因而使用各 type (类型) 所对应的预设图像。

type=speedy – 快速删除模板。

type=delete – 删除模板。

type=content – 大警告或问题。

type=style – 小警告或问题。

type=notice – 提示以及其他任何类型。

type=move – 移动和重命名消息/建议。

type=protection – 保护。

文件:Cscr-featured.svg

type=featured – 特色图片。

其他图像

上面显示的默认图像主要是为了方便。在许多情况下, 使用更具体的图像更合适。这些示例使用 image参数来指定默认图像之外的图像。

文件:Gnome-dev-camera.svg

type = style
image = [[File:Gnome-dev-camera.svg|42px]]

文件:To Commons.svg

type = move
image = [[File:To Commons.svg|52px]]

特殊使用

其他一些参数组合。

不指定 type 和 image 参数。 (默认)

不指定 type 参数以及 |image=no – 不显示图像, text 使用整个消息框区域。

参数

所有参数的列表

{{Imbox
  | name = 模板名称
  | type  = speedy / delete / content / style / notice / 
            move / protection / license / featured
  | image = none / [[File:Some image.svg|40px]]
  | imageright = [[File:Some image.svg|40px]]
  | style = CSS 值
  | textstyle = CSS 值
  | text  = 消息框主体文本
  | below = 更多文本或者另一个 Imbox
  | plainlinks = no
}}

name

(可选) 模板名. 这将会在HTML标签的CSS类里面添加一个 box-name, 用于机器人或脚本.

type

如果不指定 type 参数会设置该参数为默认的 notice. 是一个蓝色边框的消息框.

image

不指定参数 = 如果不指定该参数将会使用默认的图片, 默认图像取决于 type 参数.

一张图像 = 使用标准Wiki图像语法将会显示一张图像. 40px - 50px 是通常使用的宽度, 高度之类的取决于原始图像的长宽比. (但是消息框可以处理任何大小的图像.) 一个例子:

image = [[File:Gnome-dev-camera.svg|40px]]

none = 没有图像.

imageright

不指定参数 = 不会显示右侧图像

一张图像 = 使用标准Wiki图像语法将会在消息框右侧显示一张图像. 40px - 50px 是通常使用的宽度, 高度之类的取决于原始图像的长宽比. (但是消息框可以处理任何大小的图像.) 一个例子:

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

任何东西 = 任何你想在消息框右侧显示的项目.

style

可选的 CSS 样式作用于整个消息框表格, 没有引号 (" ") 但是末尾需要有分号标记 (;), 一个例子:

style = margin-bottom: 0.5em;

textstyle

可选的 CSS 样式作用于消息框文本, 没有引号 (" ") 但是末尾需要有分号标记 (;), 一个例子:

textstyle = text-align: center;

text

消息框的文本.

below

在图像和文本区域下方的一个全宽度区域. 可以放置文本或其他任意项目, 例如另一个 imbox:

below = {{Imbox |type=content |text=This license tag is deprecated.}}

plainlinks

默认为 yes. 如果不需要外部链接箭头 - 文件:External.svg - , 这样做:

plainlinks = no

技术细节

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

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

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

此模板在Module:Message_box/styles.css中使用 .imbox 类定义其外观, 因此它完全可皮肤化。

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

在内部, 此元模板使用HTML标记而不是表格代码的Wiki标记。这是我们制作元模板的常用方法, 因为Wiki标记有几个缺点。例如, 它使得在参数中使用解析器函数和特殊字符变得更加困难。

此元模板的默认图像为png格式, 而不是svg格式。主要原因是某些较旧的浏览器无法使用透明的png图像。对于那些较旧的浏览器, 已对这些png图像进行了修改, 以使其默认背景的颜色与模板的背景颜色匹配。MediaWiki为svg图像渲染的默认背景始终为白色。在较旧的浏览器中显示时, 这会在图像周围创建一个白框。

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

模板数据

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

Imbox模板数据

{{Imbox}} ([I]mage [m]essage [box]) (图像消息框) 元模板, 这被用于在文件 (图像) 页构建消息框模板.

模板参数

此模板有自定义格式。

参数		描述	类型	状态
名称	name	模板的名称	字符串	可选
类型	type	模板的类型 默认值 system 示例值 system	字符串	可选
左侧图像	image	模板左侧的图像, 使用标准的Wiki语法, 填写 none 为不显示图像 示例值 [[Image:User-info.svg|40px]]	wikitext片段	可选
右侧图像	imageright	消息框右侧的图像, 使用标准的Wiki语法 示例值 [[Image:Nuvola apps bookcase.png|40px]]	wikitext片段	可选
CSS样式	style	作用于整个消息框表格的CSS样式, 没有引号 (" ") 但是末尾需要有分号标记 (;)	字符串	可选
文本CSS样式	textstyle	CSS样式作用于消息框文本, 没有引号 (" ") 但是末尾需要有分号标记 (;).	字符串	可选
外链图标	plainlinks	设置为 no 不显示外链图标 示例值 no	字符串	可选
文本	text	消息框的文本	内容	可选
下部内容	below	在图像和文本区域下方的一个全宽度区域. 可以放置文本或其他任意项目.	内容	可选