Template:Documentation/doc: Difference between revisions

Latest revision as of 17:00, 13 December 2012

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

}} Template:SPW

Description: This template is used to insert documentation on template pages.
Syntax: Type <noinclude>{{#ifeq:|code|}}{{{{#if:|{{{prefix}}}:}}documentation{{#if:||<{{{2}}}>}}{{#if:||<{{{3}}}>}}{{#if:||<{{{4}}}>}}{{#if:||<{{{5}}}>}}{{#if:||<{{{6}}}>}}{{#if:||<{{{7}}}>}}{{#if:||<{{{8}}}>}}{{#if:||<{{{9}}}>}}{{#if:||<{{{10}}}>}}{{#if:||<{{{11}}}>}}{{#if:||<{{{12}}}>}}{{#if:||<{{{13}}}>}}{{#if:||<{{{14}}}>}}{{#if:||<{{{15}}}>}}{{#if:||<{{{16}}}>}}{{#if:||<{{{17}}}>}}{{#if:||<{{{18}}}>}}{{#if:||<{{{19}}}>}}{{#if:||<{{{20}}}>}}{{#if:||<{{{21}}}>}}}}{{#ifeq:|code|}}</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>

On the Template/doc page

See also Template:Documentation/preload

{{SPW|name={{subst:BASEPAGENAME}}}}
;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 {{#ifeq:|code|}}{{{{#if:|{{{prefix}}}:}}T{{#if:||<{{{2}}}>}}{{#if:||<{{{3}}}>}}{{#if:||<{{{4}}}>}}{{#if:||<{{{5}}}>}}{{#if:||<{{{6}}}>}}{{#if:||<{{{7}}}>}}{{#if:||<{{{8}}}>}}{{#if:||<{{{9}}}>}}{{#if:||<{{{10}}}>}}{{#if:||<{{{11}}}>}}{{#if:||<{{{12}}}>}}{{#if:||<{{{13}}}>}}{{#if:||<{{{14}}}>}}{{#if:||<{{{15}}}>}}{{#if:||<{{{16}}}>}}{{#if:||<{{{17}}}>}}{{#if:||<{{{18}}}>}}{{#if:||<{{{19}}}>}}{{#if:||<{{{20}}}>}}{{#if:||<{{{21}}}>}}}}{{#ifeq:|code|}}.

@@ Line 1: / Line 1: @@
-{{SPW|is newer|name=T}}
+{{#ifexist: Template:Documentation/preload | <!-- nothing; preload already copied --> | :<strong class="error">Please copy <nowiki>{{Documentation}}</nowiki>'s preload template from [[w:c:templates:Template:Documentation/preload]] to [[Template:Documentation/preload]]!</strong>}}<!--
+-->{{#ifexist: Template:T | <!-- nothing; T already copied/exists --> | :<strong class="error">Please copy <nowiki>{{T}}</nowiki> from [[w:c:templates:Template:T]] to [[Template:T]]!</strong>}}<!--
+-->{{#ifexist: Template:T/doc | <!-- nothing; T's documentation already copied/exists --> | :<strong class="error">Please copy <nowiki>{{T}}</nowiki>'s documentation from [[w:c:templates:Template:T/doc]] to [[Template:T/doc]]!</strong>}}<!--
+-->{{#ifexist: Template:Tocright | <!-- nothing; Tocright already copied/exists --> | :<strong class="error">Please copy <nowiki>{{Tocright}}</nowiki> from [[w:c:templates:Template:Tocright]] to [[Template:Tocright]]!</strong>}}<!--
+-->{{#ifexist: Template:Tocright/doc | <!-- nothing; Tocright's documentation already copied/exists --> | :<strong class="error">Please copy <nowiki>{{Tocright}}</nowiki>'s documentation from [[w:c:templates:Template:Tocright/doc]] to [[Template:Tocright/doc]]!</strong>}}<!--
+-->{{#ifexist: Template:SPW | <!-- nothing; SPW already copied --> | :<strong class="error">Please copy <nowiki>{{SPW}}</nowiki> from [[w:c:templates:Template:SPW]] to [[Template:SPW]]!</strong>}}<!--
+-->{{#ifexist: Template:SPW/doc | <!-- nothing; SPW's documentation already copied --> | :<strong class="error">Please copy <nowiki>{{SPW}}</nowiki>'s documentation from [[w:c:templates:Template:SPW/doc]] to [[Template:SPW/doc]]!</strong>
+}}<!-- you can remove this line and everything above it if you don't see any big bold red text -->
+{{SPW|is newer|name=Documentation}}
 ;Description
-:A template link with a variable number of example parameters (0-20), which can be used to show example inputs.
+:This template is used to insert documentation on template pages.
 ;Syntax
-:{{t|t|parameter1|parameter2|parameter3|parameter4|...|parameter20|8=prefix=...}}
+:Type <code>&lt;noinclude>{{t|documentation}}&lt;/noinclude></code> at the end of the template page.
-;Sample code
-:<code><nowiki>{{t|welcome}}</nowiki></code> gives...
+==General usage==
-:{{t|welcome}}
+===On the Template page===
-:<code><nowiki>{{t|welcome|Item1|Item2|Item3|Item4|Item5|...}}</nowiki></code> gives...
+<pre>
-:{{t|welcome|Item1|Item2|Item3|Item4|Item5|...}}
+Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
-:<code><nowiki>{{t|welcome|2=param1=Item1}}</nowiki></code> gives...
+{{documentation}}</noinclude>
-:{{t|welcome|2=param1=Item1}}
+</pre>
-:<code><nowiki>{{t|welcome|prefix=subst}}</nowiki></code> gives...
-:{{t|welcome|prefix=subst}}
+===On the Template/doc page===
-:<code><nowiki>{{t|welcome|style=code}}</nowiki></code> gives...
+:''See also [[Template:Documentation/preload]]''
-:{{t|welcome|style=code}}
+<pre>
-;See also
+{{SPW|name={{subst:BASEPAGENAME}}}}
-* {{t|t2}}
+;Description
-* {{t|s}}<includeonly>
+:This template is used to do something.
-[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>
+;Syntax
-[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+:Type <code>{{t|templatename}}</code> somewhere.
+;Sample output
+:<code>&lt;nowiki>{{templatename|foo}}</nowiki></code> gives...
+:{{templatename|foo}}
+<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 further usage information sections.
+Note that the above example also uses {{t|T}}.<includeonly>
+[[Category:General wiki templates|{{PAGENAME}}]]
+</includeonly><noinclude>
+[[Category:Template documentation|{{PAGENAME}}]]
+</noinclude>

Template:Documentation/doc: Difference between revisions

Latest revision as of 17:00, 13 December 2012

General usage

On the Template page

On the Template/doc page

Navigation menu

Search