1,706
edits
Changes
Created page with "{{Documentation subpage}} {{Substitution| |only if you want to automatically add the "date{{=}}" parameter}} {{Twinkle standard installation}} {{Lua|Module:Unsubst}} <!-- PLEA..."
{{Documentation subpage}}
{{Substitution| |only if you want to automatically add the "date{{=}}" parameter}}
{{Twinkle standard installation}}
{{Lua|Module:Unsubst}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
== Usage ==
{{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|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:
* the first parameter: changes the default descriptor (i.e. "Article"). Example tl|Cleanup|section changes it to "Section". A wrapper is {{tl|Cleanup section}}
* {{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 {{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.
If this template is substituted, the end result consists of an unsubstituted form including an automatically filled <code>date=</code> parameter with the current date.
==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.
Articles that violate policy need more direct action. Other templates are better suited to content disputes.
=== 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.
== Examples ==
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}}
{| class="wikitable"
|+ The template detects which [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
! Article
| {{Cleanup|article|reason=lorem ipsum dolor sit amet.|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Category
| {{Cleanup|category|reason=lorem ipsum dolor sit amet!|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Template
| {{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}}.
== 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.
=== Tracking categories ===
* {{clc|All pages needing cleanup}}
For tracking purposes it also categorises the page according to whether a reason code has been given.
== See also ==
* {{Tl|Cleanup AfD}} – For AfD discussions that closed as "keep", but require 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|Multiple issues}}
* {{Tl|Spacing}}
* ''[[Template:Cleanup template documentation see also section generic list|List of cleanup templates]]''
== Wrappers ==
* {{Tl|Cleanup section}}
** {{Tl|Cleanup-section}}
** {{Tl|Clean-up section}}
== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Type",
"description": "Type of page (e.g. article) or section",
"type": "string"
},
"reason": {
"aliases": [
"2"
],
"label": "Reason",
"description": "Reason for requesting cleanup",
"example": "the article is full of incorrect capitalization",
"type": "string",
"required": true
},
"nocat": {
"type": "string",
"label": "No category",
"description": "Suppress categorization",
"example": "true"
},
"small": {
"label": "Small",
"description": "Small format",
"example": "left",
"type": "string"
},
"talk": {
"type": "string",
"aliases": [
"talksection"
],
"label": "Talk page section",
"description": "the section of the talk page explaining what needs to be done"
},
"date": {
"label": "Date",
"description": "Date the template was added to the page",
"example": "January 2018",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"required": true
}
},
"description": "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.",
"paramOrder": [
"date",
"reason",
"talk",
"small",
"1",
"nocat"
],
"format": "inline"
}
</templatedata>
<includeonly>{{sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
[[Category:Templates_that_are_not_mobile_friendly]]
}}</includeonly>
{{Substitution| |only if you want to automatically add the "date{{=}}" parameter}}
{{Twinkle standard installation}}
{{Lua|Module:Unsubst}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
== Usage ==
{{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|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:
* the first parameter: changes the default descriptor (i.e. "Article"). Example tl|Cleanup|section changes it to "Section". A wrapper is {{tl|Cleanup section}}
* {{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 {{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.
If this template is substituted, the end result consists of an unsubstituted form including an automatically filled <code>date=</code> parameter with the current date.
==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.
Articles that violate policy need more direct action. Other templates are better suited to content disputes.
=== 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.
== Examples ==
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}}
{| class="wikitable"
|+ The template detects which [[Wikipedia:Namespace|namespace]] it is used in and changes accordingly:
! Article
| {{Cleanup|article|reason=lorem ipsum dolor sit amet.|demospace=main|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Category
| {{Cleanup|category|reason=lorem ipsum dolor sit amet!|demospace=category|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|nocat=true}}
|-
! Template
| {{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}}.
== 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.
=== Tracking categories ===
* {{clc|All pages needing cleanup}}
For tracking purposes it also categorises the page according to whether a reason code has been given.
== See also ==
* {{Tl|Cleanup AfD}} – For AfD discussions that closed as "keep", but require 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|Multiple issues}}
* {{Tl|Spacing}}
* ''[[Template:Cleanup template documentation see also section generic list|List of cleanup templates]]''
== Wrappers ==
* {{Tl|Cleanup section}}
** {{Tl|Cleanup-section}}
** {{Tl|Clean-up section}}
== TemplateData ==
{{TemplateData header}}
<templatedata>
{
"params": {
"1": {
"label": "Type",
"description": "Type of page (e.g. article) or section",
"type": "string"
},
"reason": {
"aliases": [
"2"
],
"label": "Reason",
"description": "Reason for requesting cleanup",
"example": "the article is full of incorrect capitalization",
"type": "string",
"required": true
},
"nocat": {
"type": "string",
"label": "No category",
"description": "Suppress categorization",
"example": "true"
},
"small": {
"label": "Small",
"description": "Small format",
"example": "left",
"type": "string"
},
"talk": {
"type": "string",
"aliases": [
"talksection"
],
"label": "Talk page section",
"description": "the section of the talk page explaining what needs to be done"
},
"date": {
"label": "Date",
"description": "Date the template was added to the page",
"example": "January 2018",
"type": "string",
"autovalue": "{{SUBST:CURRENTMONTHNAME}} {{SUBST:CURRENTYEAR}}",
"required": true
}
},
"description": "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.",
"paramOrder": [
"date",
"reason",
"talk",
"small",
"1",
"nocat"
],
"format": "inline"
}
</templatedata>
<includeonly>{{sandbox other||
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
[[Category:Cleanup templates|Cleanup]]
[[Category:Templates_that_are_not_mobile_friendly]]
}}</includeonly>