Difference between revisions of "Template:Doc/Template"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Add Template:TemplateCase usage)
m (…a really smart move)
Line 83: Line 83:
 
}}
 
}}
  
{{TemplateCase||[[Category: Templates|{{uc:{{PAGENAME}}}}]]}}</includeonly><noinclude>{{TOC|none}}
+
{{#ifeq: {{uc:{{FULLPAGENAME}}}} | TEMPLATE:DOC/TEMPLATE | | [[Category: Templates|{{uc:{{PAGENAME}}}}]] }}</includeonly><noinclude>{{TOC|none}}
 
Documents and categorises a [[:Category:Templates|Template]]. To be used within <tt><no<nowiki/>include></no<nowiki/>include></tt> tags, e.g:
 
Documents and categorises a [[:Category:Templates|Template]]. To be used within <tt><no<nowiki/>include></no<nowiki/>include></tt> tags, e.g:
 
  <include<nowiki/>only>'''*template's code*'''</include<nowiki/>only><no<nowiki/>include>{{<nowiki/>'''Doc/Template'''
 
  <include<nowiki/>only>'''*template's code*'''</include<nowiki/>only><no<nowiki/>include>{{<nowiki/>'''Doc/Template'''

Revision as of 01:54, 15 January 2021

Documents and categorises a Template. To be used within <noinclude></noinclude> tags, e.g:

<includeonly>*template's code*</includeonly><noinclude>{{Doc/Template
| ...
}}
</noinclude>

Usage

{{Doc/Template|name|descr|param#|descr#|example#|result#}}

  • name: (Optional, default {{PAGENAME}}) template name
  • descr: template text description
  • param#: (# = number range 1..10) parameter name
  • descr#: (# = number range 1..10) parameter description
  • example#: (# = number range 1..5) mediawiki code example - to be wrapped between nowiki tags! (e.g <nowiki>{{Doc/Template}}</nowiki>)
  • result#: (# = number range 1..5) mediawiki code result - identical to example#, less nowiki tags (e.g {{Doc/Template}})
Examples
Code Result
{{Doc/Template}}

This template is used on these pages.

Usage

{{Doc/Template}}



{{Doc/Template
| name = MyTemplate
| descr = Template description
| param1 = parameter1
| descr1 = this is the first parameter
| param2 = parameter2
| descr2 = (Optional) this is the second parameter
}}
Template description

This template is used on these pages.

Usage

{{MyTemplate|parameter1|parameter2}}

  • parameter1: this is the first parameter
  • parameter2: (Optional) this is the second parameter



{{Doc/Template
| name = MyTemplate
| descr = Template description
| param1 = parameter1
| descr1 = this is the first parameter
| param2 = parameter2
| descr2 = (Optional) this is the second parameter
| example1 = <nowiki>{{MyTemplate|Hello there!}}</nowiki>
| result1 = {{MyTemplate|Hello there!}}
}}
Template description

This template is used on these pages.

Usage

{{MyTemplate|parameter1|parameter2}}

  • parameter1: this is the first parameter
  • parameter2: (Optional) this is the second parameter
Examples
Code Result
{{MyTemplate|Hello there!}} Hello there!