Difference between revisions of "Template:Ambox/doc"

Revision as of 03:25, 1 August 2019

The template is a notice template

Named parameters

|icon=

image file name for use on the left, e.g. "Stub.png"

|image=

left (image) cell content, overrides |icon= 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: tiny to display a small, left-aligned box showing only the |type= value; any other value displays the full ambox.
|style=: extra style parameters (unlikely to be used)

Examples

Default

Tiny

Red + image

Yellow

Green

Purple

Blue

Orange

Gray

@@ Line 1: / Line 1: @@
-<noinclude>{{Documentation subpage}}</noinclude>
+The template is a notice template
-This is the {{Tl|Ambox}} or '''Article message box''' meta-template.
-=== Type preview ===
+== Named parameters ==
+:; |icon=: 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)''
+== Examples ==
+=== Default ===
 {{Ambox
-|nocat=true
+| type = I am type
-| type  = speedy
+| info = I am info
-| text  = type=<u>speedy</u>
 }}
+=== Tiny ===
 {{Ambox
-|nocat=true
+| type = I am tiny
-| type  = delete
+| icon = Icon-template.png
-| text  = type=<u>delete</u>
+| format = tiny
 }}
+=== Red + image ===
 {{Ambox
-|nocat=true
+| image = [[Image:Icon-boilerplate.png]]
-| type  = warning
+| border = red
-| text  = type=<u>warning</u>
+| type = I am type
+| info =
+* I am info
 }}
+=== Yellow ===
 {{Ambox
-|nocat=true
+| border = yellow
-| type  = style
+| type = I am type
-| text  = type=<u>style</u>.
+| info =
+* I am info
 }}
-{{ambox
-|nocat=true
+=== Green ===
-| type  = notice
+{{Ambox
-| text  = type=<u>notice</u>
+| border = green
+| type = I am type
+| info =
+* I am info
 }}
+=== Purple ===
 {{Ambox
-|nocat=true
+| border = purple
-| type  = move
+| type = I am type
-| text  = type=<u>move</u>
+| info =
+* I am info
 }}
+=== Blue ===
 {{Ambox
-|nocat=true
+| border = blue
-| type  = protection
+| type = I am type
-| text  = type=<u>protection</u>
+| info =
+* I am info
 }}
-=== See also ===
+=== Orange ===
-{{mbox templates}}
+{{Ambox
-Other pages:
+| border = orange
-* [[wikipedia:Template:Mbox]]
+| type = I am type
-* [[wikipedia:Ambox CSS classes]] – Describes how to use the ambox CSS classes directly in [[Help:Table|wikitable]]s and [[w:HTML element#Tables|HTML tables]].
+| info =
-* [[wikipedia:Article message boxes]] – The style guideline for creating article message boxes.
+* I am info
+}}
+=== Gray ===
+{{Ambox
+| border = gray
+| type = I am type
+| info =
+* I am info
+}}
 <includeonly>
-<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
+[[Category:Notice templates|{{PAGENAME}}]]</includeonly><noinclude>
-{{languages}}
+[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
-[[Category:Template Mbox]]
-</includeonly>