View source for Template:Ambox/doc

{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{Lua|Module:Message box}}
This is the '''ambox''' or '''article message box''' meta template.

It is used to create ''article message box'' templates such as {{tl|wikify}} etc. It offers several different colours, uses default images if no image parameter is given and it has some other features.

=== Usage ===

Simple usage example:

<pre>
{{ambox | text = Some text.}}
</pre>

{{ambox | text = Some text.}}


Complex example:

<pre>
{{ambox
| type  = style
| image = [[Image:Icon apps query.svg|38px]]
| style = width: 400px; color: red; font-weight: bold; font-style: italic
| text  = The message body text.
}}
</pre>

{{ambox
| type  = style
| image = [[Image:Icon apps query.svg|38px]]
| style = width: 400px; color: red; font-weight: bold; font-style: italic
| text  = The message body text.
}}

==== Default images ====

The following examples use different '''type''' parameters but use no image parameters thus they use the default images for each type.

{{ambox
| type  = speedy
| text  = type=<u>speedy</u> – Speedy deletion
}}
{{ambox
| type  = delete
| text  = type=<u>delete</u> – Deletion
}}
{{ambox
| type  = content
| text  = type=<u>content</u> – Content issues
}}
{{ambox
| type  = style
| text  = type=<u>style</u> – Style issues
}}
{{ambox
| type  = merge
| text  = type=<u>merge</u> – Merge, split and transwiki proposals
}}
{{ambox
| type  = license
| text  = type=<u>license</u> – License tags
}}
{{ambox
| type  = protection
| text  = type=<u>protection</u> – Protection
}}
{{ambox
| type  = notice
| text  = type=<u>notice</u> – General notices
}}

==== Other images ====
The default images shown above are mostly for convenience. In many cases it is more appropriate to use more specific images. These examples use the '''image''' parameter to specify an image other than the default images.

{{ambox
| type  = content
| image = [[Image:Unbalanced scales.svg|40px]]
| text  = type = content <br> image = <nowiki>[[Image:Unbalanced scales.svg|40px]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues.
}}
{{ambox
| type  = style
| image = [[Image:Wikitext.svg|50px]]
| text  = type = style <br> image = <nowiki>[[Image:Wikitext.svg|50px]]</nowiki> <br> This image is often used for {{tl|wikify}} etc.
}}
{{ambox
| type  = merge
| image = [[Image:Merge-arrows.svg|50px]]
| text  = type = merge <br> image = <nowiki>[[Image:Merge-arrows.svg|50px]]</nowiki> <br> This image is used for {{tl|merge}} etc. 
}}

==== Special ====

Some other parameter combinations.

{{ambox
| text  = No type and no image given ('''default''')
}}
{{ambox
| image = blank
| text  = No type and '''image=blank''' – Causes a blank area the same size as a default image. Makes the text line up well with other message boxes. 
}}
{{ambox
| image = none
| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.
}}

{{ambox
| image = [[Image:Gnome globe current event.svg|42px]]
| imageright = [[Image:Nuvola apps bookcase.svg|40px]]
| text  = image = <nowiki>[[Image:Gnome globe current event.svg|42px]]</nowiki> <br> imageright = <nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki>
}}

{{ambox
| image = [[Image:Gnome globe current event.svg|42px]]
| imageright = [[Image:Shuttle.svg|20px]]
| text  = '''This article or section documents a current [[spaceflight]].'''
<br>Content may change as the mission progresses.
}}

=== Parameters ===

List of all parameters:

<pre>
{{ambox
| type  = type
| image = none / blank / [[Image:Some image.svg|40px]]
| imageright = [[Image:Some image.svg|40px]]
| style = Cascading Style Sheets value
| text  = The message body text. 
}}
</pre>

'''type'''
:If no '''type''' parameter is given the template defaults to type '''notice''' which is used for "article notices". That means it gets a blue side bar like in the simple usage example above.

'''image'''
:'''No parameter''' = If no '''image''' parameter is given the template uses a default image. Which default image it uses depends on the '''type''' parameter. 
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. For example: 
::<code><nowiki>[[Image:Unbalanced scales.svg|40px]]</nowiki></code>
:'''none''' = Means that no image is used.
:'''blank''' = Means that no image is used but an empty area the same size as a default image is used, which means that text in the message box gets aligned well with other article message boxes. (See the "special" examples above.)

'''imageright'''
:'''No parameter''' = If no '''imageright''' parameter is given then no image is shown on the right side.
:'''An image''' = Should be an image with usual wiki notation. 40px - 50px width are usually about right depending on the image height to width ratio. For example: 
::<code><nowiki>[[Image:Nuvola apps bookcase.svg|40px]]</nowiki></code>
:'''Anything''' = Any other object that you want to show on the right side.

'''style'''
:An optional [[Cascading Style Sheets]] value used by ''article message box'' enclosing HTML:
::<code>&lt;table style="{{((}}{'''style'''{{!}}{{))}}}" class="..."&gt; ... &lt;/table&gt;</code>

'''text'''
:The message body text.

=== Technical details ===

If you need to use special characters in the text parameter then you need to escape them like this: 

<pre>
{{ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces &lt;nowiki>}}&lt;/nowiki>. 
And now a pipe and end braces &lt;nowiki>|}}&lt;/nowiki>.
</div>
}}
</pre>

{{ambox
| text  = <div>
Equal sign = and a start and end brace { } work fine as they are. 
But here is a pipe {{!}} and two end braces <nowiki>}}</nowiki>. 
And now a pipe and end braces <nowiki>|}}</nowiki>.
</div>
}}
<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Template templates|Ambox]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
[[fr:Modèle:Ambox]]
[[ko:틀:알림 상자]]
</includeonly>