m (Protected "Template:Documentation/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite)))
(Updating.)
Tag: sourceedit
 
Line 1: Line 1:
<noinclude>{{documentation subpage}}</noinclude>__NOTOC____NOWYSIWYG____NOEDITSECTION__
+
<noinclude>{{documentation subpage}}</noinclude>__NOWYSIWYG____NOEDITSECTION__
 
<!-- Categories for transclusion to template go at bottom of this doc. -->
 
<!-- Categories for transclusion to template go at bottom of this doc. -->
  +
{{TOCright}}
 
=== Description ===
 
=== Description ===
   
Line 57: Line 58:
 
<includeonly>
 
<includeonly>
 
Any categories for the template itself
 
Any categories for the template itself
</includeonly><noinclude>
+
</includeonly>
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
 
</pre>
 
</pre>
   
Line 66: Line 66:
 
<includeonly>
 
<includeonly>
 
[[Category:General wiki templates|{{PAGENAME}}]]
 
[[Category:General wiki templates|{{PAGENAME}}]]
 
[[Category:Template documentation| ]]
 
</includeonly><noinclude>
 
</includeonly><noinclude>
 
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 05:40, 16 September 2015

Description

Template:Documentation/doc is used to insert descriptions on template pages.

Syntax

<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>

Information icon4.svg Note: Depending on the template, you may need to insert the {{clr}} template (or complete a table/div) just before inserting <noinclude>{{documentation}}</noinclude>.

The line break is also useful as it helps prevent the documentation template "running into" previous code.

On the Template/doc page

<noinclude>{{documentation subpage}}</noinclude>
=== Description ===

'''{{FULLPAGENAME}}''' is used to do something.

=== Syntax ===

 {{tlx|templatename}}

=== Parameters ===

;{{para|foo}} : purpose of foo

=== Examples ===

 {{tlx|templatename}}

;produces…

{{templatename}}


{{tlx|templatename|<var>foo</var>}}

;produces …

{{templatename|foo}}

=== See also ===


<includeonly>
Any categories for the template itself
</includeonly>

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.

Information icon4.svg Note: The above example also uses Template:Tlx.

Community content is available under CC-BY-SA unless otherwise noted.