Template:Maintenance tasks/doc

This is a documentation subpage for Template:Maintenance tasks.
It contains usage information, categories and other content that is not part of the original template page.

Usage

{{Maintenance tasks|category name|directions}}

Creates a maintenance task entry based on a maintenance category. Gives a link to the category, a count of the items in the category, some directions on remedying the situation and a list of the ten oldest items in that category.

Parameters

Unnamed parameters:

1: Name of the category. Do not include the Category: namespace. Required.
2: Directions for fixing the problem or performing the maintenance. Preferred but optional.

Named parameters (all optional):

namespace: Restricts the list of examples to just one namespace. This can be set by name (eg. Page) or by number (eg. 104). Intended to prevent, for example, the template and documentation associated with a maintenance category being included in the list of examples (in some cases these items are included in the maintenance category, although this is not consistent). Defaults to 0 (main namespace).
noexamples: Activates and deactivates the list of examples. If the parameter is not set, a list of the oldest items in the category will be shown in a numbered list (up to a maximum of ten). If the parameter is set (any text will do this), the examples section will just have the notice "Examples have been deactivated for this entry. Please see the maintenance category for the full list." Defaults to none (ie. a list will be shown).
shownamespace: Determines if the namespace is shown in the list of examples. If set to true the namespace will be shown, if set to false it will be omitted. Defaults to false.

Placement

This template uses the {{PAGESINCATEGORY}} magic word, which makes it more work for the server every time it is loaded. Therefore, this template should not be used on high traffic pages.

Example

{{Maintenance tasks|Texts with missing images‎|Images must be found, uploaded to Commons and included in the page.}}

Texts with missing images‎ (Pages requiring attention: 619)

Directions

Images must be found, uploaded to Commons and included in the page.

Examples