Vorlage:Dokumentation/Subst/Doku

Vorlage als Hinweis für die Substitution einer Seite (meist Vorlagen), die als Dokumentationsvorlage genutzt werden soll. Sie erzeugt einen entsprechenden Badge (standard) zur Kennzeichnung oder eine Infobox als Langversion.

TemplateData

Diese Vorlage dient als Hinweis für die Substitution und erzeugt einen entsprechenden Badge (standard) zur Kennzeichnung oder eine Infobox als Langversion.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
Hinweisstufe	subst 1	Kategorisierung, ob die Substitution möglich oder gefordert wird. Entscheidet über das Design, Text und Kategorisierung. Vorgeschlagene Werte kann soll muss darf nicht Beispiel kann	Einzeiliger Text	erforderlich
Ausgabemodus	mode	Legt fest ob das Badge (standard) oder die Informationsbox als Langversion angezeigt wird. Standard badge	Einzeiliger Text	vorgeschlagen
Demo-Modus	demo 2	Deaktiviert die automatische Kategorisierung	Wahrheitswert	optional

Erläuterung Hinweisstufe

Der Paramterter subst bzw. 1 ist maßgeblich für den Inhalt und die Auto-Kategoriserung, er sollte wie folgt gewählt werden:

• kann: Die Substitution ist optional, aber empfohlen.
• soll: Die Substitution ist bevorzugt.
• muss: Die Substitution ist zwingend notwendig.
• darf nicht: Die Substitution ist verboten.

Teil der Dokumentationsvorlage

Diese Vorlage wird direkt durch die Vorlage {{Dokumentation}} benutzt und kann dort über den Parameter subst= angesteuert werden. Die Vorgabewerte entsprechen denen des Parameters 1.

Auto-Kategorisierung

Die Vorlage sortiert die Seite, sofern der Parameter demo nicht gesetzt wurde, automatisch in eine der Kategorien ein:

Substitution empfohlen (leer)

Substitution erforderlich (leer)

Substitution möglich (leer)

Substitution nicht erlaubt (leer)

Alias / Weiterleitung

Die Vorlage kann auch unter dem Alias {{Substitutionshinweis}} aufgerufen werden, dies ist historisch begründet und dient dem Benutzerkomfort. Hierzu besteht eine Weiterleitung auf diese Seite.

Beispiele

Badges

Substitution empfohlen

{{Substitutionshinweis|kann}}

Substitution erforderlich

{{Substitutionshinweis|muss}}

Substitution nicht möglich

{{Substitutionshinweis|darf nicht}}

Infobox

Substition empfohlen

{{Substitutionshinweis|subst=kann|mode=box}}

Substitution erforderlich

{{Substitutionshinweis|subst=muss|mode=box}}

Substitution nicht möglich

{{Substitutionshinweis|subst=darf  nicht|mode=box}}

Siehe auch

• Hilfe-Inhalt Substution – technische Informationen zum Thema
• Volagendokumentation – Hilfeseite zur Vorlagendokumentation
• Vorlage:Dokumentation – Hauptvorlage