UtterAccess HomeUtterAccess Wiki

Welcome Guest ( Log In | Register )

Edit Discussion
> Manual:Template Documentation    

Using Template Documentation

Create the actual text for a documentation by making a page at:

Template:YourTemplateName/doc

Use the boilerplate text below to for a uniform layout - sorry there's no template for this yet, not sure how to handle a parameter array with templates in our version.

When the template doc page is created, include the following in your template, enclosed somewhere in a set of <noinclude></noinclude> tags:

{{documentation}}

Boilerplate Text for Documentation Pages

Yes, this following was very easy to code so it shows up correctly, thank you.

Copy and Paste the following text for a new Template Documentation Page
Replace the words in green with your template-specific text


'''CALLABLE KEYWORDS:'''<br>
<tt><nowiki>TemlateName</nowiki></tt><br>
<tt><nowiki>templateName</nowiki></tt><br>


'''PURPOSE:'''<br>
Brief template description

'''PARAMETERS:'''<br>
''none''

'''USAGE:''' <br>
<tt><nowiki>{{TemplateName<nowiki><br></nowiki>
|param=value<nowiki><br></nowiki>
}}</nowiki></tt>

'''SEE ALSO:'''<br>
Links and other Resources here

'''RELATED TEMPLATES:'''<br>
''none''

'''SOURCE:'''<br>
<!-- BEGIN SOURCE --><tt><nowiki>
Your Template Source Code Here
<!-- END SOURCE -->

Edit Discussion
Thank you for your support!
This page has been accessed 3,844 times.  This page was last modified 16:50, 16 April 2011 by Jack Leach.   Disclaimers