Difference between revisions of "Template:Maintenance task"
J McKalling (Talk | contribs) m |
J McKalling (Talk | contribs) m |
||
| Line 8: | Line 8: | ||
#ifeq: {{{nocat|false}}} | false |{{ | #ifeq: {{{nocat|false}}} | false |{{ | ||
#vardefine: maintenance_message | {{#var:maintenance_message|}}<li>[[:Category:{{{category|}}}|{{{category|}}}]]{{ | #vardefine: maintenance_message | {{#var:maintenance_message|}}<li>[[:Category:{{{category|}}}|{{{category|}}}]]{{ | ||
| + | #if: {{{doclink|}}} | ||
| + | | ([[Template:{{{doclink}}}|doc]])}}{{ | ||
#if: {{{reason|}}} | #if: {{{reason|}}} | ||
|: {{{reason}}}}}</li>}} | |: {{{reason}}}}}</li>}} | ||
| Line 16: | Line 18: | ||
* '''category''': The category name to use for the [[Template:Categorizer]] and maintenance task message (case sensitive, mandatory) | * '''category''': The category name to use for the [[Template:Categorizer]] and maintenance task message (case sensitive, mandatory) | ||
* '''catlabel''', '''article''', '''label''' and '''display''': Additional parameters for the [[Template:Categorizer]]. | * '''catlabel''', '''article''', '''label''' and '''display''': Additional parameters for the [[Template:Categorizer]]. | ||
| − | * '''reason''': Details about the issue that this task should solve (case sensitive, defaults to displaying | + | * '''reason''': Details about the issue that this task should solve (case sensitive, defaults to displaying no reason) |
| + | * '''doclink''': Documentation page containing the explanation for this task (case sensitive, defaults to displaying no doclink) | ||
* '''nocat''': Whether or not to suppress categorization under '''''category''''' (defaults to false, which means auto categorization). | * '''nocat''': Whether or not to suppress categorization under '''''category''''' (defaults to false, which means auto categorization). | ||
Revision as of 12:30, 13 December 2012
This template is a way of categorizing an article under a maintenance category, and at the same time showing a message explaining the issue. Use this template as the default option for other article categorizers.
Parameters
- category: The category name to use for the Template:Categorizer and maintenance task message (case sensitive, mandatory)
- catlabel, article, label and display: Additional parameters for the Template:Categorizer.
- reason: Details about the issue that this task should solve (case sensitive, defaults to displaying no reason)
- doclink: Documentation page containing the explanation for this task (case sensitive, defaults to displaying no doclink)
- nocat: Whether or not to suppress categorization under category (defaults to false, which means auto categorization).
Note: This template does not actually show the maintenance message itself, but stores it in a variable that is handled by the infobox of the article. It does show the result of the categorizer.
Syntax
{{maintenance task
|category=
|catlabel=
|article=
|label=
|reason=
|display=
|nocat=
}}
Examples
Common use includes the category, label and reason parameters:
{{maintenance task
|category=Characters of unknown magic
|label=unknown
|reason=The '''magical''' parameter for the [[Template:Infobox Character|character infobox]] isn't specified
}}
- unknown [list all]
The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others):
This article raises some maintenance tasks. You may help by solving the following:
|
You may leave "reason" undefined by not specifying a value, which would only show a link to the category in the maintenance message like this:
{{maintenance task|category=Characters of unknown magic|label=unknown}}
- unknown [list all]
The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others):
| This article raises some maintenance tasks. You may help by solving the following: |
