Difference between revisions of "Template:Cleanup/doc"

From blackwiki
Jump to navigation Jump to search
imported>Codename Lisa
m (Reverted 1 edit by 14.201.175.95 (talk) to last revision by MRD2014.)
imported>Voidxor
(Avoid self links. →‎See also: +{{Cleanup reorganize}} →‎Redirects: →‎Semiredirects: Template {{Tl}}.)
Line 7: Line 7:
  
 
=== Usage ===
 
=== Usage ===
{{Tlx|Cleanup}} should be used with the following two parameters:
+
{{Tlc|{{ROOTPAGENAME}}}} should be used with the following two parameters:
 
* {{para|reason}}: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.
 
* {{para|reason}}: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.
 
* {{para|date}}: the month and year (e.g. {{CURRENTMONTHNAME}} {{CURRENTYEAR}}) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.
 
* {{para|date}}: the month and year (e.g. {{CURRENTMONTHNAME}} {{CURRENTYEAR}}) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.
  
 
Optional parameters include:
 
Optional parameters include:
* {{para|talksection}}: the section of the talk page explaining what needs to be done. 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.
+
* {{para|talksection}}: the section of the talk page explaining what needs to be done. 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.
  
The template should be placed at the top of the article requiring a cleanup. If practicable, please use a [[Wikipedia:Template messages/Cleanup|more specific cleanup template]]. Because {{Tlx|Cleanup}} is vague, specific problems should be identified in the <code>reason</code> field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Tlx|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 should be placed at the top of the article requiring a cleanup. If practicable, please use a [[Wikipedia:Template messages/Cleanup|more specific cleanup template]]. Because {{Tlc|{{ROOTPAGENAME}}}} is vague, specific problems should be identified in the <code>reason</code> field; a more detailed explanation of what needs to be done can be provided on the article's talk page. An article's {{Tlc|{{ROOTPAGENAME}}}} template may be removed without the problems being fixed if it is not possible to identify what needs to be cleaned up.
  
 
Do not [[Wikipedia:Subst|substitute]] this template.
 
Do not [[Wikipedia:Subst|substitute]] this template.
  
 
===When to use===
 
===When to use===
This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per [[WP:BETTER]].  
+
This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per [[WP:BETTER]].  
  
Articles that violate policy need more direct action. Other templates, such as {{tl|POV}}, are better suited to content disputes.
+
Articles that violate policy need more direct action. Other templates, such as {{tl|POV}}, are better suited to content disputes.
  
 
=== Examples ===
 
=== Examples ===
For example, {{Tlx|Cleanup|reason{{=}}the article is full of incorrect capitalization.|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would display as:
+
For example, {{Tlc|{{ROOTPAGENAME}}|reason{{=}}the article is full of incorrect capitalization.|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would display as:
 
{{Cleanup|article|reason=the article is full of incorrect capitalization.|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}}
 
{{Cleanup|article|reason=the article is full of incorrect capitalization.|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}}
  
Line 50: Line 50:
  
 
=== See also ===
 
=== See also ===
* {{Tl|Cleanup AfD}} - For AfD discussions that closed as "keep", but require cleanup
+
* {{Tl|Cleanup AfD}} For AfD discussions that closed as "keep", but require cleanup
 
* {{Tl|Cleanup image}} – For images that need cleanup
 
* {{Tl|Cleanup image}} – For images that need cleanup
 +
* {{Tl|Cleanup reorganize}} – For articles that need a reorganization in addition to cleanup
 
* {{Tl|Cleanup see also}} – For "See also" sections
 
* {{Tl|Cleanup see also}} – For "See also" sections
 
* {{Tl|Multiple issues}}
 
* {{Tl|Multiple issues}}
Line 60: Line 61:
  
 
=== Redirects ===
 
=== Redirects ===
*[[Template:Attention]]
+
* {{Tl|Attention}}
*[[Template:Attention (on talk page)]]
+
* {{Tl|Attention (on talk page)}}
*[[Template:Attention see talk]]
+
* {{Tl|Attention see talk}}
*[[Template:Attn]]
+
* {{Tl|Attn}}
*[[Template:CU]]
+
* {{Tl|CU}}
*[[Template:Clean]]
+
* {{Tl|Clean}}
*[[Template:Clean up]]
+
* {{Tl|Clean up}}
*[[Template:Clean-up]]
+
* {{Tl|Clean-up}}
*[[Template:Cleancat]]
+
* {{Tl|Cleancat}}
*[[Template:Cleanup-article]]
+
* {{Tl|Cleanup-article}}
*[[Template:Cleanup-because]]
+
* {{Tl|Cleanup-because}}
*[[Template:Cleanup-date]]
+
* {{Tl|Cleanup-date}}
*[[Template:Cleanup-quality]]
+
* {{Tl|Cleanup-quality}}
*[[Template:Cleanup-reason]]
+
* {{Tl|Cleanup-reason}}
*[[Template:Cleanup-since]]
+
* {{Tl|Cleanup-since}}
*[[Template:Clu]]
+
* {{Tl|Clu}}
*[[Template:Cu]]
+
* {{Tl|Cu}}
*[[Template:Improve]]
+
* {{Tl|Improve}}
*[[Template:Index-cleanup]]
+
* {{Tl|Index-cleanup}}
*[[Template:Quality]]
+
* {{Tl|Quality}}
*[[Template:Tidy]]
+
* {{Tl|Tidy}}
 +
 
 
=== Semiredirects ===
 
=== Semiredirects ===
*[[Template:Cleanup section]]
+
* {{Tl|Cleanup section}}
**[[Template:Cleanup-section]]
+
** {{Tl|Cleanup-section}}
**[[Template:Clean-up section]]
+
** {{Tl|Clean-up section}}
 
<includeonly>
 
<includeonly>
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
Line 90: Line 92:
 
[[Category:Exclude in print|Τ Cleanup]]
 
[[Category:Exclude in print|Τ Cleanup]]
  
</includeonly>
 
 
<includeonly>
 
 
[[az:Şablon:Təmizləmə]]
 
[[az:Şablon:Təmizləmə]]
 
</includeonly>
 
</includeonly>

Revision as of 00:29, 26 December 2016

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.
  • |date=: the month and year (e.g. March 2026) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.

Optional parameters include:

  • |talksection=: the section of the talk page explaining what needs to be done. 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.

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 vague, 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 problems being fixed if it is not possible to identify what needs to be cleaned up.

Do not substitute this template.

When to use

This tag is intended to identify pages that need wikification or the correction of spelling, grammar, typographical errors, tone, and other similar, non-content-focused changes. Use this tag when the article needs improvement per WP:BETTER.

Articles that violate policy need more direct action. Other templates, such as {{POV}}, are better suited to content disputes.

Examples

For example, {{Cleanup|reason=the article is full of incorrect capitalization.|date=March 2026}} would display as:

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}}.

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.

For tracking purposes it also categorises the page according to whether a reason code has been given.

Alternative

If the problem is correctable with the skills you already possess, consider being bold and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.

See also

Redirects

Semiredirects