Template:Cleanup/doc

From IAB Wiki
Jump to: navigation, search


Usage

{{Cleanup}} should be used with the following two parameters:

  • reason: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious. The first character of the reason (immediately after the equals sign) should be lowercase, in order to preserve the sentence flow when rendered.
  • date: the month and year (e.g. September 2014) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.

For example, {{Cleanup|reason=the article is full of incorrect capitalisation|date=September 2014}} would display as:

The template should be placed at the top of the article requiring a cleanup. If practicable, please use a more specific cleanup template. Because {{Cleanup}} is general , specific problems should be identified in the reason field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Cleanup}} template may be removed without the problem(s) being fixed if it is not possible to identify what needs to be cleaned-up.

The template detects which namespace it is used in and changes accordingly:
Article
Category
Template

The descriptor (on the preceding example "template") can be changed from its default using the first parameter, for instance {{Cleanup|section}} or {{Cleanup|disambiguation page}}.

Add a new section to the talk page explaining the type and extent of clean-up required so editors will know what to address, and when to remove this template.

Do not substitute this template.

Categorization

This template will add pages on which it is used to a specific category Category:Articles needing cleanup containing pages needing cleanup or a dated subcategory thereof.

See also


Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox