Template:Templatehelp: Difference between revisions
m (Lets see...) |
m (Nah...) |
||
| Line 1: | Line 1: | ||
<includeonly | <includeonly>{{:Help:{{PAGENAME}}}}</includeonly> | ||
<noinclude> | |||
== Usage == | |||
If you put | If you put | ||
| Line 22: | Line 21: | ||
<nowiki><noinclude>{{Templatehelp}}</noinclude></nowiki> | <nowiki><noinclude>{{Templatehelp}}</noinclude></nowiki> | ||
which can then easily be removed. Make sure to put | which can then easily be removed. I wish you shouldn't have to put <nowiki>{{Templatehelp}} inside <noinclude>...</noinclude></nowiki> tags, but there seems to be no way to avoid that. | ||
Make sure to put | |||
<nowiki><noinclude>{{Templatehelpnote}}</noinclude></nowiki> | <nowiki><noinclude>{{Templatehelpnote}}</noinclude></nowiki> | ||
Revision as of 08:29, 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.
For example 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. I wish you shouldn't have to put {{Templatehelp}} inside <noinclude>...</noinclude> tags, but there seems to be no way to avoid that.
Make sure to put
<noinclude>{{Templatehelpnote}}</noinclude>
at the top of your help page! (Cf. Template:Templatehelpnote)
