Template:Ambox/doc: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 21:12, 5 July 2022

This is a documentation subpage for Template:Ambox.
It contains usage information, categories and other content that is not part of the original template page.

This template is used on a very large number of pages.
To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them.

This is the {{Ambox}} or Article message box meta-template.

Parameters

`type`

The type parameter defines the colour of the left bar, and the image that is used by default. The type is chosen not on aesthetics but is based on the type of issue that the template describes. The seven available types and their default images are shown below.

If no type parameter is given the template defaults to |type=notice.

`small=left`

TemplateData

This is the specialized version of the {{mbox}} or “multi namespace message box” meta-template.

Template parameters
This template prefers block formatting of parameters.
Parameter		Description	Type	Status
Type	`type`	no description Suggested values `speedy` `delete` `content` `style` `notice` `move` `protection` Default notice	String	suggested
Image (left)	`image`	no description Suggested values `none` Default Depends on the “type” parameter.	Content	suggested
Image (right)	`imageright`	no description	Content	optional
CSS Style	`style`	no description	String	optional
Text CSS Style	`textstyle`	no description	String	optional
Text	`text`	no description	Content	suggested
Small?	`small`	no description Suggested values `{{{small\|}}}` `left` `yes` `1` Default 0	Boolean	optional
Small Image (left)	`smallimage`	no description Suggested values `none` Default {{{image}}}	Content	optional
Small Image (right)	`smallimageright`	no description Suggested values `none` Default {{{imageright}}}	Content	optional
Small Text	`smalltext`	no description Default {{{text}}}	Content	optional

@@ Line 3: / Line 3: @@
 This is the {{Tl|Ambox}} or '''Article message box''' meta-template.
-=== ''type'' ===
+== Parameters ==
+=== <code>type</code> ===
 The ''type'' parameter defines the colour of the left bar, and the image that is used by default. The type is chosen not on aesthetics but is based on the type of issue that the template describes. The seven available types and their default images are shown below.
 {{Ambox
@@ Line 41: / Line 42: @@
 }}
-If no ''type'' parameter is given the template defaults to {{para|type|notice}}.
+If no <code>type</code> parameter is given the template defaults to {{para|type|notice}}.
+=== <code>small=left</code> ===
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = speedy
+| text  = type=<u>speedy</u> — Speedy deletion issues, such as {{tl|speedy}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = delete
+| text  = type=<u>delete</u> — Deletion issues, such as {{tl|delete}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = content
+| text  = type=<u>content</u> — Content issues, such as {{tl|Update}} and {{tl|Expand}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = style
+| text  = type=<u>style</u> — Style issues, such as {{tl|cleanup}} and {{tl|Documentation needed}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = notice
+| text  = type=<u>notice</u> — Notices, such as {{tl|Extension exception}} and {{tl|Translating}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = move
+| text  = type=<u>move</u> — Merge, split and transwiki proposals, such as {{tl|Merge}} and {{tl|Move to Commons}}.
+| small = left
+}}
+{{Ambox{{\sandbox}}
+| nocat = true
+| type  = protection
+| text  = type=<u>protection</u> — Protection notices, such as {{tl|Pp-cascading}} and {{tl|protectedinterface}}.
+| small = left
+}}
 === See also ===
@@ Line 50: / Line 95: @@
 * [[w:Wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
 * [[w:Wikipedia talk:Article message boxes]] – For discussion about these matters.
+== TemplateData ==
+<!--{{TemplateData header}}-->
+{{Mbox/TemplateData}}
+<!--templatedata>
+{
+	"params": {
+		"type": {
+			"type": "line",
+			"suggestedvalues": [
+				"speedy",
+				"delete",
+				"content",
+				"style",
+				"notice",
+				"move",
+				"protection"
+			]
+		},
+		"text": {
+			"type": "string",
+			"suggested": true
+		}
+	},
+	"description": "This is a generic article message box."
+}
+</templatedata-->
+<includeonly>{{Sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
+[[Category:Mbox templates{{#translation:}}]]
+}}</includeonly>