Template:Templatehelp: Difference between revisions
m (What the...) |
m (This should work) |
||
| Line 1: | Line 1: | ||
== Usage == | == Usage == | ||
{{:Help:{{PAGENAME}}}} | <includeonly>{{:Help:{{PAGENAME}}}}</includeonly> | ||
</noinclude></ | <noinclude> | ||
If you put | |||
<nowiki><noinclude>{{Templatehelp}}</noinclude></nowiki> | |||
at the end of your template text the text of a like-named page in the <code>Help:</code> namespace, e.g. the page <code>[[Help:Voweltable]]</code> will be included when you ''view'' the page <code>[[Template:Voweltable]]</code> but not when you actually ''use'' | |||
<nowiki>{{Voweltable|</nowiki>''parameters''<nowiki>}}</nowiki> | |||
in the body of another page. | |||
If the help page has not yet been created there will appear a link to it instead of its not-yet-existing content, just as with not-yet-created templates. | |||
The idea of (no)including a help page in a template page is that users can see usage instructions for a template when viewing the template page, but at the same time they won't get the whole of the usage instructions included when they use <code><nowiki>{{subst:</nowiki>''templatename''<nowiki>}}</nowiki></code>, but only the single line | |||
<nowiki><noinclude>{{Templatehelp}}</noinclude></nowiki> | |||
which can then easily be removed. Make sure to put | |||
<nowiki><noinclude>{{Templatehelpnote}}</noinclude></nowiki> | |||
at the top of your help page! (Cf. <code>[[Template:Templatehelpnote]]</code>) | |||
</noinclude> | |||
Revision as of 07:49, 15 November 2006
Usage
If you put
<noinclude>{{Templatehelp}}</noinclude>
at the end of your template text the text of a like-named page in the Help: namespace, e.g. the page Help:Voweltable will be included when you view the page Template:Voweltable but not when you actually use
{{Voweltable|parameters}}
in the body of another page.
If the help page has not yet been created there will appear a link to it instead of its not-yet-existing content, just as with not-yet-created templates.
The idea of (no)including a help page in a template page is that users can see usage instructions for a template when viewing the template page, but at the same time they won't get the whole of the usage instructions included when they use {{subst:templatename}}, but only the single line
<noinclude>{{Templatehelp}}</noinclude>
which can then easily be removed. Make sure to put
<noinclude>{{Templatehelpnote}}</noinclude>
at the top of your help page! (Cf. Template:Templatehelpnote)
