模板:Cmbox/doc

本模板搬运自维基百科。
原页面: Template:Cmbox, 该模板不采用 CC BY-NC 4.0协议进行许可, 而是采用 CC BY-SA 3.0协议进行许可。

本模板是{{Cmbox}} ([C]ategory [m]essage [b]ox) (分类消息框) 元模板。

它用于建立分类页面的消息框模板。它提供若干种不同的颜色, 当无图像参数给出时使用预设图像, 它还有其他特点。

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

用法

简单应用的例子:

{{Cmbox | text = Some text.}}

Some text.

复杂应用的例子:

{{Cmbox
  | type      = style
  | image     = [[File:Emblem-question-yellow.svg|40px]]
  | style     = width: 400px; 
  | textstyle = color: red; font-weight: bold; font-style: italic;
  | text      = 消息框的主体文字。
}}

消息框的主体文字。

分类信息框类别

以下范例使用了不同的 type 参数, 但没有使用 image 参数, 因而使用了各 type (类型) 所对应的预设图像。

type=speedy – 快速删除模板.

type=delete – 删除模板.

type=content – 大警告与问题.

type=style – 小警告与问题.

type=notice – 各种提示与信息。

type=move – 移动, 合并与分割信息和提议.

type=protection – 保护模板, 当显示于分类页面上时。

其他图片

上方显示的预设图像是十分方便的, 但在很多情况下需要使用特别指定的图像。以下是一些使用 image 参数来指定其他图像的案例:

type = style
image = [[File:Sub-arrows.svg|40px]]
???.

type = move
image = [[File:Redirect arrow.svg|52px]]
重定向吧.

特殊设定

此外, 还有一些其他的参数。

未给出type和image参数 (default)

未给出type且 image=none – 不使用图片, 而text将占用消息框的整个区域。

image = [[File:Gnome globe current event.svg|42px]]
imageright = [[File:Nuvola apps bookcase.svg|40px]]

此分类下的条目当前正在进行空间任务。

参数

所有参数的列表:

{{Cmbox
  | type       = speedy / delete / content / style / notice / move / protection
  | image      = none / [[File:Some image.svg|40px]]
  | imageright = [[File:Some image.svg|40px]]
  | style      = CSS values
  | textstyle  = CSS values
  | text       = The message body text. 
}}

type

如果不指定type参数的话，会返回用于 "条目注意" 的预设类型notice的模板。这意味着会像上文中的简单应用那样产生一个蓝色的边框。

image

No parameter = 如果不指定image参数的话, 会返回使用预设图像的模板。至于是哪张预设图像则取决于type参数。

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

image = [[File:Sub-arrows.svg|40px]]

none = 不使用图像。

imageright

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

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

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

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

style

一个可选的 CSS 值 used by the entire message box table. Without quotation marks " ". For example:

style = margin-bottom: 0.5em;

textstyle

一个可选的 CSS 值 used by the text cell. For example:

textstyle = text-align: center;

text: 消息框的主体文字。

技术细节

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

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

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

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

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

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

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

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

模板数据

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

Cmbox模板数据

Cmbox (分类消息框) 元模板, 用于构建分类名字空间里的消息框。

模板参数
此模板有自定义格式。
参数		描述	类型	状态
类型	`type`	指定消息框类型默认值 notice	字符串	推荐
图像	`image`	可以设置消息框左侧的图像	不完整的wikitext	可选
右侧图像	`imageright`	可以设置消息框右侧的图像	不完整的wikitext	可选
CSS 样式	`style`	可以设置消息框的 CSS 样式	字符串	可选
文本 CSS 样式	`textstyle`	可以设置消息框内文本的 CSS 样式	字符串	可选
文本	`text`	消息框显示的文本	内容	可选

脚注