Difference between revisions of "Template:Doc/doc"

From Cantr II Wiki
Jump to: navigation, search
(See also)
 
(9 intermediate revisions by 2 users not shown)
Line 1: Line 1:
'''<nowiki>{{Doc}}}</nowiki>''' provides an easy way to add documentation for a template.
+
[[Template:Doc|<nowiki>{{Doc}}</nowiki>]] provides an easy way to add documentation for a template.
  
 
== 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. 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.
  
<pre><nowiki>
+
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>.
<noinclude>{{Doc}}</noinclude>
 
</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>.
+
== See also ==
 +
* [[Template:Doc (es)|<nowiki>{{Doc (es)}}</nowiki>]] - Versión española (Spanish version)
 +
* [[Template:Doc (Sv)|<nowiki>{{Doc (Sv)}}</nowiki>]] - (Svensk Version)
 +
* [[Template:Doc (fr)|<nowiki>{{Doc (fr)}}</nowiki>]] - Version française (French version)
 +
 
 +
<noinclude>[[Category:Documentation|{{PAGENAME}}]]
 +
</noinclude>

Latest revision as of 14:55, 5 November 2012

{{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.

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.

See also