Template:Ambox/doc: Difference between revisions

From Foundry Wiki
(Created page with "{{doc/start}} 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 <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 (technica...")
 
No edit summary
Line 1: Line 1:
{{doc/start}}
{{doc/start}}


The template is a notice template
<includeonly>{{Languages|Template:Ambox}}</includeonly>
{{Mbox templates}}


===Named parameters===
This is the {{Tl|Ambox}} or '''Article message box''' meta-template.
:; |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 ==
== Parameters ==
=== <code>type</code> ===
The <code>type</code> 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{{\sandbox}}
| nocat = true
| type  = speedy
| text  = type=<u>speedy</u> — Speedy deletion issues, such as {{tl|speedy}}.
}}
{{Ambox{{\sandbox}}
| nocat = true
| type  = delete
| text  = type=<u>delete</u> — Deletion issues, such as {{tl|delete}}.
}}
{{Ambox{{\sandbox}}
| nocat = true
| type  = content
| text  = type=<u>content</u> — Content issues, such as {{tl|Update}} and {{tl|Expand}}.
}}
{{Ambox{{\sandbox}}
| nocat = true
| type  = style
| text  = type=<u>style</u> — Style issues, such as {{tl|cleanup}} and {{tl|Documentation needed}}.
}}
{{Ambox{{\sandbox}}
| nocat = true
| type  = notice
| text  = type=<u>notice</u> — Notices, such as {{tl|Extension exception}} and {{tl|Translating}}.
}}
{{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}}.
}}
{{Ambox{{\sandbox}}
| nocat = true
| type  = protection
| text  = type=<u>protection</u> — Protection notices, such as {{tl|Pp-cascading}} and {{tl|protectedinterface}}.
}}
 
If no <code>type</code> parameter is given the template defaults to {{para|type|notice}}.


=== Default ===
=== <code>small=left</code> ===
{{Ambox
{{Ambox{{\sandbox}}
| type = I am type
| nocat = true
| info = I am info
| type = speedy
| text  = type=<u>speedy</u> — Speedy deletion issues, such as {{tl|speedy}}.
| small = left
}}
}}
 
{{Ambox{{\sandbox}}
=== Tiny ===
| nocat = true
{{Ambox
| type = delete
| type = I am tiny
| text  = type=<u>delete</u> — Deletion issues, such as {{tl|delete}}.
| icon = Icon-template.png
| small = left
| format = tiny
}}
}}
 
{{Ambox{{\sandbox}}
=== Red + image ===
| nocat = true
{{Ambox
| type  = content
| image = [[Image:Icon-boilerplate.png]]
| text  = type=<u>content</u> — Content issues, such as {{tl|Update}} and {{tl|Expand}}.
| border = red
| small = left
| type = I am type
| info =
* I am info
}}
}}
 
{{Ambox{{\sandbox}}
=== Yellow ===
| nocat = true
{{Ambox
| type = style
| border = yellow
| text  = type=<u>style</u> — Style issues, such as {{tl|cleanup}} and {{tl|Documentation needed}}.
| type = I am type
| small = left
| info =
* I am info
}}
}}
 
{{Ambox{{\sandbox}}
=== Green ===
| nocat = true
{{Ambox
| type = notice
| border = green
| text  = type=<u>notice</u> — Notices, such as {{tl|Extension exception}} and {{tl|Translating}}.
| type = I am type
| small = left
| info =
* I am info
}}
}}
 
{{Ambox{{\sandbox}}
=== Purple ===
| nocat = true
{{Ambox
| type = move
| border = purple
| text  = type=<u>move</u> — Merge, split and transwiki proposals, such as {{tl|Merge}} and {{tl|Move to Commons}}.
| type = I am type
| small = left
| info =
* I am info
}}
}}
 
{{Ambox{{\sandbox}}
=== Blue ===
| nocat = true
{{Ambox
| type = protection
| border = blue
| text  = type=<u>protection</u> — Protection notices, such as {{tl|Pp-cascading}} and {{tl|protectedinterface}}.
| type = I am type
| small = left
| info =
* I am info
}}
}}


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


=== Gray ===
{{Ambox
| border = gray
| type = I am type
| info =
* I am info
}}
{{doc/end}}
{{doc/end}}

Revision as of 05:02, 29 June 2022

Template-info.png Documentation


22px-OOjs UI icon puzzle-ltr.png


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


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