SockyPaws: Create template documentation page

2024-09-29T19:46:30Z

Create template documentation page

New page

{{Documentation subpage}}
{{Lua|Module:Message box}}
{{Mbox templates (small)}}

The {{Template link general|brace=on|plaincode=on|Ambox}} template's name derives from '''A'''rticle '''m'''essage '''box''', which is a [[wikipedia:Help:Metatemplating|metatemplate]]. It is used to build message boxes for templates used in '''articles''', such as {{Template link general|brace=on|plaincode=on|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 {{Template link general|brace=on|plaincode=on|Ambox}}. The purpose of each is described below.
<pre style="border: 3px ridge #ccc; font-size: 1rem; margin-left: 6em; min-width: 30vw; overflow: auto; padding: 1em 8em 1em 1em; width: fit-content;">{{Ambox
| name =
| subst = <includeonly>{{subst:substcheck}}</includeonly>
| small = {{{small|}}}
| type =
| image =
| sect = {{{1|}}}
| issue =
| talk = {{{talk|}}}
| fix =
| date = {{{date|}}}
| cat =
| all =
}}</pre>

== Full usage ==
{{Hidden begin|title=Full parameters|titlestyle=background-color: palegreen;}}
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.

<pre style="border: 3px ridge #ccc; font-size: 1rem; margin-left: 6em; min-width: 30vw; overflow: auto; padding: 1em 8em 1em 1em; width: fit-content;">{{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 =
}}</pre>
{{Hidden end}}
{{Clear}}

== Common parameters ==
=== {{Var|name}} ===
The <code>name</code> parameter specifies the name of the template, without the 'Template:' namespace prefix. For example, {{Template link general|brace=on|plaincode=on|Cleanup}} specifies it as {{Para|name|Cleanup}}. This parameter should be updated if the template is ever moved. Its purpose is twofold:
* If incorrectly [[wikipedia:Wikipedia:Substitution|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.

=== {{Var|subst}} ===
The <code>subst</code> 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 [[:Category:Pages with incorrectly substituted templates|Pages with incorrectly substituted templates]] category. Just copy the value for it exactly as shown here.

=== {{Var|small}} ===
The <code>small</code> parameter should be passed through the template, as this will allow editors to use a more compact format by specifying {{Para|small|left}} on an article:
{{Ambox|nocat=true|small=left|text=This is the compact (<code>small</code>), left-aligned Ambox format.}}
Otherwise, the standard format will be shown:
{{Ambox|nocat=true|text=This is the standard Ambox format.}}

Other variations:
* For templates which should ''never'' use the compact format, specify {{Para|small|no}} or do not pass the small parameter through at all.
* For templates which should ''always'' use the compact format, just specify {{Para|small|left}}.
* For templates which should ''default to the compact format'', try {{Para|small|<nowiki>{{{small|left}}}</nowiki>}}. This will allow an editor to override that choice by supplying {{Para|small|no}} where they invoke the template.

To use a small box that adjusts its width to match the text, use {{Para|style|margin-right: 0; width: auto;}} and {{Para|textstyle|width: auto;}} together:
{{Ambox|nocat=true|small=left|style=margin-right: 0; width: auto;|textstyle=margin-right: 0; width: auto;|text=This is the more compact, left-aligned Ambox format with flexible width.}}

See the [[#sect|§ {{Var|sect}}]] section below for more information on how to limit {{Para|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).

=== {{Var|type}} ===
The <code>type</code> 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:
{{Ambox|nocat=true|type=speedy|text=type=speedy – Speedy deletion issues, such as pages created by spammers or pages created mistakenly by well-intentioned editors.}}
{{Ambox|nocat=true|type=delete|text=type=delete – Deletion issues, such as {{Template link general|brace=on|plaincode=on|Article for deletion}} and {{Template link general|brace=on|plaincode=on|Proposed deletion}}.}}
{{Ambox|nocat=true|type=content|text=type=content – Content issues, such as {{Template link general|brace=on|plaincode=on|POV}} and objectionable material on pages.}}
{{Ambox|nocat=true|type=style|text=type=style – Style issues, such as {{Template link general|brace=on|plaincode=on|Cleanup}} and {{Template link general|brace=on|plaincode=on|Underlinked}}.}}
{{Ambox|nocat=true|type=notice|text=type=notice – Article notices, such as {{Template link general|brace=on|plaincode=on|Imported}}.}}
{{Ambox|nocat=true|type=move|text=type=move – Merge and split proposals, such as {{Template link general|brace=on|plaincode=on|Split}} and {{Template link general|brace=on|plaincode=on|Merge}}.}}
{{Ambox|nocat=true|type=protection|text=type=protection – Protection notices, such as {{Template link general|brace=on|plaincode=on|Pp-vandalism}} and {{Template link general|brace=on|plaincode=on|Pp-protected}}.}}

If the <code>type</code> parameter is not defined, the template defaults to {{Para|type|notice}}.

=== {{Var|image}} ===
You can choose a specific image to use for the template by using the <code>image</code> parameter. Images are specified using the standard syntax for inserting files on Zoophilia Wiki (see [[wikipedia:Wikipedia:Manual of Style/Images#How to place an image|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 <code>x40px</code>. For example:
* {{Template link general|brace=on|plaincode=on|POV}} specifies {{Para|image|<nowiki>[[File:Unbalanced scales.svg|50x40px|class=skin-invert|link=|alt=]]</nowiki>}}. {{Ambox|name=POV|small=no|type=content|class=ambox-POV|image=[[File:Unbalanced scales.svg|50x40px|class=skin-invert|link=]]|issue=The '''[[wikipedia:Wikipedia:Neutral point of view|neutrality]] of this article is disputed'''.|talk=#|fix=Please do not remove this message until [[Template:POV#When to remove|conditions to do so are met]].|removalnotice=yes|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}} 
* {{Template link general|brace=on|plaincode=on|Underlinked}} specifies {{Para|image|<nowiki>[[File:Ambox wikify.svg|50x40px|class=skin-invert|link=|alt=]]</nowiki>}}. {{Ambox|name=Underlinked|type=style|image=[[File:Ambox wikify.svg|50x40px|class=skin-invert|link=|alt=]]|issue=This article '''needs more links to other articles to help integrate it into the encyclopedia'''.|fix=Please help [{{fullurl:{{FULLPAGENAME}}|action=edit}} improve this article] by adding links [[wikipedia:Wikipedia:Manual of Style/Linking#Overlinking and underlinking|that are relevant to the context]] within the existing text.|removalnotice=yes|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}

Please note:
* If no image is specified, then the default image corresponding to the value of the <code>type</code> parameter is used. (See the [[#type|§ type]] section above.)
* If {{Para|image|none}} is specified, then no image is used and the text fills the entire message box area.
* If an icon is [[wikipedia:Wikipedia:Alternative text for images#Purely decorative images|purely decorative]] and also in the public domain, [[wikipedia:Wikipedia:Manual of Style/Accessibility|accessibility]] can be improved by suppressing the link to the file page by adding {{Para|link}} and {{Para|alt}} to the file link as seen above.

=== {{Var|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: {{Para|sect|list}}, {{Para|sect|table}}, {{Para|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 {{Para|sect|<nowiki>{{{1|}}}</nowiki>}}. This will allow editors to type <kbd>section</kbd>, for example, as the first unnamed parameter of the template to change the wording. This can be seen at work in {{Template link expanded|brace=on|plaincode=on|Advert|section}}:
{{Ambox|name=Advert|type=content|class=ambox-Advert|issue=This section '''contains content that is written like an advertisement'''.|fix=Please help [{{fullurl:{{FULLPAGENAME}}|action=edit}} improve it] by removing [[wikipedia:Wikipedia:Spam|promotional content]] and inappropriate [[wikipedia:Wikipedia:External links#Advertising and conflicts of interest|external links]], and by adding encyclopedic content written from a [[wikipedia:Wikipedia:Neutral point of view|neutral point of view]].|removalnotice=yes|nocat=true|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
Another approach is to pass {{Para|sect|<nowiki>{{{section|{{{sect|}}}}}}</nowiki>}} to provide a named value. Another is to use {{Template link expanded|brace=on|plaincode=on|Yesno}} to parse true values to a [[wikipedia:Boolean data type|boolean]] option and pass {{Para|sect|section}} if true.

'''These approaches can be combined''', and this is recommended. The following ready-to-use code…
{{Block indent|1=<code><nowiki>|sect={{#ifeq:{{Yesno|def=|1={{{sect|{{{section}}}}}}}}|yes|section|{{{sect|{{{section|{{{1|}}}}}}}}}}}</nowiki></code>}}
…provides multiple benefits:
* Any positive value that {{Template link expanded|brace=on|plaincode=on|Yesno}} can detect will be used with the named parameter in the {{Template link general|brace=on|plaincode=on|Ambox}}-based template to read "section" instead of "article": {{Para|section|y}}, {{Para|sect|true}}, etc. It is recommended to allow both {{Para|sect}} and {{Para|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": {{Para||section and its subsections}}, {{Para|1|list}}, {{Para|sect|section}}, {{Para|section|table}}, etc.

It is also advisable to restrict use of the {{Para|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:
{{Block indent|1=<code><nowiki>|small={{#if:{{{sect|{{{section|{{{1|}}}}}}}}}|{{#if:{{{small|{{{left|}}}}}}|left}}}}</nowiki></code>}}
(In this case, any value of {{Para|small}} or {{Para|left}} will trigger the small, left display, as long as some value of {{Para|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.

=== {{Var|issue}} and {{Var|fix}} ===
The <code>issue</code> parameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10–20 words). The <code>fix</code> parameter contains some text which describes what should be done to improve the article; it may be longer than the text in <code>issue</code>, but typically should not exceed two sentences.

When the template is in its compact form (as when placed inside {{Template link general|brace=on|plaincode=on|Multiple issues}}) or compact form (when using {{Para|small|left}}), the value of the <code>issue</code> parameter is the only text that will be displayed. For example, {{Template link general|brace=on|plaincode=on|Citation style}} defines
* <code><nowiki>|issue=This article '''has an unclear citation style'''.</nowiki></code>
* <code><nowiki>|fix=The references used may be made clearer with a different or consistent style of citation, footnoting or external linking.</nowiki></code>

When used stand-alone it produces:
{{Ambox|name=Citation style|type=style|small=no|issue='''has an unclear [[wikipedia:Wikipedia:Citing sources#Citation style|citation style]]'''.|fix=The references used may be made clearer with a different or consistent style of [[wikipedia:Wikipedia:Citing sources|citation]] and [[wikipedia:Help:Footnotes|footnoting]].|nocat=true|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|removalnotice=yes}}

But when used inside {{Template link general|brace=on|plaincode=on|Multiple issues}} or with {{Para|small|left}} it displays only the issue:
{{Multiple issues|{{Ambox|name=Citation style|type=style|small=no|issue='''has an unclear [[wikipedia:Wikipedia:Citing sources#Citation style|citation style]]'''.|nocat=true|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|removalnotice=yes}}}}
{{Ambox|name=Citation style|type=style|small=left|issue='''has an unclear [[wikipedia:Wikipedia:Citing sources#Citation style|citation style]]'''.|nocat=true|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|removalnotice=yes}}

=== {{Var|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 <code>talk</code> parameter through, i.e. {{Para|talk|<nowiki>{{{talk|}}}</nowiki>}}.

This parameter may then be used by an editor as follows:
* {{Para|talk|{{Var|SECTION HEADING}}}} – the link will point to the specified section on the article's talk page, e.g. {{Para|talk|Foo}}
* {{Para|talk|{{Var|FULL PAGE NAME}}}} – the template will link to the page specified (which may include a [[wikipedia:Help:Link#Section linking (anchors)|section anchor]]), e.g. {{Para|talk|{{Var|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 {{Para|talk|<nowiki>{{{talk|#}}}</nowiki>}}.
* If the talk page does not exist, there will be no link, whatever the value of the parameter.

=== {{Var|date}} ===
Passing the <code>date</code> parameter 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.

=== {{Var|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 {{Template link general|brace=on|plaincode=on|Multiple issues}}.

=== {{Var|removalnotice}} ===
If you specify {{Para|removalnotice|yes}}, then the following notice will be displayed after the date and after the <code>info</code> text:
* [[wikipedia:Help:Maintenance template removal|Learn how and when to remove this template message]].
This will not be displayed if the template is being wrapped in {{Template link general|brace=on|plaincode=on|Multiple issues}}.

=== {{Var|cat}} ===
This parameter defines a monthly cleanup category. If {{Para|cat|{{Var|CATEGORY}}}} then:
* articles will be placed in '''Category:{{Var|CATEGORY}} from {{Var|DATE}}''' if {{Para|date|{{Var|DATE}}}} is specified.
* articles will be placed in '''Category:{{Var|CATEGORY}}''' if the date is not specified.

For example, {{Template link general|brace=on|plaincode=on|No footnotes}} specifies {{Para|cat|Articles lacking in-text citations}} and so an article with the template {{Template link expanded|bold=on|brace=on|plaincode=on|No footnotes|2=date={{CURRENTMONTH}} {{CURRENTYEAR}}}} will be placed in Category:Articles lacking in-text citations from {{CURRENTMONTH}} {{CURRENTYEAR}}]].

The value of the <code>cat</code> parameter should not be wikilinked, nor should the prefix 'Category:' be used.

=== {{Var|all}} ===
The <code>all</code> parameter defines a category into which all articles should be placed. Likewise, the value of the <code>all</code> parameter should not be wikilinked, nor should the prefix 'Category:' be used.

== Additional parameters ==
=== {{Var|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 <code>image</code> parameter, except that the default is for no image to be displayed.

=== {{Var|smallimage}} and {{Var|smallimageright}} ===
Images for the compact format may be specified using these parameters. They will have no effect unless {{Para|small|left}} is specified.

=== {{Var|class}} ===
The <code>class</code> parameter defines custom [[wikipedia:Cascading Style Sheets|CSS]] classes to apply to the template. If adding multiple classes, they should be space-delimited (separated by whitespace).

=== {{Var|style}} and {{Var|textstyle}} ===
The <code>style</code> and <code>textstyle</code> parameters define optional CSS style declarations for the template and values should not be wrapped in quotation marks <code>" "</code>, but with a terminating semicolon <code>;</code> for each declaration.
* <code>style</code> defines 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.
* <code>textstyle</code> defines the style for only the displayed text.

=== {{Var|text}} and {{Var|smalltext}} ===
Instead of specifying the <code>issue</code> and <code>fix</code> parameters, it is possible to use the <code>text</code> parameter with particular attention to the formatting, instead.

Customised text for the small format can be defined using the <code>smalltext</code> parameter.

=== {{Var|plainlinks}} ===
On Zoophilia Wiki, links to other websites are typically displayed with an arrow icon next to them, like this: [https://www.example.com/ example.com]. However, in message boxes, that arrow icon is suppressed by default, as in: [https://www.example.com/ example.com]. To restore the normal style of external link with the arrow icon, use {{Para|plainlinks|no}}.

=== {{Var|cat2}}, {{Var|cat3}}, {Var|all2}} and {{Var|all3}} ===
* The <code>cat2</code> and <code>cat3</code> parameters provide for additional monthly categories, extending the [[#cat|§ <code>cat</code>]] parameter.
* The <code>all2</code> and <code>all3</code> parameters provide for additional categories into which all articles are placed, extending the [[#all|§ <code>all</code>]] parameter.

== Technical notes ==
<ul><li>If you need to use special characters in the <code>text</code> parameter, then you need to escape them in the manner shown below…
<pre style="border: 3px ridge #ccc; font-size: 1rem; min-width: 30vw; margin-left: 8em; overflow: auto; padding: 1em 8em 1em 1em; width: fit-content;">{{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 <nowiki>}}</nowiki>.
And now a pipe and end braces <nowiki>|}}</nowiki>.</div>
}}</pre>
…which produces…
{{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 <nowiki>}}</nowiki>. And now a pipe and end braces <nowiki>|}}</nowiki>.</div>}} </li>
<ul><li>The {{Xtag|div|p}} 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 {{Xtag|div|p}} tags to fix that.</li></ul>
<li>The default images for this metatemplate are in the [[wikipedia:PNG|PNG file format]] rather than [[wikipedia:SVG|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.</li>
<li>For more technical details, see the [[wikipedia:Template talk:Ambox|talk page]] and the [[#See also|§ See also]] links below. Since this template works almost exactly like {{Template link general|brace=on|plaincode=on|Tmbox}}, {{Template link general|brace=on|plaincode=on|Imbox}}, {{Template link general|brace=on|plaincode=on|Cmbox}} and {{Template link general|brace=on|plaincode=on|Ombox}}, their talk pages and related pages might also contain additional details.</li></ul>

== Display on mobile devices ==
The MediaWiki developers have been conducting ongoing readability studies on this template on the [https://m.zoophilia.wiki/ 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 [[mediawikiwiki:Reading/Web/Projects/Mobile Page Issues|MediaWiki:Mobile Page Issues]].

== TemplateData ==
{{TemplateData header}}
<templatedata>{
"description": "Used to build message boxes for templates used in articles",
"format": "block",
"paramOrder": [
"name",
"subst",
"small",
"type",
"image",
"sect",
"issue",
"fix",
"talk",
"date",
"info",
"removalnotice",
"cat",
"all",
"imageright",
"class",
"text ",
"plainlinks",
"smallimage ",
"smallimageright",
"textstyle",
"style ",
"smalltext",
"cat2",
"cat3",
"all2",
"all3"
],
"params": {
"small": {
"label": "Small Mode",
"description": "The 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.",
"type": "string",
"suggestedvalues": [
"no",
"left"
]
},
"talk": {
"autovalue": "{{{talk|}}}"
},
"date": {},
"name": {
"label": "Template Name",
"description": "The name parameter specifies the name of the template, without the Template namespace prefix. ",
"type": "string"
},
"type": {
"description": "Type of issue the template describes. Defines the colour of the left bar, and the image that is used by default",
"type": "line",
"suggestedvalues": [
"speedy",
"delete",
"content",
"style",
"notice",
"move",
"protection"
]
},
"image": {
"description": "Image used with the template",
"type": "wiki-file-name"
},
"sect": {
"description": "Parameter that can be used to change the text \"this article\" to \"this section\" or something else",
"type": "line",
"suggestedvalues": [
"{{{1|}}}"
]
},
"issue": {
"description": "Describes the issue with the article",
"type": "content"
},
"fix": {
"description": "Describes what should be done to improve the article",
"type": "content"
},
"subst": {
"description": "Allows the meta-template to detect whether the template has been incorrectly substituted"
},
"info": {
"description": "Specifies additional information"
},
"removalnotice": {
"description": "Displays a notice about when and how to remove the template message",
"type": "boolean"
},
"cat": {
"description": "Defines a monthly cleanup category"
},
"all": {
"description": "Defines a category into which all articles should be placed"
},
"imageright": {},
"class": {},
"text ": {},
"plainlinks": {},
"smallimage ": {},
"smallimageright": {},
"textstyle": {},
"style ": {},
"smalltext": {},
"cat2": {},
"cat3": {},
"all2": {},
"all3": {}
}
}</templatedata>

== Mbox family ==
{{Mbox templates see also}}

== See also ==
* [[wikipedia:Wikipedia:Manual of Style/Article message boxes|Wikipedia:Article message boxes]] – The historical style guideline for creating article message boxes.

<includeonly>{{Sandbox other||
[[Category:Article message templates| ]]
[[Category:Mbox and messagebox templates]]
}}</includeonly>

Template:Ambox/doc - Revision history

SockyPaws: Create template documentation page