Vorlage:Subst check top/Doku

Usage

Place this template and {{substcheckbottom}} onto the main template in the following manner.

{{{{{|safesubst:}}}substchecktop|[template pagename]|subst={{{subst|}}}}}

...template code...

{{{{{|safesubst:}}}substcheckbottom|subst={{{subst|}}}}}

This template, along with {{substcheckbottom}}, will check the main template for substitution and give an error message if it has been accidentally transcluded by having this template placed above the main template code and {{substcheckbottom}} placed below the main template code.

This template takes in an input for the main template name as a parameter. This is shown above as [template pagename]. This parameter should be entered so that the default error message refers to the correct main template. This default error message can be optionally replaced by a custom error message by using the message parameter. This parameter accepts templates and it is recommended that a message template be used for long messages to keep the parameter value short. {{substcheckbottom}} takes in an input for categories. This is so that unsubstituted versions of the main template can still categorise pages. This can be done by adding the name of the category to the category parameter. There is also a sort parameter to allow category sorting.

Both this template and {{substcheckbottom}} use subst={{{subst|}}} as one of the parameters. This allows optional transclusion for demonstration purposes by setting the subst parameter on the main template to nosubst.

Verwandte Vorlagen

Liste von Substitutions-Hilfsvorlagen

• {{require subst}}: Gibt eine Fehlermeldung aus, wenn eine Vorlage nicht substituiert wird.
  • {{subst check top}}、{{subst check bottom}}: Gleicher Zweck, aber als Paar verwendet.
  • {{subst only}}: Hinweistext, für obige Vorlagen, der um eine Vorlagenersetzung bittet.
  • {{nosubst}}: Das Gegenteil {{subst only}}. Bitte darum, nicht zu ersetzen.
  • {{added by substitution}}: Setzt in einer Vorlegendokumentation einen Hinweis, dass die Vorlage nicht direkt eingebunden wird, sondern durch Ersetzung mittels einer anderen Vorlage in den Artikel aufgenommen wird.
• {{issubst}}: Gibt ein yes zurück, wenn eine Vorlage bei der Einbindung nicht ersetzt wurde.
• {{ifsubst}}: Verzweigt die Abarbeitung, je nachdem, ob ersetzt wurde oder nicht.