Template:Documentation/doc

From wiki.jriver.com
Jump to navigation Jump to search

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

}} {{

 #ifeq: Template | Template 
 | {{
   #ifeq: {{ #if:  | {{{reusedemo}}} | Wiki.jriver.com }} | Wikia Templates
   | {{
     #ifeq: Documentation | {{ #ifeq: {{ #titleparts: Documentation/doc | 1 | -1 }} | doc | Documentation | Documentation/doc }}
     | 
     | :Error: {{{name}}} parameter is unused or incorrect! Please replace {{SPW{{ #if: is newer | |is newer }}{{ #ifeq: Documentation | ¬ | | |name=Documentation }}}} with {{SPW{{ #if: is newer | |is newer }}|name=Documentation}}.
}}:{{ #switch: is newer | is on = This template or a similar one is on the Starter Pages Wikia, whence it is incorporated in every new Wikia site and can be copied to older ones. | is newer = This template is newer than a similar one on the Starter Pages Wikia. This template may therefore have bug fixes or improvements when compared to the older version.{{ #ifeq: {{ #titleparts: Documentation/doc | 1 | 1 }} | SPW | | {{ #ifeq: {{ #titleparts: Documentation/doc | 1 | -1 }} | doc | | }} }} | is not on = This template is not on the Starter Pages Wikia. It can be copied to other Wikia sites, but it is not included on any by default.{{ #ifeq: {{ #titleparts: Documentation/doc | 1 | 1 }} | SPW | | {{ #ifeq: {{ #titleparts: Documentation/doc | 1 | -1 }} | doc | | }} }} | #default = Editors have not checked whether this template is or is not on the Starter Pages Wikia.{{ #ifeq: {{ #titleparts: Documentation/doc | 1 | 1 }} | SPW | | {{ #ifeq: {{ #titleparts: Documentation/doc | 1 | -1 }} | doc | | }} }} }}

|

   {{ #ifeq: {{ #titleparts: Documentation/doc | 1 | -1 }} | doc |  | }}
 }}

}}

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[edit]

On the Template page[edit]

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

On the Template/doc page[edit]

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