Template:Documentation/doc: Difference between revisions

Line 1:

==~~Description~~==

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

~~This template is used~~ to ~~insert descriptions on template pages.~~

-->{{#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]]!

==Syntax==

}}

~~Add~~ <code>~~<nowiki><~~noinclude~~></nowiki~~>{{t|documentation}}~~<nowiki><~~/noinclude~~></nowiki~~></code> at the end of the template page.

;Description

~~==Usage==~~

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

~~This is the normal format when used:~~

<pre>

~~TEMPLATE CODE~~<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>

{{documentation}}</noinclude>

</pre>

~~''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).''~~

~~''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.''~~

===On the Template/doc page===

~~Normally, you will want to write something like the following on the documentation page~~:

:''See also [[Template:Documentation/preload]]''

<pre>

==Description==

{{SPW|name={{subst:BASEPAGENAME}}}}

This template is used to do something.

;Description

:This template is used to do something.

==Syntax==

;Syntax

Type <code>{{t|templatename}}</code> somewhere.

:Type <code>{{t|templatename}}</code> somewhere.

;Sample output

:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...

:{{templatename|foo}}

~~==Samples==~~

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation]]</noinclude>

~~<code><nowiki>{{templatename|input}}</nowiki></code>~~

~~results in...~~

~~{{templatename|input}}~~

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation~~|{{PAGENAME}}~~]]</noinclude>

</pre>

Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or ~~other~~ sections.

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

<includeonly>[[Category:General wiki templates~~|{{PAGENAME}}~~]]</includeonly><noinclude>[[Category:Template documentation~~|{{PAGENAME}}~~]]</noinclude>

Note that the above example also uses {{t|T}}.<includeonly>

[[Category:General wiki templates]]

</includeonly><noinclude>

[[Category:Template documentation]]

</noinclude>