Difference between revisions of "Template:Cleanup/doc"
imported>Debresser (No reason to exp[lain.) |
|||
| 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 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. | + | * <tt>reason</tt>: the reason for requesting cleanup. This |
| − | * <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. | + | 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. | ||
| + | * <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 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. | + | * <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. | ||
| − | 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. | + | 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. | ||
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, {{Tlx|Cleanup|reason{{=}}the article is full of incorrect |
| − | {{Cleanup|article|reason=the article is full of incorrect capitalization|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|demospace=main|nocat=true}} | + | capitalization|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} would |
| + | 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 used in and changes accordingly: | + | |+ The template detects which [[Wikipedia:Namespace|namespace]] it is |
| + | used in and changes accordingly: | ||
! Article | ! Article | ||
| − | | {{Cleanup|article|reason=lorem ipsum dolor sit amet|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}} | + | | {{Cleanup|article|reason=lorem ipsum dolor sit |
| + | amet|demospace=main|date={{CURRENTMONTHNAME}} | ||
| + | {{CURRENTYEAR}}|nocat=true}} | ||
|- | |- | ||
! Category | ! Category | ||
| − | | {{Cleanup|category|reason=lorem ipsum dolor sit amet|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}} | + | | {{Cleanup|category|reason=lorem ipsum dolor sit |
| + | amet|demospace=category|date={{CURRENTMONTHNAME}} | ||
| + | {{CURRENTYEAR}}|nocat=true}} | ||
|- | |- | ||
! Template | ! Template | ||
| − | | {{Cleanup|template|reason=lorem ipsum dolor sit amet|demospace=other|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}} | + | | {{Cleanup|template|reason=lorem ipsum dolor sit |
| + | amet|demospace=other|date={{CURRENTMONTHNAME}} | ||
| + | {{CURRENTYEAR}}|nocat=true}} | ||
|} | |} | ||
| − | 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}}. | + | 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}}. | ||
====Categorization==== | ====Categorization==== | ||
| − | This | + | This tem |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 13:34, 15 April 2014
| 40px | This is a documentation subpage for Template:Cleanup. It contains usage information, categories and other content that is not part of the original template page. |
| 40x40px | This template should not be substituted. |
| 40px | This template is used on 13,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
| 50x40px | If you plan to make breaking changes to this template, move it, or nominate it for deletion, please notify Twinkle's users and maintainers at Wikipedia talk:Twinkle as a courtesy, as this template is used in the standard installation of Twinkle. Thank you! |
| 30px | This template uses Lua: |
Contents
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.
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 [[Wikipedia:Template
messages/Cleanup|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=March 2026}} would
display as:
This article may require cleanup to meet Wikipedia's quality standards. The specific problem is: the article is full of incorrect
capitalization' (March 2026) |
| 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 tem