Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
EmperorZelos (talk | contribs) m (1 revision: Getting templates while it works) |
No edit summary |
||
Line 2: | Line 2: | ||
{{{{PAGENAME}}/doc}} | {{{{PAGENAME}}/doc}} | ||
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div> | </div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;">Visit [[Template:{{PAGENAME}}/doc]] to edit this text! ([[Template:Documentation|How does this work]]?)</div></div><noinclude></div> | ||
{{Documentation}}[[Category:Templates]][[Category: | {{Documentation}}[[Category:Templates]][[Category:Documentation]][[Category:Functionality]]</noinclude> |
Revision as of 16:25, 14 November 2012
Template Documentation (for the above Documentation template, sometimes hidden or invisible)
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>
at the end of the template page.
General usage
On the Template page
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> {{documentation}}</noinclude>
Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}}
is inserted (within the noinclude tags).
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
;Description :This template is used to do something. ;Syntax :Type <code>{{t|templatename}}</code> somewhere. ;Sample output :<code><nowiki>{{templatename|foo}}</nowiki></code> gives... :{{templatename|foo}} <includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
Note that the above example also uses the Template:T and Template:T/piece templates.
Visit Template:Documentation/doc to edit this text! (How does this work?)