Difference between revisions of "Template:Doc/doc"

From Cantr II Wiki
Jump to: navigation, search
Line 5: Line 5:
 
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:
 
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>
+
<pre><nowiki>
 
  <noinclude>{{Doc}}</noinclude>
 
  <noinclude>{{Doc}}</noinclude>
</pre>
+
</nowiki></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:23, 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.