Ambox/doc

Revision as of 15:31, 22 August 2020

Documentation

[purge]

This is the article message box metatemplate, it is used to build article message boxes like {{Stub}}.

Parameters

small: (Optional) Creates a small article message box with the css float property set to the specified value.
icon: (Default: Ambox {{{type}}}.png) Sets the icon displayed on the left of the message box.
type: (Default: notice) Sets the color of the left bar, the icon is also chosen depending on this value if icon isn't set. Acceptable values, and respective colors and default icons, are listed below:

date: (Optional) Date tag to display in the bottom right corner.
text: The text to display in the message box.

Examples

Code

Result

{{Ambox|type=notice|text=Hello}}

{{Ambox|type=notice|text=Hello|date={{subst:#time:F Y}}}}

{{Ambox|type=notice|text=Hello|small=left}}

{{Ambox|type=notice|text=Hello|small=left|date={{subst:#time:F Y}}}}

This is the documentation page, it should be transcluded into the main template page. See Template:Doc for more information.

Other languages:

@@ Line 1: / Line 1: @@
-{{doc/start}}
+{{Doc/Start{{L}}}}
+<noinclude><translate><!--T:1-->
-== Parameters ==
+</noinclude>
-===small===
+This is the article message box metatemplate, it is used to build article message boxes like {{Tl|Stub}}.
-''(Optional, Default if set:left)'' Creates a small ambox with the float property set to the specified value.
-{{Ambox|small=left|text=small=left}}<br><br>
+== Parameters == <!--T:2-->
-===icon===
+* '''small''': ''(Optional)'' Creates a small article message box with the css float property set to the specified value.
-''(Default:Ambox {{{type}}}.png)'' Sets the display icon.
+* '''icon''': ''(Default: Ambox {{{type}}}.png)'' Sets the icon displayed on the left of the message box.
-===type===
-''(Default:notice)'' Set the color of the left bar.
+* '''type''': ''(Default: notice)'' Sets the color of the left bar, the icon is also chosen depending on this value if icon isn't set. Acceptable values, and respective colors and default icons, are listed below:
 {{Ambox|type=speedy|text=type=speedy}}
 {{Ambox|type=delete|text=type=delete}}
@@ Line 15: / Line 15: @@
 {{Ambox|type=move|text=type=move}}
 {{Ambox|type=protection|text=type=protection}}
+{{Ambox|type=minecraftwiki|text=type=minecraftwiki}}
-===date===
-''(Optional)'' Date (stuff) to display in the bottom right corner.
+* '''date''': ''(Optional)'' Date tag to display in the bottom right corner.
+* '''text''': The text to display in the message box.
-===text===
-Text to display.
-=== Common Parameters ===
-<pre>
-{{Ambox
-| type = notice
-| text = Hello
-| date = {{subst:#time:Y F}}
-}}
-</pre>
-{{Ambox|type=notice|text=Hello|date=2013 March}}
-=== Examples ===
+=== Examples === <!--T:3-->
 {| class="wikitable" style="width:100%"
 ! Code !! Result
@@ Line 35: / Line 25: @@
 | <pre>{{Ambox|type=notice|text=Hello}}</pre> || style="width:60%" | {{Ambox|type=notice|text=Hello}}
 |-
-| <pre>{{Ambox|type=notice|text=Hello|date={{subst:#time:Y F}}}}</pre> || {{Ambox|type=notice|text=Hello|date=2013 March}}
+| <pre>{{Ambox|type=notice|text=Hello|date={{subst:#time:F Y}}}}</pre> || {{Ambox|type=notice|text=Hello|date=March 2013}}
 |-
 | <pre>{{Ambox|type=notice|text=Hello|small=left}}</pre> || {{Ambox|type=notice|text=Hello|small=left}}
 |-
-| <pre>{{Ambox|type=notice|text=Hello|small=left|date={{subst:#time:Y F}}}}</pre> || {{Ambox|type=notice|text=Hello|small=left|date=2013 March}}
+| <pre>{{Ambox|type=notice|text=Hello|small=left|date={{subst:#time:F Y}}}}</pre> || {{Ambox|type=notice|text=Hello|small=left|date=March 2013}}
 |}
+<!--T:4-->
-{{doc/end}}
+<!-- Categories -->
+{{TC|Metatemplates}}
+{{TC|Article message templates}}
+<noinclude></translate></noinclude>
+{{Doc/End|Template:Ambox/doc}}