BattleTechWiki:Template index/Cleanup

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. (See also: Information:Tag bombing and Information:Tagging pages for problems § Over-tagging)
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.

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 links talk edit

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}}

links talk edit

Tag Text that will be shown (and usage notes) — multiple issues (section)
{{multiple issues|section=yes}}

links talk edit

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 links talk edit
  • This applies to general problems not addressed by other tags.
  • Please consider using specific cleanup tags first, as specific tags help other editors to easily identify problems in an article.
  • Use the reason parameter: cleanup|reason= to specify issues identified (it may be a link to comments on the talk page).
{{cleanup rewrite}}
category links talk edit
  • Use this tag where the whole article needs extensive revision.
{{section rewrite}}
category links talk edit
  • Use this tag where a section needs extensive revision.
    (This is the same cleanup rewrite tag with section parameter enabled)
{{cleanup section}}
category links talk edit
  • Use this tag where the remaining sections of an article need cleanup.

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 links talk edit
{{copy edit section}}
category links talk edit
{{verify spelling}}
category links talk edit
[spelling?]

Inline with article text[edit]

Tag Text that will be shown (and usage notes)
{{Copy edit inline}}
category links talk edit
[needs copy edit]
  • This template tags a statement for basic copyediting, and should be placed after the statement.

Fiction[edit]

Tag Text that will be shown (and usage notes)
{{all plot}}
category links talk edit
{{long plot}}
category links talk edit
{{more plot}}
category links talk edit
{{no plot}}
category links talk edit

Style of writing[edit]

Tag Text that will be shown (and usage notes)
{{abbreviations}}
category links talk edit
{{repetition}}
category links talk edit
{{story}}
category links talk edit
{{tone}}
category links talk edit
{{verbosity}}
category links talk edit

Structure, formatting and sections[edit]

Tag Text that will be shown (and usage notes)
{{copy edit}}
category links talk edit
{{duplication}}
category links talk edit
{{sections}}
category links talk edit
{{very long}}
category links talk edit

Introduction[edit]

Tag Text that will be shown (and usage notes)
{{lead missing}}
category links talk edit
{{lead rewrite}}
category links talk edit
{{lead too long}}
category links talk edit
{{lead too short}}
category links talk edit

Potentially unwanted content[edit]

Message boxes[edit]

Tag Text that will be shown (and usage notes)
{{AI-generated}}
category links talk edit
Template:AI-generated
{{cleanup list}}
category links talk edit
  • For use in articles or sections where potentially unwanted lists need to be salvaged before being deleted
{{cleanup red links}}
category links talk edit
Template:Cleanup red links
{{copypaste}}
category links talk edit
{{criticism section}}
category links talk edit
{{external links}}
category links talk edit
{{MOS}}
category links talk edit

Context, statistics and detail[edit]

Tag Text that will be shown (and usage notes)
{{context}}
category links talk edit
{{overly detailed}}
category links talk edit

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 links talk edit
  • Also takes "other article" parameter

Expand and add[edit]

Tag Text that will be shown (and usage notes)
{{expand section}}
category links talk edit
  • When calling this template, you may pass it a parameter. A template call like {{expand section|examples and additional citations}} generates: "This section requires expansion with: examples and additional citations."
{{lacking overview}}
category links talk edit
{{missing information}}
category links talk edit
  • When calling this template, you must pass it a parameter. A template call like {{Missing information|why bananas are yellow}} generates "This article is missing information about why bananas are yellow."

Time-sensitive[edit]

Tag Text that will be shown (and usage notes)
{{update needed|Example}}
{{update}}
category links talk edit
{{update|inaccurate=y}}
category

Inline with article text[edit]

Tag Text that will be shown (and usage notes)
{{clarify timeframe}}
category links talk edit
[timeframe?]
{{update after}}
category links talk edit
[needs update]
  • For facts that likely will need updating at a specific future date.
{{update inline}}
category links talk edit
[needs update]
  • For facts that need updating as soon as possible.
{{as of}}
category links talk edit
As of {{{1}}}
  • Used within prose to attribute a specific time to information that may quickly become dated.

Major edits[edit]

Tag Text that will be shown (and usage notes)
{{under construction}}
category links talk edit
{{under development}}
category links talk edit
{{in use}}
category links talk edit
{{in creation}}
category links talk edit

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 links talk edit
  • Use this tag in articles that need broad cleanup to eliminate confusion and discrepancies.
{{contradicts other}}
category links talk edit
Template:Contradicts other
{{contradicts others}}
category links talk edit
Template:Contradicts others
  • Use these tags in articles that appear to contradict themselves or each other.
{{incomprehensible}}
category links talk edit
{{misleading}}
category links talk edit
Template:Misleading
  • Use this tag when the article is not factually wrong, but leads the reader to draw incorrect conclusions.
{{self-contradictory}}
category links talk edit
Template:Self-contradictory
{{unfocused}}
category links talk edit
Template:Unfocused
  • Use this tag when the writing is clear, but the article as a whole doesn't concentrate on a single theme.

Inline with article text[edit]

Tag Text that will be shown (and usage notes)
{{contradict-inline}}
category links talk edit
[contradictory]
  • Use this for specific sentences which contradict themselves or a nearby sentence.
{{expand acronym}}
links talk edit
[expand acronym]
  • Use this to mark acronyms and abbreviations that are not written in full at first occurrence.
{{inconsistent}}
category links talk edit
[inconsistent]
  • Use this to mark statements that are inconsistent with other parts of the article.
{{vague}}
category links talk edit
[vague]
  • Use this for specific sentences needing clarification.

Content forks[edit]

Tag Text that will be shown (and usage notes)
{{bad summary}}
category links talk edit
{{duplication}}
category links talk edit

Importance and notability[edit]

Tag Text that will be shown (and usage notes)
{{importance inline}}
links talk edit
[importance?]
{{importance section}}
links talk edit
Template:Importance section
{{notability}}
category links talk edit
Template:Notability

Neutrality and factual accuracy[edit]

Message boxes[edit]

Tag Text that will be shown (and usage notes)
{{COI}}
category links talk edit
{{disputed}}
category links talk edit
{{disputed section}}
category links talk edit
{{POV}}
category links talk edit
{{POV lead}}
category links talk edit
{{POV section}}
category links talk edit
{{undue weight}}
category links talk edit
Template:Undue weight

Inline with superimposed text[edit]

Tag Text that will be shown (and usage notes)
{{according to whom}}
category links talk edit
[according to whom?]
  • For weasel words ("It was said..." It was thought...")
{{clarify}}
category links talk edit
[clarification needed]
  • Do not use without first taking some steps to research the apparent problem
{{dubious}}
category links talk edit
[dubious ]
{{editorializing}}
category links talk edit
[editorializing]
{{excessive citations inline}}
category links talk edit
[excessive citations]
{{POV statement}}
category links talk edit
[neutrality is disputed]
{{undue weight inline}}
category links talk edit
[undue weight?discuss]
{{when}}
category links talk edit
[when?]
  • For ambiguous or vague time references of various kinds.
{{who}}
category links talk edit
[who?]
  • For weasel words ("Many say..." Some people think...")

Verifiability and sources[edit]

Categories[edit]

Tag Text that will be shown (and usage notes)
{{improve categories}}
category links talk edit
{{recategorize}}
category links talk edit
{{uncategorized}}
category links talk edit
  • Place this at the bottom of an uncategorized article/category if you are unsure of which categories apply.

Lists[edit]

Tag Text that will be shown (and usage notes)
{{cleanup list}}
category links talk edit
  • For use in non-list articles or sections where potentially unwanted lists need to be salvaged before being deleted
{{create list}}
category links talk edit
  • Use this tag where an article needs to be changed into list format.
{{disputed list}}
category links talk edit
  • To identify a list that has content whose truth, factual nature, and/or relevance to the topic is in dispute.
{{list scope}}
category links talk edit
  • To identify a list that has entries that may be out of scope.
{{list to table}}
category links talk edit
  • For use where lists could be better presented as tables.
{{Unsorted list}}
category links talk edit
  • Use this tag where a list is in reverse-chronological order or otherwise contravenes the MOS:LISTSORT.
{{prose}}
category links talk edit
  • Use this tag where a list may need converting into an article.

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 links talk edit
  • Use this to mark articles or sections that completely lack internal links.
{{disambiguation cleanup}}
category links talk edit
{{orphan}}
category links talk edit
  • Use this for articles that aren't linked to from any other pages.
{{uncategorized}}
category links talk edit
  • Place this at the bottom of an uncategorized article/category if you are unsure of which categories apply.
{{underlinked}}
category links talk edit
  • Use this to mark articles or sections with too few internal links.

Infobox needed[edit]

Tag Text that will be shown (and usage notes)
{{infobox requested}}
category links talk edit
  • This template should be used on talk pages.
  • Also has functionality to indicate that only a section in a page needs one. See the template page for more info.
{{new infobox}}
category links talk edit
  • This template should be used on talk pages.

Infobox cleanup needed[edit]

Tag Text that will be shown (and usage notes)
{{cleanup infobox}}
category links talk edit

Other article tags[edit]

There are also tags available for:

See also[edit]