Difference between revisions of "Template:Maintenance task"

From Twinsuniverse
Jump to: navigation, search
(fixed a renamed category)
m (some documentation rewrite)
Line 13: Line 13:
 
         |&#58; {{{reason}}}}}</li>}}
 
         |&#58; {{{reason}}}}}</li>}}
 
}}</includeonly><noinclude>
 
}}</includeonly><noinclude>
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.
+
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==
Line 23: Line 23:
  
  
'''''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.''
+
'''''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==

Revision as of 21:16, 27 May 2014

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: