BattleTechWiki:Template index/Cleanup
This is an information page. It is not one of BattleTechWiki's policies or guidelines, but rather intends to describe some aspect(s) of BattleTechWiki's norms, customs, technicalities, or practices. It may reflect varying levels of consensus and vetting. |
![]() | This page in a nutshell: Add template messages to inform readers and editors of specific problems with articles or sections, but do not use them as a badge of shame. |
Template messages (maintenance tags, cleanup tags, cleanup messages) may be added to articles needing cleanup. Their purposes are to foster improvement of the encyclopedia by alerting editors to changes that need to be made. Cleanup tags are meant to be temporary notices that lead to an effort to fix the problem, not a permanent badge of shame to show that you disagree with an article, or a method of warning readers about an article.
Unless otherwise noted, cleanup messages should be placed at the top of the page, before other templates, images, or infoboxes, but after hatnotes (see BattleTechWiki:Hatnote § Placement). Cleanup messages should be placed directly on the article or file, not on its talk page. Certain tags can be placed at the beginning of an individual section, and others can be placed within the text itself (inline).
Before you tag an article, please remember the following:
- Don't tag an article if you can easily and confidently fix the problem.
- The goal is an improved article, not a tagged article.
- Do some research to attempt to solve the problem before tagging.
- Don't put the burden of doing so on another editor if you are capable of fixing the problem yourself with a simple search or consulting a reference work.
- Don't do "drive-by" tagging.
- Tags must be accompanied by either a comment on the article's talk page explaining the problem and beginning a discussion on how to fix it or, for simpler and more obvious problems, a remark using the reason parameter (available in all templates, regardless of whether it appears in the documentation) as shown below. At the very least, tagging editors must be willing to follow through with substantive discussion.
- Don't do "drive-by" de-tagging.
- Likewise, please provide a similar rationale for removing a template, unless your preceding edits have clearly fixed the announced problem. See also when not to remove a template.
- Don't insert tags that are similar or redundant.
- For example, most articles that read like essays have an inappropriate tone, and in fact they end up being automatically grouped in the same category, so it is unnecessary to tag with both {{tone}} and {{copy-edit}}.
- If an article has many problems, tag only the highest priority issues.
- A lengthy list is often less helpful than a shorter one.
- Don't add tags for trivial or minor problems, especially if an article needs a lot of work.
- For example, there is little point in noting grammatical problems for a section that needs to be completely re-written to comply with content policies. Focus on the biggest one, two, or three problems.
Contents
- 1 Best practices
- 2 Cleanup
- 2.1 Overarching copyright issues
- 2.2 Combined message boxes
- 2.3 General cleanup
- 2.4 Fiction
- 2.5 Style of writing
- 2.6 Structure, formatting and sections
- 2.7 Potentially unwanted content
- 2.8 Context, statistics and detail
- 2.9 Expand and add
- 2.10 Time-sensitive
- 2.11 Major edits
- 2.12 Contradiction and confusion
- 2.13 Content forks
- 2.14 Importance and notability
- 2.15 Neutrality and factual accuracy
- 2.16 Verifiability and sources
- 2.17 Categories
- 2.18 Lists
- 2.19 Wiki tech
- 3 Other article tags
- 4 See also
Best practices[edit]
Does the page need it?[edit]
Before placing templates on a page it is worthwhile to cast a critical eye over the page to determine whether indeed it should be included in BattleTechWiki. If you find that the article should be tagged or nominated for deletion, please see this guideline in doing so.
Obscure or unpopular articles[edit]
On pages that have received little attention from editors or readers, cleanup templates can be used as a way to call attention to problems that need to be addressed by editors. Editors who want to help address these problems should look through the various cleanup categories such as maintenance and articles with content issues and try to address the problems so that the templates can be removed.
Heavily monitored articles[edit]
On pages that are being edited by a number of users, cleanup templates are used to inform readers and editors of ongoing discussions and attempts to fix the problems on the page. Such templates can be used to attract uninvolved users to discussions and cleanup efforts, and they can also serve as a warning to casual readers that the article may have problems and be subject to noticeable changes. In general, an editor who places a template message to indicate a problem like this should explain their rationale fully on the talk page of the article. If the consensus of the other editors is that there is a problem or an editorial dispute that deserves such a clean-up template, then the editors should work to fix the problem as quickly and cleanly as possible so the template message can be removed. If the consensus is that there is no problem, then the message can be removed immediately. For heavily monitored articles, please do not add or remove template messages of this sort without using the talk page.
Use in sections[edit]
Many of these cleanup tags require you to place |article
as the first parameter when you use the tag at the top of an article. When you want the template to refer to just one section, however, you replace |article
with |section
(where the |
is a pipe key | found on most keyboards as a shift-backslash ⇧ Shift+\. See the specific template below to determine if such "section use" is supported and appropriate.
Tag consolidation[edit]
If too many tags are put at the top of an article, the article can become eclipsed by the tags, especially with short or stub articles. Consider consolidating the tags into {{multiple issues}}.
Cleanup[edit]
Overarching copyright issues[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{copypaste}} category |
|
Combined message boxes[edit]
Do not use this as the only message box on the article or section; it should be used with at least two other message boxes sandwiched inside it.
Tag | Text that will be shown (and usage notes) — multiple issues (top of article) | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
{{multiple issues}}
|
|
Tag | Text that will be shown (and usage notes) — multiple issues (section) | ||||||||
{{multiple issues|section=yes}}
|
|
General cleanup[edit]
Use one of these general tags when none of the more specific tags fits.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup}} category |
| ||
{{cleanup rewrite}} category |
| ||
{{section rewrite}} category |
| ||
{{cleanup section}} category |
|
Copy editing[edit]
Some articles just need someone with a good grasp of editing technique to give them a once-over.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{copy edit}} category |
| ||
{{copy edit section}} category |
| ||
{{verify spelling}} category |
[spelling?] |
Inline with article text[edit]
Tag | Text that will be shown (and usage notes) |
---|---|
{{Copy edit inline}} category |
[needs copy edit]
|
Fiction[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{all plot}} category |
| ||
{{long plot}} category |
| ||
{{more plot}} category |
| ||
{{no plot}} category |
|
Style of writing[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{abbreviations}} category |
| ||
{{repetition}} category |
| ||
{{story}} category |
| ||
{{tone}} category |
| ||
{{verbosity}} category |
|
Structure, formatting and sections[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{copy edit}} category |
| ||
{{duplication}} category |
| ||
{{sections}} category |
| ||
{{very long}} category |
|
Introduction[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{lead missing}} category |
| ||
{{lead rewrite}} category |
| ||
{{lead too long}} category |
| ||
{{lead too short}} category |
|
Potentially unwanted content[edit]
Message boxes[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{AI-generated}} category |
Template:AI-generated | ||
{{cleanup list}} category |
| ||
{{cleanup red links}} category |
Template:Cleanup red links | ||
{{copypaste}} category |
| ||
{{criticism section}} category |
| ||
{{external links}} category |
| ||
{{MOS}} category |
|
Context, statistics and detail[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{context}} category |
| ||
{{overly detailed}} category |
|
Off-topic[edit]
Articles occasionally contain content which is otherwise valid, but appears unrelated to the nominal topic of the article.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{off topic}} category |
|
Expand and add[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{expand section}} category |
| ||
{{lacking overview}} category |
| ||
{{missing information}} category |
|
Time-sensitive[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{update needed|Example}}
|
| ||
{{update}} category |
| ||
{{update|inaccurate=y}} category |
|
Inline with article text[edit]
Tag | Text that will be shown (and usage notes) |
---|---|
{{clarify timeframe}} category |
[timeframe?]
|
{{update after}} category |
[needs update]
|
{{update inline}} category |
[needs update]
|
{{as of}} category |
As of {{{1}}}[update]
|
Major edits[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{under construction}} category |
| ||
{{under development}} category |
| ||
{{in use}} category |
| ||
{{in creation}} category |
|
Contradiction and confusion[edit]
- Note: Templates relevant for when articles are confusing or hard to understand.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{confusing}} category |
| ||
{{contradicts other}} category |
Template:Contradicts other | ||
{{contradicts others}} category |
Template:Contradicts others
| ||
{{incomprehensible}} category |
| ||
{{misleading}} category |
Template:Misleading
| ||
{{self-contradictory}} category |
Template:Self-contradictory | ||
{{unfocused}} category |
Template:Unfocused
|
Inline with article text[edit]
Tag | Text that will be shown (and usage notes) |
---|---|
{{contradict-inline}} category |
[contradictory]
|
{{expand acronym}} |
[expand acronym]
|
{{inconsistent}} category |
[inconsistent]
|
{{vague}} category |
[vague]
|
Content forks[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{bad summary}} category |
| ||
{{duplication}} category |
|
Importance and notability[edit]
Tag | Text that will be shown (and usage notes) |
---|---|
{{importance inline}} |
[importance?]
|
{{importance section}} |
Template:Importance section |
{{notability}} category |
Template:Notability
|
Neutrality and factual accuracy[edit]
Message boxes[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{COI}} category |
| ||
{{disputed}} category |
| ||
{{disputed section}} category |
| ||
{{POV}} category |
| ||
{{POV lead}} category |
|||
{{POV section}} category |
| ||
{{undue weight}} category |
Template:Undue weight |
Inline with superimposed text[edit]
Tag | Text that will be shown (and usage notes) |
---|---|
{{according to whom}} category |
[according to whom?]
|
{{clarify}} category |
[clarification needed]
|
{{dubious}} category |
[dubious ] |
{{editorializing}} category |
[editorializing] |
{{excessive citations inline}} category |
[excessive citations]
|
{{POV statement}} category |
[neutrality is disputed] |
{{undue weight inline}} category |
[undue weight? – discuss] |
{{when}} category |
[when?]
|
{{who}} category |
[who?]
|
Verifiability and sources[edit]
Categories[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{improve categories}} category |
| ||
{{recategorize}} category |
| ||
{{uncategorized}} category |
|
Lists[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup list}} category |
| ||
{{create list}} category |
| ||
{{disputed list}} category |
| ||
{{list scope}} category |
| ||
{{list to table}} category |
| ||
{{Unsorted list}} category |
| ||
{{prose}} category |
|
Wiki tech[edit]
Most of these issues are covered in the main Manual of Style.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{dead end}} category |
| ||
{{disambiguation cleanup}} category |
|
||
{{orphan}} category |
|
||
{{uncategorized}} category |
| ||
{{underlinked}} category |
|
Infobox needed[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{infobox requested}} category |
| ||
{{new infobox}} category |
|
Infobox cleanup needed[edit]
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup infobox}} category |
|
Other article tags[edit]
There are also tags available for:
See also[edit]
- This essay on Wikipedia essay about responsible tagging includes advice on what sorts of things one can say on to help others see that every tag makes sense for the article.
- Information:Tagging pages for problems