Difference between revisions of "Template:Maintenance task"
From Twinsuniverse
J McKalling (Talk | contribs) m |
J McKalling (Talk | contribs) (added infobox) |
||
| (4 intermediate revisions by the same user not shown) | |||
| 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>}} | ||
| − | }}</includeonly><noinclude> | + | }}</includeonly><noinclude>{{Infobox Template |
| − | This template is a way of categorizing an article under a maintenance category, | + | |purpose=infobox |
| + | |singletag=no | ||
| + | |multiline=optional | ||
| + | |gamerelated=no | ||
| + | |suppressible=recursively | ||
| + | |choice=none | ||
| + | |cat1=!''by parameter '''category''''' | ||
| + | |var1= | ||
| + | }} | ||
| + | |||
| + | This template is a way of categorizing an article under a maintenance category, for a specified reason. When used as an argument for the {{templatelink|maintenance}} messagebox, this template will also render in it. When an article does not use any or an incorrect value for proper categorization, use this template to categorize it as fallback option. This will automatically categorize articles when values are not correctly specified. | ||
==Parameters== | ==Parameters== | ||
* '''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). | ||
| − | '''''Note''': This template does not actually show the maintenance message itself, but stores it in a variable that is handled by the | + | '''''Note''': This template does not actually show the maintenance message itself, but stores it in a variable that is handled by the {{templatelink|maintenance}} messagebox of the article, which is created by infoboxes. It does show the result of the categorizer where this template is called.'' |
==Syntax== | ==Syntax== | ||
| Line 36: | Line 49: | ||
Common use includes the '''category''', '''label''' and '''reason''' parameters: | Common use includes the '''category''', '''label''' and '''reason''' parameters: | ||
<nowiki>{{maintenance task | <nowiki>{{maintenance task | ||
| − | |category=Characters of unknown | + | |category=Characters of unknown magicality |
|label=unknown | |label=unknown | ||
|reason=The '''magical''' parameter for the [[Template:Infobox Character|character infobox]] isn't specified | |reason=The '''magical''' parameter for the [[Template:Infobox Character|character infobox]] isn't specified | ||
}}</nowiki> | }}</nowiki> | ||
| − | :{{categorizer|category=Characters of unknown | + | :{{categorizer|category=Characters of unknown magicality|label=unknown|nocat=true}} |
The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others): | The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others): | ||
| − | {{maintenance|tasks=<li>[[:Category:Characters of unknown | + | {{maintenance|tasks=<li>[[:Category:Characters of unknown magicality|Characters of unknown magicality]]: The '''magical''' parameter for the [[Template:Infobox Character|character infobox]] isn't specified</li>}} |
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: | 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: | ||
| − | <nowiki>{{maintenance task|category=Characters of unknown | + | <nowiki>{{maintenance task|category=Characters of unknown magicality|label=unknown}}</nowiki> |
| − | :{{categorizer|category=Characters of unknown | + | :{{categorizer|category=Characters of unknown magicality|label=unknown|nocat=true}} |
The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others): | The infobox of the article will then bump the task in it's maintenance message like this (if there aren't any others): | ||
| − | {{maintenance|tasks=<li>[[:Category:Characters of unknown | + | {{maintenance|tasks=<li>[[:Category:Characters of unknown magicality|Characters of unknown magicality]]</li>}} |
| − | |||
</noinclude> | </noinclude> | ||
Latest revision as of 23:36, 4 June 2014
| Maintenance task | |
|---|---|
| Purpose |
Infobox [list all] |
| Single tag |
No [list all] |
| Multi-line |
Optional [list all] |
| Protected |
No [list all] |
| Game related |
No [list all] |
| Categorization | |
| Suppressible |
Recursively [list all] |
| Choice |
No choice [list all] |
| Categories |
One: [list all] |
|
|
| Variables | |
| Names |
none [list all] |
| Subpages | |
This template is a way of categorizing an article under a maintenance category, for a specified reason. When used as an argument for the {{maintenance}} messagebox, this template will also render in it. When an article does not use any or an incorrect value for proper categorization, use this template to categorize it as fallback option. This will automatically categorize articles when values are not correctly specified.
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 {{maintenance}} messagebox of the article, which is created by infoboxes. It does show the result of the categorizer where this template is called.
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 magicality
|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 magicality|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: |
