Difference between revisions of "Template:Cleanup/doc"

From blackwiki
Jump to navigation Jump to search
imported>Redrose64
m (Reverted edits by 131.228.29.7 (talk) to last version by Debresser)
Line 4: Line 4:
 
{{Twinkle standard installation}}
 
{{Twinkle standard installation}}
 
{{Lua|Module:Unsubst}}
 
{{Lua|Module:Unsubst}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE  
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
-->
 
  
 
=== Usage ===
 
=== Usage ===
 
{{Tlx|Cleanup}} should be used with the following two parameters:
 
{{Tlx|Cleanup}} should be used with the following two parameters:
* <tt>reason</tt>: the reason for requesting cleanup. This  
+
* <tt>reason</tt>: 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.
is useful for editors in case the reason for requesting a cleanup is not
+
* <tt>date</tt>: 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.
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.
 
* <tt>date</tt>: 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:
* <tt>talksection</tt>: the section of the talk page  
+
* <tt>talksection</tt>: 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.
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  
+
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 <tt>reason</tt> 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.
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  
 
<tt>reason</tt> 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.
 
  
 
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  
+
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]].  
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,  
+
Articles that violate policy need more direct action.  Other templates, such as {{tl|POV}}, are better suited to content disputes.
such as {{tl|POV}}, are better suited to content disputes.
 
  
 
=== Examples ===
 
=== Examples ===
For example, {{Tlx|Cleanup|reason{{=}}the article is full of incorrect  
+
For example, {{Tlx|Cleanup|reason{{=}}the article is full of incorrect capitalization|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would display as:
capitalization|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would  
+
{{Cleanup|article|reason=the article is full of incorrect capitalization|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}}
display as:
 
{{Cleanup|article|reason=the article is full of incorrect  
 
capitalization|date={{CURRENTMONTHNAME}}  
 
{{CURRENTYEAR}}|demospace=main|nocat=true}}
 
  
 
{| class="wikitable"
 
{| class="wikitable"
|+ The template detects which [[Wikipedia:Namespace|namespace]] it is  
+
|+ The template detects which [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
used in and changes accordingly:
 
 
! Article
 
! Article
| {{Cleanup|article|reason=lorem ipsum dolor sit  
+
| {{Cleanup|article|reason=lorem ipsum dolor sit amet|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
amet|demospace=main|date={{CURRENTMONTHNAME}}  
 
{{CURRENTYEAR}}|nocat=true}}
 
 
|-
 
|-
 
! Category
 
! Category
| {{Cleanup|category|reason=lorem ipsum dolor sit  
+
| {{Cleanup|category|reason=lorem ipsum dolor sit amet|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
amet|demospace=category|date={{CURRENTMONTHNAME}}  
 
{{CURRENTYEAR}}|nocat=true}}
 
 
|-
 
|-
 
! Template
 
! Template
| {{Cleanup|template|reason=lorem ipsum dolor sit  
+
| {{Cleanup|template|reason=lorem ipsum dolor sit amet|demospace=other|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
amet|demospace=other|date={{CURRENTMONTHNAME}}  
 
{{CURRENTYEAR}}|nocat=true}}
 
 
|}
 
|}
  
The descriptor (on the preceding example "template") can be changed from
+
The descriptor (on the preceding example "template") can be changed from its default using the first parameter, for instance {{Tlc|Cleanup|section}} or {{Tlc|Cleanup|disambiguation page}}.
its default using the first parameter, for instance  
 
{{Tlc|Cleanup|section}} or {{Tlc|Cleanup|disambiguation page}}.
 
  
 
====Categorization====
 
====Categorization====
This tem
+
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 [[WP:SOFIXIT|bold]] and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.
 +
 
 +
=== See also ===
 +
* {{Tl|Cleanup AfD}} - For AfD discussions that closed as "keep", but require cleanup
 +
* {{Tl|Cleanup image}} – For images that need cleanup
 +
* {{Tl|Multiple issues}}
 +
* {{Tl|Spacing}}
 +
* [[Wikipedia:Clarify the cleanup]]
 +
* [[Wikipedia:Cleanup process]]
 +
* [[Wikipedia:Template messages/Cleanup]]
 +
 
 +
=== Redirects ===
 +
*[[Template:Attention]]
 +
*[[Template:Attention (on talk page)]]
 +
*[[Template:Attention see talk]]
 +
*[[Template:Attn]]
 +
*[[Template:CU]]
 +
*[[Template:Clean]]
 +
*[[Template:Clean up]]
 +
*[[Template:Clean-up]]
 +
*[[Template:Cleancat]]
 +
*[[Template:Cleanup-article]]
 +
*[[Template:Cleanup-because]]
 +
*[[Template:Cleanup-date]]
 +
*[[Template:Cleanup-quality]]
 +
*[[Template:Cleanup-reason]]
 +
*[[Template:Cleanup-since]]
 +
*[[Template:Clu]]
 +
*[[Template:Cu]]
 +
*[[Template:Improve]]
 +
*[[Template:Index-cleanup]]
 +
*[[Template:Quality]]
 +
*[[Template:Tidy]]
 +
=== Semiredirects ===
 +
*[[Template:Cleanup section]]
 +
**[[Template:Cleanup-section]]
 +
**[[Template:Clean-up section]]
 +
<includeonly>
 +
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 +
[[Category:Cleanup templates|Cleanup]]
 +
[[Category:Exclude in print|Τ Cleanup]]
 +
{{DEFAULTSORT:Τ Cleanup}}
 +
 
 +
</includeonly>
 +
 
 +
<includeonly>
 +
[[az:Şablon:Təmizləmə]]
 +
</includeonly>

Revision as of 13:42, 15 April 2014

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. December 2025) 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 problem(s) 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=December 2025}} 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