Template:Documentation/doc: Difference between revisions

→‎Usage: better documentation of documentation :)
(Undo revision 3493046 by Bfdifan2006 (talk) This is itself a documentation template. It should be in that category. There is no need to remove categories from templates, it just adds unneeded complexity.)
Tag: Undo
(→‎Usage: better documentation of documentation :))
 
Line 7: Line 7:


==Usage==
==Usage==
To include {{template|Documentation}} on a template page, place at the bottom of the template page, directly after the last line of code, between <code><nowiki><noinclude>...</noinclude></nowiki></code> tags:
To include {{template|Documentation}} on a template page, place it at the bottom of the template page, directly after the last line of code, between <code><nowiki><noinclude>...</noinclude></nowiki></code> tags:


<pre>
<pre>
Line 15: Line 15:
</pre>
</pre>


For templates that are no longer used, add <code>|old=yes</code> to include the {{template|OldTemplate}} template:
The documentation can then be added to the /doc subpage of the template. For example, this documentation for {{template|Documentation}} is located at [[Template:Documentation/doc]].
 
Optionally, should the location of the appropriate documentation be located elsewhere, it can be added to the <code>Documentation</code> template as an optional parameter:
 
<pre>
~last line of your template code~<noinclude>
{{Documentation|Help:Color templates}}
</noinclude>
</pre>
 
For templates that are no longer used, you can add <code>|old=yes</code> to include the {{template|OldTemplate}} template as well:


<pre>
<pre>
Line 22: Line 32:
</noinclude>
</noinclude>
</pre>
</pre>
The documentation can then be added to the /doc subpage of the template. For example, this documentation for {{template|Documentation}} is located at [[Template:Documentation/doc]].


<noinclude>[[Category:Documentation templates]]</noinclude>
<noinclude>[[Category:Documentation templates]]</noinclude>