Sarna News: Bad 'Mechs - Icestorm

Difference between revisions of "Template:Cleanup/doc"

(Creation (as this is needed))
 
m (Text replacement - "[[BattleTechWiki:Template messages" to "[[BattleTechWiki:Template index")
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{documentation}}
+
<noinclude>{{pp-vandalism|small=yes}}</noinclude>{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
+
{{Substitution| |only if you want to automatically add the "date{{=}}" parameter}}
==Purpose==
+
{{Lua|Module:Unsubst}}
The '''Clean up''' template should be used in the leading section of a page as a informative message of that page's perceived current state of needing additional [[Help:Cleanup|cleanup]] to meet the BattleTechWiki's [[BattleTechWiki: Manual of Style|quality standards]].
+
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
  
==Usage==
+
==When to use==
Cut and paste '''<nowiki>{{cleanup}}</nowiki>''' into the top of the article.  
+
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.
  
<includeonly>
+
=== Alternatives ===
<!-- ADD CATEGORIES BELOW THIS LINE -->
+
If the problem is correctable with the skills you already possess, consider being [[Policy:Be bold|bold]] and fixing it yourself, rather than applying this template and leaving it for someone else to clean up.
[[Category:Templates|{{PAGENAME}}]]
+
 
[[Category:Article Maintenance Templates|{{PAGENAME}}]]
+
If you feel that an article needs a significant amount of cleanup, you can post it to [[BattleTechWiki:Project Cleanup|WikiProject Cleanup]]. It is more effective than using {{ tlc |{{ ROOTPAGENAME }}}} as there is a backlog for the tags. Editors will give your submitted article a cleanup and fix any problems associated with it.
</includeonly>
+
 
 +
== How to use ==
 +
{{Tlc|{{ROOTPAGENAME}}}} should be used with the following two parameters:
 +
* {{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|reason}}: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.
 +
 
 +
Optional parameters include:
 +
* {{para|talk}} or {{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. This parameter's value is not used when {{tl|Cleanup}} appears inside {{tl|Multiple issues}}.
 +
* {{para|1}} (or an empty parameter): changes the default descriptor (i.e., "article"). For example, {{tlx|Cleanup|section}} changes it to "section".
 +
* {{para|small}}: enter 'left' here to turn the template into a small box on the left side of the screen.
 +
* {{para|nocat}}: enter 'true' here to prevent the template from adding cleanup categories to the article.
 +
 
 +
The template should be placed at the top of the article requiring a cleanup. If practicable, please use a [[BattleTechWiki:Template index/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 [[BattleTechWiki:Substitution|substituted]], the end result consists of an unsubstituted form including an automatically filled <code>date=</code> parameter with the current date.
 +
 
 +
== 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}} (although {{tl|copyedit}} would be the more appropriate tag to use in that specific case)
 +
 
 +
{| class="wikitable"
 +
|+ The template detects which [[BattleTechWiki: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}}
 +
|-
 +
! Section
 +
| {{Cleanup|section|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}}.
 +
 
 +
== TemplateData ==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"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. Use this tag when the article needs improvement per WP:BETTER.",
 +
"format": "inline",
 +
"params": {
 +
"date": {
 +
"label": "Month and year",
 +
"description": "The month and year that the template was placed (in full). \"{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}\" inserts the current month and year automatically.",
 +
"type": "line",
 +
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 +
"example": "January 2013",
 +
"suggested": true
 +
},
 +
"reason": {
 +
"label": "Reason",
 +
"description": "Reason for requesting cleanup",
 +
"type": "string",
 +
"example": "The article is full of incorrect capitalization.",
 +
"required": true
 +
},
 +
"talk": {
 +
"aliases": [
 +
"talksection"
 +
],
 +
"label": "Talk page section",
 +
"description": "The section of the talk page explaining what needs to be done",
 +
"type": "string"
 +
},
 +
"small": {
 +
"label": "Make template small",
 +
"description": "Enter \"left\" here to make the template box small and aligned to the left.",
 +
"type": "line",
 +
"autovalue": "left",
 +
"example": "left"
 +
},
 +
"1": {
 +
"label": "Affected area",
 +
"description": "Text to replace the word \"article\", usually \"section\"",
 +
"type": "line",
 +
"autovalue": "section",
 +
"example": "section"
 +
},
 +
"nocat": {
 +
"label": "No category",
 +
"description": "Suppress categorization",
 +
"type": "string",
 +
"autovalue": "true",
 +
"example": "true"
 +
}
 +
},
 +
"paramOrder": [
 +
"date",
 +
"reason",
 +
"talk",
 +
"small",
 +
"1",
 +
"nocat"
 +
]
 +
}
 +
</templatedata>
 +
 
 +
== 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 image}} – for images that need cleanup
 +
* {{Tl|Cleanup reorganize}} – for articles that need a reorganization in addition to cleanup
 +
* {{Tl|Multiple issues}}
 +
* {{Tl|Copy edit}}
 +
* [[BattletechWiki:Template messages/Cleanup]]
 +
 
 +
== Redirects ==
 +
{{Columns-list|colwidth=15em|
 +
* {{Tl|Attention}}
 +
* {{Tl|Attention (on talk page)}}
 +
* {{Tl|Attention see talk}}
 +
* {{Tl|Attn}}
 +
* {{Tl|CU}}
 +
* {{Tl|Clean}}
 +
* {{Tl|Clean up}}
 +
* {{Tl|Clean-up}}
 +
* {{Tl|Cleancat}}
 +
* {{Tl|Cleanup-article}}
 +
* {{Tl|Cleanup-because}}
 +
* {{Tl|Cleanup-date}}
 +
* {{Tl|Cleanup-quality}}
 +
* {{Tl|Cleanup-reason}}
 +
* {{Tl|Cleanup-since}}
 +
* {{Tl|Clu}}
 +
* {{Tl|Cu}}
 +
* {{Tl|Improve}}
 +
* {{Tl|Index-cleanup}}
 +
* {{Tl|Quality}}
 +
* {{Tl|Tidy}}
 +
}}
 +
 
 +
== Wrappers ==
 +
* {{Tl|Cleanup section}}
 +
** {{Tl|Cleanup-section}}
 +
** {{Tl|Clean-up section}}
 +
 
 +
<includeonly>{{sandbox other||
 +
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 +
[[Category:Cleanup templates|Cleanup]]
 +
}}</includeonly>

Latest revision as of 21:57, 2 April 2024

When to use[edit]

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.

Alternatives[edit]

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.

If you feel that an article needs a significant amount of cleanup, you can post it to WikiProject Cleanup. It is more effective than using {{Cleanup}} as there is a backlog for the tags. Editors will give your submitted article a cleanup and fix any problems associated with it.

How to use[edit]

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

  • |date=: the month and year (e.g. May 2024) when the Cleanup template was added to the article; this helps to figure out how long an article has been tagged for cleanup.
  • |reason=: the reason for requesting cleanup. This is useful for editors in case the reason for requesting a cleanup is not immediately obvious.

Optional parameters include:

  • |talk= or |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. This parameter's value is not used when {{Cleanup}} appears inside {{Multiple issues}}.
  • |1= (or an empty parameter): changes the default descriptor (i.e., "article"). For example, {{Cleanup|section}} changes it to "section".
  • |small=: enter 'left' here to turn the template into a small box on the left side of the screen.
  • |nocat=: enter 'true' here to prevent the template from adding cleanup categories to the article.

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.

If this template is substituted, the end result consists of an unsubstituted form including an automatically filled date= parameter with the current date.

Examples[edit]

For example, {{Cleanup|reason=The article is full of incorrect capitalization.|date=May 2024}} would display as:

(although {{copyedit}} would be the more appropriate tag to use in that specific case)

The template detects which namespace it is used in and changes accordingly:
Article
Section
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}}.

TemplateData[edit]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Cleanup

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.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Month and yeardate

The month and year that the template was placed (in full). "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}" inserts the current month and year automatically.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Linesuggested
Reasonreason

Reason for requesting cleanup

Example
The article is full of incorrect capitalization.
Stringrequired
Talk page sectiontalk talksection

The section of the talk page explaining what needs to be done

Stringoptional
Make template smallsmall

Enter "left" here to make the template box small and aligned to the left.

Example
left
Auto value
left
Lineoptional
Affected area1

Text to replace the word "article", usually "section"

Example
section
Auto value
section
Lineoptional
No categorynocat

Suppress categorization

Example
true
Auto value
true
Stringoptional

Categorization[edit]

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[edit]

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

See also[edit]

Redirects[edit]

Wrappers[edit]