Vorlage:Hilfebox/Doku

Diese Vorlage erzeugt eine, im Vergleich zur {{Hinweisbox}} schlichtere Box, die sich besser in den Fließtext einbindet, um Hinweise, Tipps und andere Texte dezent hervorzuheben.

Hinweis

Diese Vorlage ist nicht für den Einsatz im Artikelnamensraum gedacht!

Fehlerhafte Einbindung dort löst eine Wartungskategorie aus.

Verwendung[Quelltext bearbeiten]

VisualEditor

Die Vorlage ist für die Verwendung mit dem VisualEditor und TemplateData optimiert um die Handhabung einfach zu gestalten.

Kopiervorlage[Quelltext bearbeiten]

{{Hilfebox
|prio =
|typ =
|titel =
|inhalt =
}}

Einfaches Beispiel

Grundsätzlich müssen, außer inhalt gar keine Parameter angegeben werden, in den häufigsten Einsatzfällen, werden aber typ und evtl. noch prio genutzt um das Design vollständig zu bestimmen.

{{Hilfebox
|prio = hoch
|typ = Einstellungen
|inhalt = Alles Einstellungssache.
}}

erzeugt die folgende Ausgabe:

Einstellungen:Alles Einstellungssache.

TemplateData

Erzeigt eine Box für Hilfe- und Metaseiten, z.B. zum Hervorheben von Zusatzinformationen, Tipps, etc.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Boxinhalt	`inhalt` text 1	Das steht in der Box	Wikitext	erforderlich
Inhaltstyp	`typ`	Legt die Darstellung (Farbwelt fest) Vorgeschlagene Werte `Info` `Tipp` `Hilfe` `Beispiel` `Richtlinie` `Achtung` `Merke` `Sicherheit` `Einstellungen` `Link` `Wartung` Standard Info	Einzeiliger Text	vorgeschlagen
Überschrift	`titel`	Ändert die Beschreibung, wird als Fetttschrift mit Doppelpunkt eingefügt. Beispiel Vorschlag	Einzeiliger Text	optional
Breite Box	`breit`	Die Box wird über die gesamte Breite des Layouts eingefügt.	Wahrheitswert	optional
Priorität	`prio`	Legt die Wirkung der Box fest Vorgeschlagene Werte `niedrig` `mittel` `hoch` `kritisch` Standard mittel	Einzeiliger Text	optional
Ohne Titel	`keintitel`	Entfernt die Anzeige des Titels in Fettschrift. Beispiel ja	Wahrheitswert	optional
Schmale Box	`schmal`	Setzt das Schmale Layout um, die Box wird etwas dezenter dargestellt.	Wahrheitswert	veraltet entfernt mit Redesign, setzte ein schmaleres Layout ein.

Wartung[Quelltext bearbeiten]

Die Vorlage erzeugt bei Nutzung im Artikelnamensraum einen Eintrag in der Fehlerkategorie Kategorie: Vorlagenfehler/Vorlage:Hilfebox – aktuell keine (vor 7 Stunden) Aktualisieren