Vorlage:Ambox/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Ambox.

Infobox Meta-Vorlagen
{{mbox}}: Basis {{ambox}}: Artikel {{tmbox}}: Diskussion {{cmbox}}: Kategorie {{imbox}}: Bild {{ombox}}: Andere Seiten {{asbox}}: Stub {{fmbox}}: Header/Footer

Dies ist die {{Ambox}} oder Artikel-Message-Box Meta-Vorlage.

Es wird benutzt, um Artikel-Message-Boxen Vorlagen zu bauen. Es bietet verschiedene Farben, Bilder und Parameter an.

Gebräuchliche Parameter

Rechts sind die gebräuchlichsten Parameter zu sehen die von der Box akzeptiert werden {{ambox}}. Die Funktion der Parameter ist unten erläutert.

Common parameters
{{Ambox | name = | subst = <includeonly>{{subst:substcheck}}</includeonly> | small = {{{small|}}} | type = | image = | sect = {{{1|}}} | issue = | talk = {{{talk|}}} | fix = | date = {{{date|}}} | cat = | all = }}

name

name definiert den Namen der Vorlage ohne den Vorlage: Namensraum Vorsatz. Zum Beispiel {{inuse}} spezifiziert |name=inuse.

Der Parameter sollte angepasst werden, sofern die Seite verschoben wird. Der Parameter erfüllt zwei Aufgaben.

1. Sollte die Vorlage fälschlicherweise substituiert werden, wird dadurch die Fehlersuche vereinfacht weil die Metavorlage den Namen der substituierten Vorlage angibt.
2. Es erlaubt der Vorlage eine Sinnvollere Anzeige auf der Vorlagen Seite z.B. das Datum trotzdem keines spezifiziert ist oder Kategorisierung der Vorlage selbst.

subst

Der subst Parameter erlaubt es eine Warnung auszugeben, falls die Vorlage fälschlicherweise substituiert wurde.

Zudem werden solche Vorlagen der Kategorie Kategorie:Vorlagen, die ersetzt statt eingebunden wurden hinzugefügt. Just copy the code exactly as it appears in the box.

small

The small parameter should be passed through the template, as this will allow editors to use the small format by specifying |small=left or |small=right on an article. The box on the right side will be floated:

Otherwise the standard format will be produced:

Other variations:

• For templates which should never be small, specify |small=no or do not pass the small parameter at all.
• For templates which should always be small, just specify |small=left.
• For templates which should default to small, try |small={{{small|left}}}. This will allow an editor to override by using |small=no on an article.

type

Der type-Parameter bestimmt die Farbe des Balkens auf der linken Seite der Vorlage, sowie das Logo, das standardmäßig genutzt wird. The type is chosen not on aesthetics but is based on the type of issue that the template describes. Die elf verfügbaren Typen und ihr Standard-Logo werden nachfolgend gezeigt:

Sofern kein type-Parameter gesetzt wurde, nimmt die Vorlage |type=notice als gegeben an.

image

You can choose a specific image to use for the template by using the image parameter. Images are specified using the standard syntax for inserting files in Wikipedia (see w:en:Wikipedia:Manual of Style/Images#How to place an image.) Widths of 40-50px are typical. For example:

Bitte beachte:

• If no image is specified then the default image corresponding to the type is used. (See #type above.)
• If |image=none is specified, then no image is used and the text uses the whole message box area.
• If an icon is purely decorative and also in the public domain, accessibility can be improved by suppressing the link to the file page by adding "|link=|alt=" as seen above.

sect

Many article message templates begin with the text This article ... and it is often desirable that this wording change to This section ... if the template is used on a section instead. Other possibilities include This list ... and This biographical article ...

To facilitate this functionality, pass |sect={{{1|}}}. This will allow editors to type section as the first unnamed parameter of the template to change the wording.

If using this feature, be sure to remove the first two words ("This article") from the template's text, otherwise it will be duplicated.

issue and fix

The issue parameter is used to describe the issue with the article. Try to keep it short and to-the-point (approximately 10-20 words) and be sure to include a link to a relevant policy or guideline.

The fix parameter contains some text which describes what should be done to improve the article. It may be longer than the text in issue, but should not usually be more than two sentences.

When the template is in its compact form (when placed inside multiple issue templates) or small form (when using |small=left), the issue is the only text that will be displayed.

talk

Some article message templates include a link to the talk page, and allow an editor to specify a section heading to link directly to the relevant section. To achieve this functionality, simply pass the talk parameter through, i.e. |talk={{{talk|}}}

This parameter may then be used by an editor as follows:

• |talk=SECTION HEADING - the link will point to the specified section on the article's talk page, e.g. |talk=Foo
• |talk=FULL PAGE NAME - the template will link to the page specified (which may include a section anchor), e.g. |talk=Talk:Banana#Foo

Notes:

• When this parameter is used by a template, the talk page link will appear on the template itself (in order to demonstrate the functionality) but this will only display on articles if the parameter is actually defined.
• In order to make sure there is always a link to the talk page, you can use |talk={{{talk|#}}}.
• If the talk page does not exist, there will be no link, whatever the value of the parameter.

date

Passing the date parameter through to the meta-template means that the date that the article is tagged may be specified by an editor (or more commonly a bot). This will be displayed after the message in a smaller font.

Passing this parameter also enables monthly cleanup categorisation when the cat parameter is also defined.

cat

This parameter defines a monthly cleanup category. If |cat=CATEGORY then:

• articles will be placed in Category:CATEGORY from DATE if |date=DATE is specified.
• articles will be placed in Category:CATEGORY if the date is not specified.

For example, {{Löschantrag}} specifies |cat=Löschantrag and so an article with the template {{Löschantrag}} will be placed in Kategorie:Löschkandidat. If |date=DATE is specified, {{Löschantrag}} will be placed in Kategorie:Löschkandidat Oktober 2013.

all

The all parameter defines a category into which all articles should be placed.

Andere Parameter

Die Box auf der rechten Seite listet alle gültigen Parameter für die Vorlage auf. Allerdings ist es nicht empfehlenswert, dies als Kopiervorlage zu nutzen, denn so gut wie nie werden alle Parameter gleichzeitig benutzt.

Alle Parameter
{{Ambox | name = | subst = <includeonly>{{subst:substcheck}}</includeonly> | small = {{{small|}}} | type = | image = | imageright = | smallimage = | smallimageright = | class = | style = | textstyle = | sect = {{{1|}}} | issue = | talk = {{{talk|}}} | fix = | date = {{{date|}}} | text = | smalltext = | cat = | all = | cat2 = | all2 = | cat3 = | all3 = }}<noinclude> {{Dokumentation}} </noinclude>

imageright

An image on the right side of the message box may be specified using this parameter. The syntax is the same as for the image parameter, except that the default is no image.

smallimage and smallimageright

Images for the small format box may be specified using these parameters. They will have no effect unless |small=left is specified.

class

A custom CSS class to apply to the box.

style and textstyle

Optional CSS values may be defined, without quotation marks " " but with the ending semicolons ;.

• style specifies the style used by the entire message box table.
• textstyle relates to the text cell.

text and smalltext

Instead of specifying the issue and the fix it is possible to use the text parameter instead.

Customised text for the small format can be defined using smalltext.

Additional categorisation parameters

• cat2 and cat3 provide additional monthly categories; see #cat.
• all2 and all3 provide additional categories into which all articles are placed, just like #all.

Technical notes

• This meta-template uses the ambox CSS classes in MediaWiki:Common.css. The classes can also be used directly in a wikitable if special functionality is needed. See the how-to guide for that.
• If you need to use special characters in the text parameter then you need to escape them like this:

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

• The <div> tags that surround the text in the example above are usually not needed. But if the text contains line breaks then sometimes we get weird line spacing. This especially happens when using vertical dotted lists. Then use the div tags to fix that.
• 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 meta-templates are made, since wikimarkup has several drawbacks. For instance, it makes it harder to use 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.