Difference between revisions of "Template:Infobox Template/purpose"

Revision as of 17:52, 28 May 2014

This template offers a multiple choice for specifying the purpose of another template. It can also automatically categorize the page of that template under the category for that purpose.

Parameters

1. The selected purpose from the following values (no parameter name and values are case insensitive):
   • formatting
   • infobox
   • messagebox
   • website
   • any other (non)empty value defaults to: unknown

• nocat: Whether or not to suppress categorization under the chosen category (defaults to false, which means auto categorization).

Note: more category values may be added depending on the purpose of any newly added template, provided the category pages in question are also created and organized into a logical category structure.

Syntax

{{Infobox Template/purpose|value}}

Examples

Any of the above values may be used like this:

{{Infobox Template/purpose|formatting}}
{{Infobox Template/purpose|infobox}}
{{Infobox Template/purpose|messagebox}}
{{Infobox Template/purpose|website}}

Formatting ^{[list all]}

Infobox ^{[list all]}

Messagebox ^{[list all]}

Website ^{[list all]}

The case of the value is not important:

{{Infobox Template/purpose|forMattING}}

Formatting ^{[list all]}

You may leave the "purpose" undefined (which would raise the Templates of unknown purpose maintenance task) by not specifying any valid value, so these all have the same result:

{{Infobox Template/purpose}}
{{Infobox Template/purpose|}}
{{Infobox Template/purpose|documentation}}
{{Infobox Template/purpose|feels like destiny}}
{{Infobox Template/purpose|purr-pose}}
{{Infobox Template/purpose|not a cat}}
{{Infobox Template/purpose|yes}}

unknown ^{[list all]}

The nocat parameter may be used to suppress automatic categorization like this (any value will do):

{{Infobox Template/purpose|formatting|nocat=true}}

This would render the same result as the first example above, but would not automatically categorize under Category:Formatting templates. This feature works both on valid values and the maintenance task mentioned above.