Template:Template Overview

Template:Template Overview is designed for use on template pages to display the general template information and the required template text for copying, pasting, and using in pages. {{#if: | {{{othernotes}}} | }}

Template

{{#switch:  {{Template Overview
|usedon=
|purpose=
|othernotes=
|template=
|display=
|parameters=
|category=
}}  |  {{Template Overview
|usedon=
|purpose=
|othernotes=
|template=
|display=
|parameters=
|category=
}}  }}

{{#if: | {{#ifeq: {{{display}}} | yes

 | ==Display==

Template loop detected: Template:Template Overview

 | ==Display==

{{{display}}}

}}

}}

Parameters

{{#switch: {{{parameters}}} | none = This template has no parameters. | | #default = }} {{#fornumargs: key | value | [[Category:{{#var: value}}|Template Overview]] }}

usedon

Usage: {{#ifeq: mandatory | mandatory | Mandatory | Optional}}
Description: The usedon parameter takes a string or strings denoting the type or types of pages this template is designed for use on. This is used to generate the middle of the template description's introductory sentence. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: | {{{othernotes}}} }}
Valid Value(s): Any string or strings.

purpose

Usage: {{#ifeq: mandatory | mandatory | Mandatory | Optional}}
Description: The purpose parameter takes a string or strings denoting what the template was designed to do or display. This is used to generate the end of the template description's introductory sentence. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: | {{{othernotes}}} }}
Valid Value(s): Any string or strings.

othernotes

Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
Description: The othernotes parameter takes a string or strings denoting any further relevant information about the usage or functionality of the template. This is used to generate a sentence or sentences after the template description's introductory sentence. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: | {{{othernotes}}} }}
Valid Value(s): Any string or strings.

template

Usage: {{#ifeq: mandatory | mandatory | Mandatory | Optional}}
Description: The template parameter takes a string or strings denoting the actual text of the template that a user must copy and paste onto a page in order to use the template. This is used to generate the "Template" section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: When entered into the Template Explanation template, the template's transclusion code must be enclosed in <nowiki></nowiki> tags, or else the template itself will be transcluded into the <pre></pre> block. | When entered into the Template Explanation template, the template's transclusion code must be enclosed in <nowiki></nowiki> tags, or else the template itself will be transcluded into the <pre></pre> block. }}
Valid Value(s): The text of the template for transclusion enclosed by <nowiki></nowiki> tags.

display

Usage: {{#ifeq: | mandatory | Mandatory | Optional}}
Description: The display parameter takes a string denoting whether an example of the template should be displayed. This is used to generate the "Display" section. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: | {{{othernotes}}} }}
Valid Value(s): "yes" to automatically display the template in its entirety, or any string or strings making up the display of the template.

parameters

Usage: {{#ifeq: mandatory | mandatory | Mandatory | Optional}}
Description: The parameters parameter takes a string denoting whether the template has parameters or not. This is used to generate either a blank space beneath the "Parameters" section if the parameter is left out or left blank, or a boilerplate message indicating that there are no parameters if a "none" is supplied. {{#if: | If this parameter is left blank or omitted, a default value of "{{{defaultvalue}}}" is used. | }} {{#if: | {{#ifeq: {{{anonymous}}} | true | This parameter, the template's only one, is an anonymous parameter, which means that no parameter name needs to be explicitly specified when using Template:Template Overview. }} }} {{#if: | {{{othernotes}}} }}
Valid Value(s): "none" or blank

Template:Template Overview

Contents