127.0.0.1 at 20:16, 30 September 2016

2016-09-30T20:16:12Z

New page

{{#ifexist: Template:Documentation/preload |  | :Please copy <nowiki>{{Documentation}}</nowiki>'s preload template from [[w:c:templates:Template:Documentation/preload]] to [[Template:Documentation/preload]]!}}{{#ifexist: Template:T |  | :Please copy <nowiki>{{T}}</nowiki> from [[w:c:templates:Template:T]] to [[Template:T]]!}}{{#ifexist: Template:T/doc |  | :Please copy <nowiki>{{T}}</nowiki>'s documentation from [[w:c:templates:Template:T/doc]] to [[Template:T/doc]]!}}{{#ifexist: Template:Tocright |  | :Please copy <nowiki>{{Tocright}}</nowiki> from [[w:c:templates:Template:Tocright]] to [[Template:Tocright]]!}}{{#ifexist: Template:Tocright/doc |  | :Please copy <nowiki>{{Tocright}}</nowiki>'s documentation from [[w:c:templates:Template:Tocright/doc]] to [[Template:Tocright/doc]]!}}{{#ifexist: Template:SPW |  | :Please copy <nowiki>{{SPW}}</nowiki> from [[w:c:templates:Template:SPW]] to [[Template:SPW]]!}}{{#ifexist: Template:SPW/doc |  | :Please copy <nowiki>{{SPW}}</nowiki>'s documentation from [[w:c:templates:Template:SPW/doc]] to [[Template:SPW/doc]]!

}}
{{SPW|is newer|name=Documentation}}
;Description
:This template is used to insert documentation on template pages.
;Syntax
:Type <code><noinclude>{{t|documentation}}</noinclude></code> at the end of the template page.

==General usage==
===On the Template page===
<pre>
Template code<noinclude>
{{documentation}}
</noinclude>
</pre>

===On the Template/doc page===
<pre>
{{SPW|name={{subst:BASEPAGENAME}}}}
;Description
:This template is used to do something.
;Dependencies:
:* Uses (some CSS, JS, file, or other template).
;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]]
</noinclude>
</pre>

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 {{t|T}}.

== Dependencies ==
:*[[Template:Documentation/preload]]
:*[[Template:Documentation/preload-sandbox]]
:*[[Template:Documentation/preload-testcases]]
:*Site-wide CSS:
<syntaxhighlight lang="css">.template-documentation .color1,
#bodyContent .template-documentation .color1 a,
#bodyContent .template-documentation .color1 a.external
{
background-color:#36C;
color:white;
}</syntaxhighlight>
:*[[Template:T]] + [[Template:T/doc]]
:*[[Template:Tocright]] + [[Template:Tocright/doc]]
:*[[Template:SPW]] + [[Template:SPW/doc]]
<includeonly>
[[Category:General wiki templates]]

[[ja:テンプレート:Documentation]]
[[zh:Template:Documentation]]
</includeonly><noinclude>
[[Category:Template documentation]]

[[ja:テンプレート:Documentation/doc]]
[[zh:Template:Documentation/doc]]
</noinclude>

Template:Documentation/doc - Revision history

127.0.0.1 at 20:16, 30 September 2016