Vorlage:Ambox/Doku: Unterschied zwischen den Versionen

{{Documentation subpage}}

<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

This is the {{tl|ambox}} or '''article message box''' meta-template.

=== Usage ===

Simple usage example:

<pre>

</pre>

Complex example:

<pre>

| subst      = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

| type      = style

| text      = Text for a big box, for the top of articles.

| smalltext  = Text for the top of article sections.

| category  = A name of a category to use for monthly categories

| all        = A category which all articles will be placed in

}}

</pre>

| type      = style

| small      = left

=== Article message box types ===

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

| type  = speedy

| text  = type=<u>speedy</u> – Speedy deletion issues, such as {{tl|db-g1}} and {{tl|db-g3}}.

}}

| type  = delete

| text  = type=<u>delete</u> – Deletion issues, such as {{tl|afd}} and {{tl|prod}}.

}}

| type  = content

| text  = type=<u>content</u> – Content issues, such as {{tl|POV}} and {{tl|globalize}}.

}}

| type  = style

| text  = type=<u>style</u> – Style issues, such as {{tl|cleanup}} and {{tl|wikify}}.

| text  = type=<u>notice</u> – Article notices, such as {{tl|current}} and {{tl|inuse}}.

}}

| type  = move

| text  = type=<u>move</u> – Merge, split and transwiki proposals, such as {{tl|split}} and {{tl|copy to wiktionary}}.

}}

| type  = protection

| text  = type=<u>protection</u> – Protection notices, such as {{tl|pp-vandalism}} and {{tl|pp-semi-protected}}.

=== 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.

| type  = content

| image = [[File:Unbalanced scales.svg|40px|link=|alt=]]

| text  = type = content <br> image = <nowiki>[[File:Unbalanced scales.svg|40px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|POV}} and similar issues.

}}

| type  = style

| image = [[File:Wikitext.svg|50px|link=|alt=]]

| text  = type = style <br> image = <nowiki>[[File:Wikitext.svg|50px|link=|alt=]]</nowiki> <br> This image is often used for {{tl|wikify}} etc.

}}

| type  = move

| image = [[File:Merge-arrows.svg|50px|link=|alt=]]

=== More examples ===

Some other parameter combinations.

| text  = No type and no image given ('''default''')

}}

| image = none

| text  = No type and '''image=none''' – No image is used and the '''text''' uses the whole message box area.

}}

| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]

| imageright = [[File:Nuvola apps bookcase.svg|40px|alt=Three stacked books]]

}}

| image = [[File:Gnome globe current event.svg|42px|alt=Clock over a larger globe]]

| imageright = [[File:Shuttle.svg|20px|link=|alt=]]

=== Parameters ===

List of all parameters:

<pre>

| name        = Name of template without the Template: part

| subst      = <includeonly>{{subst:</includeonly><includeonly>substcheck}}</includeonly>

| smallimageright = none / [[File:...|20px|...]]

| smalltext  = A shorter message body text.

| preposition = Preposition between category name and month (defaults to "from")

| date        = {{{date|}}}

| all        = Category which all articles will be placed in, if any

}}

</pre>

==== Categorisation parameters ====

==== The small parameters ====

The small article message boxes are meant for the top of sections. Normally they should only contain one or two lines of text.

:'''left''' = Makes it a smaller left aligned message box. This also makes the default images smaller. Note that any data fed to the '''smallimage''', '''smallimageright''' and '''smalltext''' parameters is only used if "small=left". To make it so your template also understands the small parameter you can use this code:

::<code><nowiki>small = {{{small|}}}</nowiki></code>

| small = left

| text = small = left

}}

| type = style

| small = left

::<code><nowiki>smallimage = [[File:Gnome globe current event.svg|20px|alt=Clock over a larger globe]]</nowiki></code>

:'''none''' = Means that no image is used. This overrides any image fed to '''image''', when "small=left".

| small = left

| image      = [[File:Replacement filing cabinet.svg|50px|link=|alt=]]

=== Technical details ===

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

<pre>

| text  = <div>

Equal sign = and a start and end brace { } work fine as they are.

</pre>

| text  = <div>

Equal sign = and a start and end brace { } work fine as they are.

This template uses CSS classes in [[MediaWiki:Common.css]] for most of its looks, thus it is fully skinnable.

Internally this meta-template uses HTML markup instead of wikimarkup for the table code. That is the usual way we make meta-templates since wikimarkup has several drawbacks. For instance it makes it harder to use [[m:Help:ParserFunctions|parser functions]] and some special characters in parameters.

The default images for this meta-template are in png format instead of svg format. The main reason is that some older web browsers have trouble with the transparent background that MediaWiki renders for svg images. The png images here have hand optimised transparent background colour so they look good in all browsers. Note that svg icons only look somewhat bad in the old browsers, thus such hand optimisation is only worth the trouble for very widely used icons.

=== See also ===