Jump to content

Template:Documentation/doc: Difference between revisions

From SeptemWiki
No edit summary
No edit summary
Line 1: Line 1:
This template is used to document templates, including itself.
This template is used to display the documentation for templates, including itself.


To use this template, include
To write documentation for the template
 
Template:Foobar
 
edit the document
 
Template:Foobar/doc
 
Then to use this template, include


  <nowiki><noinclude>{{Documentation}}</noinclude></nowiki>
  <nowiki><noinclude>{{Documentation}}</noinclude></nowiki>


at the bottom of the template or module page.
at the bottom of the template itself.
 
So Template:Foobar looks like:
 
(... all the actual template code ...)
  <nowiki><noinclude>{{Documentation}}</noinclude></nowiki>
 
And Template:Foobar/doc looks like:
 
Here's some helpful instructions on using the Foobar template ...

Revision as of 18:13, 18 March 2016

This template is used to display the documentation for templates, including itself.

To write documentation for the template

Template:Foobar

edit the document

Template:Foobar/doc

Then to use this template, include

<noinclude>{{Documentation}}</noinclude>

at the bottom of the template itself.

So Template:Foobar looks like:

(... all the actual template code ...)
 <noinclude>{{Documentation}}</noinclude>

And Template:Foobar/doc looks like:

Here's some helpful instructions on using the Foobar template ...