Difference between revisions of "Template:Doc/doc"
From Cantr II Wiki
| Line 3: | Line 3: | ||
== Usage == | == Usage == | ||
| − | Put <tt><nowiki>{{Doc}}</nowiki></tt> at the end of the template, enclosed between tags <tt>noinclude</tt>. Without spaces or line breaks before. | + | Put <tt><nowiki>{{Doc}}</nowiki></tt> at the end of the template, enclosed between tags <tt>noinclude</tt>. Without spaces or line breaks before. Example: |
| + | |||
| + | <pre> | ||
| + | <noinclude>{{Doc}}</noinclude> | ||
| + | </pre> | ||
To function properly there must be a page called <tt>x/doc</tt>. Replacing "x" by the full name of the template. For example, the name of this template is <tt>Doc</tt>, but the full name of this template is <tt>Template:Doc</tt>. Therefore, the documentation of this template should be on the page <tt>Template:Doc/doc</tt>. | To function properly there must be a page called <tt>x/doc</tt>. Replacing "x" by the full name of the template. For example, the name of this template is <tt>Doc</tt>, but the full name of this template is <tt>Template:Doc</tt>. Therefore, the documentation of this template should be on the page <tt>Template:Doc/doc</tt>. | ||
Revision as of 07:22, 21 February 2010
{{Doc}}} provides an easy way to add documentation for a template.
Usage
Put {{Doc}} at the end of the template, enclosed between tags noinclude. Without spaces or line breaks before. Example:
<noinclude>{{Doc}}</noinclude>
To function properly there must be a page called x/doc. Replacing "x" by the full name of the template. For example, the name of this template is Doc, but the full name of this template is Template:Doc. Therefore, the documentation of this template should be on the page Template:Doc/doc.
