Template:Ambox: Difference between revisions
meta>Happy-melon add code to find amboxes using |type=merge and |type=serious, to correct so we can remove these types |
meta>Davidgothberg Widening the detection and reporting of faulty "type" parameter to cover all namespaces. See Template talk:Tmbox#Deprecated ambox parameters. |
||
| Line 2: | Line 2: | ||
{{#switch:{{{type|}}} | {{#switch:{{{type|}}} | ||
| speedy = ambox-speedy | | speedy = ambox-speedy | ||
| serious <!-- | | serious <!-- This value is **deprecated**, please don't use it! --> | ||
| delete = ambox-delete | | delete = ambox-delete | ||
| content = ambox-content | | content = ambox-content | ||
| style = ambox-style | | style = ambox-style | ||
| merge <!-- | | merge <!-- This value is **deprecated**, please don't use it! --> | ||
| move = ambox-move | | move = ambox-move | ||
| protection = ambox-protection | | protection = ambox-protection | ||
| Line 22: | Line 22: | ||
| {{#switch:{{{type|}}} | | {{#switch:{{{type|}}} | ||
| speedy = [[Image:Ambox speedy deletion.png|40x40px]] | | speedy = [[Image:Ambox speedy deletion.png|40x40px]] | ||
| serious <!-- | | serious <!-- This value is **deprecated**, please don't use it! --> | ||
| delete = [[Image:Ambox deletion.png|40x40px]] | | delete = [[Image:Ambox deletion.png|40x40px]] | ||
| content = [[Image:Ambox content.png|40x40px]] | | content = [[Image:Ambox content.png|40x40px]] | ||
| style = [[Image:Ambox style.png|40x40px]] | | style = [[Image:Ambox style.png|40x40px]] | ||
| merge <!-- | | merge <!-- This value is **deprecated**, please don't use it! --> | ||
| move = [[Image:Ambox move.png|40x40px]] | | move = [[Image:Ambox move.png|40x40px]] | ||
| protection = [[Image:Ambox protection.png|40x40px]] | | protection = [[Image:Ambox protection.png|40x40px]] | ||
| Line 40: | Line 40: | ||
}} | }} | ||
</tr> | </tr> | ||
</table> | </table><!-- Detect and report usage with faulty "type" parameter: | ||
-->{{#switch:{{{type|}}} | |||
| <!-- No type fed, is also valid input --> | |||
| speedy | |||
| delete | |||
| content | |||
| style | |||
| move | |||
| protection | |||
| notice = <!-- Do nothing, valid "type" --> | |||
| #default = [[Category:Ambox templates using deprecated | |||
types|{{main other|Main:}}{{FULLPAGENAME}}]]<!-- Sort on namespace --> | |||
}}<noinclude> | |||
{{pp-template|small=yes}} | {{pp-template|small=yes}} | ||
{{Documentation}} | {{Documentation}} | ||
<!-- Add categories and interwikis to the /doc subpage, not here! --> | <!-- Add categories and interwikis to the /doc subpage, not here! --> | ||
</noinclude> | </noinclude> | ||
Revision as of 06:43, 21 August 2008
| {{{text}}} |
 | This template uses Lua: |
| Message box meta-templates | |
|---|---|
| template | context |
| {{Ambox}} | article |
| {{Cmbox}} | category |
| {{Imbox}} | image |
| {{Tmbox}} | talk |
| {{Fmbox}} | footer / header |
| {{Ombox}} | other pages |
| {{Mbox}} | auto-detect |
| {{Asbox}} | article stub |
| {{Dmbox}} | disambiguation |
The {{Ambox}} template's name derives from Article message box, which is a metatemplate. It is used to build message boxes for templates used in articles, such as {{Cleanup}}. It offers several different colours, images, and some other features.
Basic usage
The box below shows the most common parameters that are accepted by {{Ambox}}. The purpose of each is described below.
{{Ambox
| name =
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type =
| image =
| sect = {{{1|}}}
| issue =
| talk = {{{talk|}}}
| fix =
| date = {{{date|}}}
| cat =
| all =
}}
Full usage
The box shows all possible parameters for this template. However, it is not recommended to copy this, because it will never be required to use all of the parameters simultaneously.
{{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 =
}}
Common parameters
name
The name parameter specifies the name of the template, without the 'Template:' namespace prefix. For example, {{Cleanup}} specifies it as |name=Cleanup. This parameter should be updated if the template is ever moved. Its purpose is twofold:
- If incorrectly substituted, it allows the metatemplate to record the name of the template which has been substituted, which may help later editors to correct the problem.
- It allows the template to have a more useful display on its own page, for example to show the date even when not specified, and to apply categorization of the template itself.
subst
The subst parameter allows the metatemplate to detect whether the template has been incorrectly substituted, and give an appropriate warning if so. It will also add such pages to the Pages with incorrectly substituted templates category. Just copy the value for it exactly as shown here.
small
The small parameter should be passed through the template, as this will allow editors to use a more compact format by specifying |small=left on an article:
This is the compact (small), left-aligned Ambox format. |
Otherwise, the standard format will be shown:
| This is the standard Ambox format. |
Other variations:
- For templates which should never use the compact format, specify
|small=noor do not pass the small parameter through at all. - For templates which should always use the compact format, just specify
|small=left. - For templates which should default to the compact format, try
|small={{{small|left}}}. This will allow an editor to override that choice by supplying|small=nowhere they invoke the template.
To use a small box that adjusts its width to match the text, use |style=margin-right: 0; width: auto; and |textstyle=width: auto; together:
| This is the more compact, left-aligned Ambox format with flexible width. |
See the § sect section below for more information on how to limit |small= use to instances when the template is being used for a section, instead of the whole article (which is recommended, to prevent inconsistent top-of-page display).
type
The type parameter defines the color of the bar on the box's left edge and the image that is used by default. The type is chosen not on aesthetics, but based on the nature of the information that the box contains. The seven available types and their default images are as follows:
| type=speedy – Speedy deletion issues, such as pages created by spammers or pages created mistakenly by well-intentioned editors. |
type=delete – Deletion issues, such as {{Article for deletion}} and {{Proposed deletion}}. |
type=content – Content issues, such as {{POV}} and objectionable material on pages. |
type=style – Style issues, such as {{Cleanup}} and {{Underlinked}}. |
type=notice – Article notices, such as {{Imported}}. |
type=move – Merge and split proposals, such as {{Split}} and {{Merge}}. |
type=protection – Protection notices, such as {{Pp-vandalism}} and {{Pp-protected}}. |
If the type parameter is not defined, the template defaults to |type=notice.
image
You can choose a specific image to use for the template by using the image parameter. Images are specified using the standard syntax for inserting files on Zoophilia Wiki (see Manual of Style/Images#How to place an image.) Widths of 40–50px work best and are typical, provided its aspect ratio is close to square, and if not it may be advantageous to define its height py prepending an 'x' when specifying its size, as in x40px. For example:
{{POV}}specifies|image=[[File:Unbalanced scales.svg|50x40px|class=skin-invert|link=|alt=]].{{{text}}}
{{Underlinked}}specifies|image=[[File:Ambox wikify.svg|50x40px|class=skin-invert|link=|alt=]].
{{{text}}} Please note:
- If no image is specified, then the default image corresponding to the value of the
typeparameter is used. (See the § type section above.) - If
|image=noneis specified, then no image is used and the text fills the entire message box area. - If an icon is purely decorative and also in the public domain, accessibility can be improved by suppressing the link to the file page by adding
|link=and|alt=to the file link as seen above.
sect
Many article message templates begin with the text This article … and it is often desirable that this wording be altered to read This section … if the template contains information pertaining only to a section of a page instead. The value of this parameter will replace the word "article." Various possibilities for use include:
|sect=list,|sect=table,|sect="In popular culture" material, etc.When using this feature, be sure to remove the words "This article" from the template text, otherwise it will be duplicated.
A common way to facilitate this functionality is to pass
|sect={{{1|}}}. This will allow editors to type section, for example, as the first unnamed parameter of the template to change the wording. This can be seen at work in{{Advert}}|section:{{{text}}} Another approach is to pass
|sect={{{section|{{{sect|}}}}}}to provide a named value. Another is to use{{Yesno}}to parse true values to a boolean option and pass|sect=sectionif true.These approaches can be combined, and this is recommended. The following ready-to-use code…
…provides multiple benefits:
- Any positive value that
{{Yesno}}can detect will be used with the named parameter in the{{Ambox}}-based template to read "section" instead of "article":|section=y,|sect=true, etc. It is recommended to allow both|sect=and|section=so that editors do not have to guess which one will work, as sample code above does. - Any other value passed, in any manner, will replace "article":
|section and its subsections,|1=list,|sect=section,|section=table, etc.
It is also advisable to restrict use of the
|small=parameter so that it is made contingent upon the template being applied to a section or some other subset of a page rather than the whole article, to prevent the small version of the template from being used at the top of the article, where it would be inconsistent with other article-wide banners:(In this case, any value of
|small=or|left=will trigger the small, left display, as long as some value of|sect=or one of its aliases in that template has also been provided.) This code can be copy-pasted and used with the above code block.issue and fix
The
issueparameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10–20 words). Thefixparameter contains some text which describes what should be done to improve the article; it may be longer than the text inissue, but typically should not exceed two sentences.When the template is in its compact form (as when placed inside
{{Multiple issues}}) or compact form (when using|small=left), the value of theissueparameter is the only text that will be displayed. For example,{{Citation style}}defines|issue=This article '''has an unclear citation style'''.|fix=The references used may be made clearer with a different or consistent style of citation, footnoting or external linking.
When used stand-alone it produces:
{{{text}}} But when used inside
{{Multiple issues}}or with|small=leftit displays only the issue:This article has multiple issues. Please help improve it or discuss these issues on the talk page. (Learn how and when to remove these template messages){{{text}}} {{{text}}} talk
Some article message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the
talkparameter through, i.e.|talk={{{talk|}}}.This parameter may then be used by an editor as follows:
|talk=SECTION HEADING– the link will point to the specified section on the article's talk page, e.g.|talk=Foo|talk=FULL PAGE NAME– the template will link to the page specified (which may include a section anchor), e.g.|talk=Talk:Banana#Foo
Notes:
- When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
- In order to make sure there is always a link to the talk page, you can use
|talk={{{talk|#}}}. - If the talk page does not exist, there will be no link, whatever the value of the parameter.
date
Passing the
dateparameter through to the metatemplate means that the date that the article is tagged may be specified by an editor. This will be displayed after the message in a smaller font.info
This parameter is for specifying additional information. Whatever you add here will appear after the date, and will not be displayed if the template is being wrapped in
{{Multiple issues}}.removalnotice
If you specify
|removalnotice=yes, then the following notice will be displayed after the date and after theinfotext:This will not be displayed if the template is being wrapped in
{{Multiple issues}}.cat
This parameter defines a monthly cleanup category. If
|cat=CATEGORYthen:- articles will be placed in Category:CATEGORY from DATE if
|date=DATEis specified. - articles will be placed in Category:CATEGORY if the date is not specified.
For example,
{{No footnotes}}specifies|cat=Articles lacking in-text citationsand so an article with the template{{No footnotes}}|date=11 2024will be placed in Category:Articles lacking in-text citations from 11 2024]].The value of the
catparameter should not be wikilinked, nor should the prefix 'Category:' be used.all
The
allparameter defines a category into which all articles should be placed. Likewise, the value of theallparameter should not be wikilinked, nor should the prefix 'Category:' be used.Additional parameters
imageright
An image on the right side of the message box may be specified using this parameter. The syntax is the same as for the
imageparameter, except that the default is for no image to be displayed.smallimage and smallimageright
Images for the compact format may be specified using these parameters. They will have no effect unless
|small=leftis specified.class
The
classparameter defines custom CSS classes to apply to the template. If adding multiple classes, they should be space-delimited (separated by whitespace).style and textstyle
The
styleandtextstyleparameters define optional CSS style declarations for the template and values should not be wrapped in quotation marks" ", but with a terminating semicolon;for each declaration.styledefines the style used by the entire message box. This can be used to do things such as modifying the width of the box, for instance.textstyledefines the style for only the displayed text.
text and smalltext
Instead of specifying the
issueandfixparameters, it is possible to use thetextparameter with particular attention to the formatting, instead.Customised text for the small format can be defined using the
smalltextparameter.plainlinks
On Zoophilia Wiki, links to other websites are typically displayed with an arrow icon next to them, like this: example.com. However, in message boxes, that arrow icon is suppressed by default, as in: example.com. To restore the normal style of external link with the arrow icon, use
|plainlinks=no.cat2, cat3, {Var|all2}} and all3
- The
cat2andcat3parameters provide for additional monthly categories, extending the §catparameter. - The
all2andall3parameters provide for additional categories into which all articles are placed, extending the §allparameter.
Technical notes
- If you need to use special characters in the
textparameter, then you need to escape them in the manner shown below…{{Ambox | nocat = true | text = <div>Equal sign = and a start and end brace { } work fine as they are. But here is a pipe | and two end braces }}. And now a pipe and end braces |}}.</div> }}…which produces…
Equal sign = and a start and end brace { } work fine as they are.
But here is a pipe | and two end braces }}.
And now a pipe and end braces |}}. - The
<div>…</div>tags that surround the text in the example above are usually not needed, but if the text contains line breaks, then sometimes weird line spacing occurs. This especially happens when using bulleted lists. In such cases, use the<div>…</div>tags to fix that. - The default images for this metatemplate are in the PNG file format rather than SVG. The main reason for this is that some older web browsers have trouble with the transparent background that MediaWiki renders for SVG images. The PNG images here have hand-optimized, transparent backgrounds so that they appear as intended in all browsers. Note that SVG icons only look somewhat bad in the old browsers, thus such hand-optimization is only worth the trouble for very widely used icons.
- For more technical details, see the talk page and the § See also links below. Since this template works almost exactly like
{{Tmbox}},{{Imbox}},{{Cmbox}}and{{Ombox}}, their talk pages and related pages might also contain additional details.
Display on mobile devices
The MediaWiki developers have been conducting ongoing readability studies on this template on the mobile version of the site. Until further notice, code installed by the developers on the mobile version will generally override what is done here regarding the display and layout of this template. For more information, see MediaWiki:Mobile Page Issues.
TemplateData
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for this template in articles based on this TemplateData.TemplateData for Ambox
Used to build message boxes for templates used in articles
Template parameters
This template prefers block formatting of parameters.
Parameter Description Type Status Template Name nameThe name parameter specifies the name of the template, without the Template namespace prefix.
String optional subst substAllows the meta-template to detect whether the template has been incorrectly substituted
Unknown optional Small Mode smallThe small parameter should be passed through the template, as this will allow editors to use the small format by specifying |small=left on an article.
- Suggested values
noleft
String optional type typeType of issue the template describes. Defines the colour of the left bar, and the image that is used by default
- Suggested values
speedydeletecontentstylenoticemoveprotection
Line optional image imageImage used with the template
File optional sect sectParameter that can be used to change the text "this article" to "this section" or something else
- Suggested values
{{{1|}}}
Line optional issue issueDescribes the issue with the article
Content optional fix fixDescribes what should be done to improve the article
Content optional talk talkno description
- Auto value
{{{talk|}}}
Unknown optional date dateno description
Unknown optional info infoSpecifies additional information
Unknown optional removalnotice removalnoticeDisplays a notice about when and how to remove the template message
Boolean optional cat catDefines a monthly cleanup category
Unknown optional all allDefines a category into which all articles should be placed
Unknown optional imageright imagerightno description
Unknown optional class classno description
Unknown optional text textno description
Unknown optional plainlinks plainlinksno description
Unknown optional smallimage smallimageno description
Unknown optional smallimageright smallimagerightno description
Unknown optional textstyle textstyleno description
Unknown optional style styleno description
Unknown optional smalltext smalltextno description
Unknown optional cat2 cat2no description
Unknown optional cat3 cat3no description
Unknown optional all2 all2no description
Unknown optional all3 all3no description
Unknown optional Mbox family
There are seven metatemplates in the Module:Message box family:- {{Ambox}}, for messageboxes on article pages.
- {{Cmbox}}, for messageboxes on category pages.
- {{Imbox}}, for messageboxes on file (image) pages.
- {{Tmbox}}, for messageboxes on talk pages.
- {{Fmbox}}, for header and footer messageboxes.
- {{Ombox}}, for messageboxes on other types of page.
- {{Mbox}}, for messageboxes that are used in different namespaces and change their presentation accordingly.
Closely related metatemplates:
- {{Asbox}}, for messageboxes in article stubs.
- {{Dmbox}}, for messageboxes on disambiguation or set-index pages.
- {{Ivmbox}}, a simple full-width box with default ivory background intended to frame important messages or notices.
Templates intended to be used in conjunction with Mboxes:
- {{Ombox/shortcut}}, an alternative to {{Shortcut}} for use in Mbox templates
See also
- Wikipedia:Article message boxes – The historical style guideline for creating article message boxes.
- If no image is specified, then the default image corresponding to the value of the
