Subst check top/doc
Usage
Place these templates onto the main template in the following manner.
{{{{{|safesubst:}}}substchecktop|[template pagename]|subst={{{subst|}}}}}
...template code...
{{{{{|safesubst:}}}substcheckbottom|subst={{{subst|}}}}}
These templates will check the main template for substitution and give an error message if it has been accidentally transcluded by having {{substchecktop}} placed above the main template code and {{substcheckbottom}} placed below the main template code.
{{substchecktop}} 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 these templates 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.
Related templates
- {{require subst}}: Prints an error unless substituted.
- {{subst check top}}、{{subst check bottom}}: Same purpose, but used as a pair.
- {{subst only}}: For the doc of the above templates; prints a message asking for it be substituted.
- {{nosubst}}: The reverse of {{subst only}}. For the doc of templates which should not be substituted; prints a message asking for it not to be substituted.
- {{issubst}}: Returns "yes" if substituted.
- {{ifsubst}}: Forks if substituted or not.
