Template:Documentation/doc: Difference between revisions

Adding additional instructions on how exactly to use this template
(Removing TOC from the main page documentation)
(Adding additional instructions on how exactly to use this template)
 
Line 4: Line 4:
'''Only use this template between <nowiki><noinclude></nowiki> tags, or it ''will'' put the entire documentation in any page that uses the template, or create redlinks. All in all, don't try it.'''
'''Only use this template between <nowiki><noinclude></nowiki> tags, or it ''will'' put the entire documentation in any page that uses the template, or create redlinks. All in all, don't try it.'''


With <nowiki><includeonly></nowiki> tags to hide the raw code:
<pre><includeonly>Template code goes here</includeonly><noinclude>{{Documentation}}</noinclude></pre>
Without <nowiki><includeonly></nowiki> tags, when you might want to show the template's default output:
<pre>Template code goes here<noinclude>{{Documentation}}</noinclude></pre>
Or, if you want a new line separation:
<pre>Template code goes here<!--
--><noinclude>{{Documentation}}</noinclude></pre>
===Parameters===
Use the CONTENT parameter (aliased as 'Content' and 'content' for ease of use) to simply display whatever its value (which can be any wikitext) in the documentation format.
Use the CONTENT parameter (aliased as 'Content' and 'content' for ease of use) to simply display whatever its value (which can be any wikitext) in the documentation format.