Template:Fmbox/doc:修订间差异

删除的内容 添加的内容
从 zhwiki 适配完整文档,追加 Uses TemplateStyles 声明
从求闻适配 Fmbox 文档(模板名与分类对齐中医百科)
第1行:
{{Mbox templates}}
{{uses Lua|Module:Message box}}
{{Documentation subpage}}
{{uses TemplateStyles|MediaWiki:Gadget-SiteCommon.css}}
{{Uses Lua|Module:Message box}}
本模板{{tl|fmbox}}為'''頁首與頁尾訊息框'''。
{{Uses TemplateStyles|Module:Message box/fmbox.css}}
 
It can be used to build message boxes for system messages such as [[MediaWiki:Sp-contributions-footer-anon]]. It can also be used for footer and header boxes on user pages and for [[help:编辑提示|editnotices]].
'''{{tlx|Fmbox}}'''(Footer & header message box,页首与页尾信息框)用于系统消息界面和编辑提示。它也可用于用户页的页脚/页眉框和编辑提示。本模板 100% 宽度显示,与 {{tlx|Ambox}} 参数基本相同。
 
This template works similarly to {{tl|ambox}} and mostly uses the same parameters. The main differences are that this box is 100% wide and has different colour styles.
== 常用参数 ==
{| class="wikitable"
! 参数 !! 说明
|-
| <code>type</code> || <code>warning</code> / <code>editnotice</code> / <code>system</code>
|-
| <code>image</code> || 自定义图标(<code>none</code> 则不显示图片)
|-
| <code>imageright</code> || 右侧图片
|-
| <code>id</code> || CSS id,用于 JavaScript 检测
|-
| <code>class</code> || CSS 类名,用于个性化皮肤
|-
| <code>style</code> || 整个信息框的 CSS 样式
|-
| <code>textstyle</code> || 文字单元格的 CSS 样式
|-
| <code>text</code> || 消息正文
|}
 
=== type 类型使用方法 ===
簡易使用法如下:
{{Fmbox|type=warning|text=type=<u>warning</u> 警告通知}}
<pre>
{{Fmbox|type=editnotice|text=type=<u>editnotice</u> 编辑提示(透明背景)}}
{{fmbox | text = 範例文字。}}
{{Fmbox|type=system|text=type=<u>system</u> 系统消息(浅灰背景,默认)}}
</pre>
{{fmbox | text = 範例文字。}}
 
完整使用法如下:
未指定 type 时默认为 <code>system</code>。
<pre>
{{fmbox
| type = editnotice
| image = [[File:Emblem-question-yellow.svg|40px]]
| style = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text = 訊息主體文字。
}}
</pre>
 
{{fmbox
== 特殊设定 ==
| type = editnotice
{{Fmbox|text=未指定 type 和 image(默认)}}
| image = [[File:Emblem-question-yellow.svg|40px]]
{{Fmbox|image=none|text=image=none — 不使用图片,text 占用整个区域}}
| style = border: 1px solid #f4c430;
| textstyle = color: red; font-weight: bold; font-style: italic;
| text = 訊息主體文字。
}}
 
=== Footer and header message box types ===
 
The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.
 
{{fmbox
== 参数说明 ==
| type = warning
<syntaxhighlight lang="wikitext">
| text = type=<u>warning</u> – Warning notices such as [[MediaWiki:Revision-info]] and [[MediaWiki:Protectedpagewarning]].
}}
 
{{fmbox
| type = editnotice
| text = type=<u>editnotice</u> – Transparent background for [[help:编辑提示|editnotices]].
}}
 
{{fmbox
| type = system
| text = type=<u>system</u> – Light grey system message background (default).
}}
 
=== Other images ===
 
The default images shown above are mostly for testing and demonstration. In most cases it is more appropriate to use a more specific image or no image at all. These examples use the '''image''' parameter to specify an image other than the default image.
 
{{fmbox
| image = [[File:User-info.svg|40px]]
| text = image = <nowiki>[[File:User-info.svg|40px]]</nowiki> <br> This image is used for [[MediaWiki:Sp-contributions-footer]].
}}
=== Special ===
Some other parameter combinations.
 
{{fmbox
| text = No image given ('''default''')
}}
{{fmbox
| image = none
| text = '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}
{{fmbox
| image = [[File:User-info.svg|40px]]
| imageright = [[File:Nuvola apps bookcase.svg|40px]]
| text = image = <nowiki>[[File:User-info.svg|40px]]</nowiki> <br> imageright = <nowiki>[[File:Nuvola apps bookcase.svg|40px]]</nowiki>
}}
 
=== Parameters ===
 
List of all parameters:
 
<pre>
{{fmbox
| type = system / editnotice / warning
第45行 ⟶ 第87行:
| imageright = [[File:Some image.svg|40px]]
| id = CSS id
| class = CSS 类名class names
| style = CSS 取值values
| textstyle = CSS 取值values
| text = 消息正文The message body text.
}}
</pre>
</syntaxhighlight>
 
'''type'''
== 技术细节 ==
:If no '''type''' parameter is given the template defaults to type '''system'''. That means it gets a light grey background.
如需在 text 参数中使用特殊字符:
 
<syntaxhighlight lang="wikitext">
'''image'''
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:
::<code><nowiki>image = [[File:User-info.svg|40px]]</nowiki></code>
:'''none''' = Means that no image is used.
 
'''imageright'''
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. (But the message box can handle images of any size.) For example:
::<code><nowiki>imageright = [[File:Nuvola apps bookcase.png|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.
 
'''id'''
:Optional [[层叠样式表|CSS]] id used by the entire message box table. Without quotation marks <code>" "</code>. Mostly meant to be used to tag a message box with its name, to make it easy to detect the presence of the message from javascript. For instance [[MediaWiki:Sp-contributions-footer]] would use:
::<code>id = sp-contributions-footer</code>
 
'''class'''
:Optional [[层叠样式表|CSS]] class names used by the entire message box table. Without quotation marks <code>" "</code>. Mostly meant to be used to tag a message box with its name so it can be individually skinned. For instance [[MediaWiki:Sp-contributions-footer]] would use:
::<code>class = sp-contributions-footer</code>
 
'''style'''
:Optional [[层叠样式表|CSS]] values used by the entire message box table. Without quotation marks <code>" "</code> but with the ending semicolons <code>;</code>. For example:
::<code>style = margin-top: 1em;</code>
 
'''textstyle'''
:Optional [[层叠样式表|CSS]] values used by the text cell. For example:
::<code>textstyle = font-size: 90%; text-align: center;</code>
 
'''text'''
:The message body text.
 
=== Technical details ===
 
This template currently uses hard coded styles and class names. Later it will only use CSS classes making it easier to skin. (In the meantime it can be skinned by using the "<code>!important</code>" keyword.)
 
If you need to make a box that is less than 100% wide, then do ''not'' use this box, instead use the {{tl|ombox}}. Since this box doesn't have the "1px empty image cell" code that makes it so the other mboxes get proper box flow in all browsers when less than 100% wide.
 
If you need to use special characters in the text parameter then you need to escape them like this:
 
<pre>
{{fmbox
| text = <div>
Equal sign = and a start and end brace { } work fine as they are.
等号 = 与前后大括号 { } 可以正常使用。
但管道符But here is a pipe {{!}} 与两个后大括号and two end braces <nowiki>}}</nowiki>. 不能直接使用。
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}
</pre>
</syntaxhighlight>
 
{{fmbox
| text = <div>
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>.
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}
 
Internally this meta-template uses HTML wikimarkup instead of wikimarkup for the table code. That is the usual way we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use parser functions and some special characters in parameters.
 
'''Note to admins:''' MediaWiki does not parse and convert HTML wikimarkup in system messages the same way as it does for normal pages. This means for instance that <code><br></code> is not automatically converted to <code><br /></code> and missing <code></td></code> and <code></tr></code> tags are not automatically added. Thus see to that any HTML code you use in system messages are valid XHTML. That is, close all tags that you begin. However, regular wikimarkup works fine in most system messages.
 
For more technical details see the [[Template talk:Fmbox|talk page]]. Since this template works almost exactly like {{tl|ambox}}, {{tl|tmbox}}, {{tl|imbox}}, {{tl|cmbox}} and {{tl|ombox}} their talk pages and related pages might also contain more details.
如果需要宽度不足 100% 的框,请使用 {{tlx|Ombox}}。
 
=== 参见See also ===
{{Mbox templates see also}}
* {{tlx|Ambox}} — 条目消息框
* {{tlx|Tmbox}} — 讨论页消息框
* {{tlx|Imbox}} — 文件页消息框
* {{tlx|Cmbox}} — 分类消息框
* {{tlx|Ombox}} — 其他页面消息框
* {{tlx|Mbox}} — 自动检测命名空间
 
<includeonly>