Ambox/doc

Revision as of 13:56, 3 May 2020

Documentation

This template is a base template for many notice templates.

Usage

{{Ambox
|icon=
|border= 
|type= 
|info=
|border=
|format=
|style=
}}

{{Ambox 

	| icon =  

	| image =  

	| type =   *

	| info =  

	| border =  

	| format =  

	| style =  

}}

Note: The * symbol denotes required arguments

Argument	Description	Default Value
`icon`	Image file name for use on the left, e.g. "Stub.png"
`image`	Left (image) cell content, overrides
`type *`	The top line of test
`info`	List of extra info
`border`	The colour of the Ambox border. Possible Values: red (serious issue) yellow (mild issue) green (good!) purple (technical change) blue (notice) orange(stub colour) gray	green
`format`	Set value to `tiny` to display a small, left-aligned box showing only the
`style`	Any extra HTML style attributes

Examples

{{Ambox
| type = I am type
| info = I am info
}}

Produces:

I am type
I am info

{{Ambox
| type = I am tiny
| icon = Icon-template.png
| format = tiny
}}

Prodcues:

I am tiny

{{Ambox
| image = [[Image:Icon-boilerplate.png]]
| border = red
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = yellow
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = green
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = purple
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = blue
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = orange
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

{{Ambox
| border = gray
| type = I am type
| info =
* I am info
}}

Produces:

I am type
* I am info

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

@@ Line 1: / Line 1: @@
 {{doc/start}}
+This template is a base template for many notice templates.
+==Usage==
-The template is a notice template
+<pre>{{Ambox
+|icon=
+|border=
+|type=
+|info=
+|border=
+|format=
+|style=
+}}</pre>
+{{TemplateArguments
-===Named parameters===
+|arg1= icon
-:; |icon=: image file name for use on the left, e.g. "Stub.png"
+|desc1= Image file name for use on the left, e.g. "Stub.png"
-:; |image=: left (image) cell content, overrides <code>|icon=</code> if provided.
-:; |type=: top line text
-:; |info=: list of extra info
-:; |border=: border colour (defaults to green)
-::; red      : ambox-red (serious issue)
-::; yellow   : ambox-yellow (mild issue)
-::; green    : ambox-green (good!)
-::; purple   : ambox-purple (technical change)
-::; blue     : ambox-blue (notice)
-::; orange   : ambox-orange (stub colour)
-::; gray     : ambox-gray
-:; |format: <code>tiny</code> to display a small, left-aligned box showing only the <code>|type=</code> value; any other value displays the full ambox.
-:; |style=: extra style parameters ''(unlikely to be used)''
+|arg2= image
+|desc2= Left (image) cell content, overrides <code>|icon=</code> if provided.
+|arg3= type
+|desc3= The top line of test
+|req3= true
+|arg4= info
+|desc4= List of extra info
+|arg5= border
+|desc5= The colour of the Ambox border. <br>
+Possible Values:
+* red (serious issue)
+* yellow (mild issue)
+* green (good!)
+* purple (technical change)
+* blue (notice)
+* orange(stub colour)
+* gray
+|def5= green
+|arg6= format
+|desc6= Set value to <code>tiny</code> to display a small, left-aligned box showing only the <code>|type=</code> value.
+|arg7= style
+|desc7= Any extra HTML style attributes
+}}
 == Examples ==
+<pre>{{Ambox
-=== Default ===
+| type = I am type
+| info = I am info
+}}</pre>
+Produces:
 {{Ambox
 | type = I am type
@@ Line 27: / Line 59: @@
 }}
+<pre>{{Ambox
-=== Tiny ===
+| type = I am tiny
+| icon = Icon-template.png
+| format = tiny
+}}</pre>
+Prodcues:
 {{Ambox
 | type = I am tiny
@@ Line 34: / Line 71: @@
 }}
+<pre>{{Ambox
-=== Red + image ===
+| image = [[Image:Icon-boilerplate.png]]
+| border = red
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | image = [[Image:Icon-boilerplate.png]]
@@ Line 43: / Line 87: @@
 }}
-=== Yellow ===
+<pre>{{Ambox
+| border = yellow
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = yellow
@@ Line 51: / Line 102: @@
 }}
+<pre>{{Ambox
-=== Green ===
+| border = green
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = green
@@ Line 59: / Line 116: @@
 }}
+<pre>{{Ambox
-=== Purple ===
+| border = purple
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = purple
@@ Line 67: / Line 130: @@
 }}
+<pre>{{Ambox
-=== Blue ===
+| border = blue
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = blue
@@ Line 75: / Line 144: @@
 }}
+<pre>{{Ambox
-=== Orange ===
+| border = orange
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = orange
@@ Line 83: / Line 158: @@
 }}
+<pre>{{Ambox
-=== Gray ===
+| border = gray
+| type = I am type
+| info =
+* I am info
+}}</pre>
+Produces:
 {{Ambox
 | border = gray
@@ Line 90: / Line 171: @@
 * I am info
 }}
+[[Category:Notice templates]]
 {{doc/end}}