Draft:Template index/Cleanup

For general help on tagging pages, see Information:Tagging pages for problems.

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.

Does the article meet inclusion requirements?

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.

Best practices in obscure or unpopular articles

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.

Best practices in heavily monitored articles

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

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

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

Overarching copyright issues

Tag	Text that will be shown (and usage notes)
{{copypaste}} category links talk view

Combined message boxes

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 view

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

General cleanup

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 view	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 view	Use this tag where the whole article needs extensive revision.
{{section rewrite}} category links talk view	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 view	Use this tag where the remaining sections of an article need cleanup.

Copy editing

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

Inline with article text

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

Style of writing

See also: BattleTechWiki:Five pillars, Policy:What BattleTechWiki is not, and BattleTechWiki:Words to watch

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

Structure, formatting and sections

See also: Help:Section, BattleTechWiki:Manual of Style/Headings, and BattleTechWiki:Manual of Style/Layout

Tag	Text that will be shown (and usage notes)
{{copy edit}} category links talk view
{{duplication}} category links talk view
{{importance section}} category links talk view	Template:Importance section
{{sections}} category links talk view
{{very long}} category links talk view

Introduction

See also: BattleTechWiki:Manual of Style/Lead section

Tag	Text that will be shown (and usage notes)
{{Improve lead}} category links talk view	Template:Improve lead
{{lead missing}} category links talk view	Template:Lead missing
{{lead rewrite}} category links talk view	Template:Lead rewrite
{{lead too long}} category links talk view	Template:Lead too long
{{lead too short}} category links talk view	Template:Lead too short

Potentially unwanted content

See also: Policy:What BattleTechWiki is not

Message boxes

Tag	Text that will be shown (and usage notes)
{{copypaste}} category links talk view
{{external links}} category links talk view	Template:External links
{{MOS}} category links talk view	Template:MOS

Context, statistics and detail

Tag	Text that will be shown (and usage notes)
{{context}} category links talk view
{{overly detailed}} category links talk view	Template:Overly detailed
{{specific}} category links talk view	Template:Specific

Off-topic

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 view	Also takes "other article" parameter

Expand and add

Tag	Text that will be shown (and usage notes)
{{expand section}} category links talk view	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 view	Template:Lacking overview
{{missing information}} category links talk view	Template:Missing information 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

See also: BattleTechWiki:Manual of Style/Dates and numbers and Category:Temporal templates

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

Inline with article text

Tag	Text that will be shown (and usage notes)
{{update after}} category links talk view	For facts that need updating now or at a specific future date
{{update inline}} category links talk view	For facts that need updating
{{as of}} category links talk view	Used within prose to attribute a specific time to potentially outdated statements. As of {{{1}}}

Contradiction and confusion

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 view	Use this tag in articles that need broad cleanup to eliminate confusion and discrepancies.
{{contradicts other}} category links talk view	Template:Contradicts other
{{contradicts others}} category links talk view	Template:Contradicts others Use these tags in articles that appear to contradict themselves or each other.
{{incomprehensible}} category links talk view
{{misleading}} category links talk view	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 view	Template:Self-contradictory
{{unfocused}} category links talk view	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

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

Content forks

Tag	Text that will be shown (and usage notes)
{{bad summary}} category links talk view	Template:Bad summary
{{duplication}} category links talk view

Importance and notability

See also: Policy:What BattleTechWiki is not (importance conveyed by sources) and Policy:Notability (coverage by sources).

Tag	Text that will be shown (and usage notes)
{{importance inline}} links talk view	Template:Importance inline inline version of {{importance section}}
{{importance section}} links talk view	Template:Importance section
{{notability}} category links talk view	Template:Notability An optional parameter can be added to specify the applicable guideline; e.g.: {{notability|biographies}}, {{notability|fiction}}. See the template documentation for a list of supported values.

Neutrality and factual accuracy

See also: Policy:Neutral point of view, Policy:Dispute resolution, and Policy:Verifiability

Message boxes

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

Inline with superimposed text

Tag	Text that will be shown (and usage notes)
{{according to whom}} category links talk view	For weasel words ("It was said..." It was thought...") Template:According to whom
{{clarify}} category links talk view	Do not use without first taking some steps to research the apparent problem
{{dubious}} category links talk view
{{editorializing}} category links talk view	Template:Editorializing
{{excessive citations inline}} category links talk view	For abuse of citations, per BattleTechWiki:Citation overkill.
{{original research inline}} category links talk view	Template:Original research inline
{{POV statement}} category links talk view
{{undue weight inline}} category links talk view	Template:Undue weight inline
{{when}} category links talk view	For ambiguous or vague time references of various kinds.
{{who}} category links talk view	For weasel words ("Many say..." Some people think...") Template:Who

Verifiability and sources

See also: Policy:Verifiability, Policy:No original research, Policy:Reliable sources, and Policy:Citing sources

Categories

Tag	Text that will be shown (and usage notes)
{{check category}} category links talk view	Template:Check category
{{disputed category}} category links talk view	Template:Disputed category
{{improve categories}} category links talk view	Template:Improve categories
{{recategorize}} category links talk view	Template:Recategorize
{{uncategorized}} category links talk view	Place this at the bottom of an uncategorized article/category if you are unsure of which categories apply.
{{unreferenced category}} category links talk view	Template:Unreferenced category

Lists

See also: BattleTechWiki:Manual of Style/Lists

Tag	Text that will be shown (and usage notes)
{{cleanup list}} category links talk view	For use in non-list articles or sections where potentially unwanted lists need to be salvaged before being deleted
{{create list}} category links talk view	Template:Create list Use this tag where an article needs to be changed into list format.
{{disputed list}} category links talk view	Template:Disputed list To identify a list on BattleTechWiki that has content whose truth, factual nature, and/or relevance to the topic is in dispute.
{{list entry too long}} category links talk view	Template:List entry too long For use when a list item is excessively large due to indiscriminate trivia or a need to merge or split
{{list scope}} category links talk view	Template:List scope To identify a list on BattleTechWiki that has entries that may be out of scope.
{{list to table}} category links talk view	Template:List to table For use where lists could be better presented as tables.

Wiki tech

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 view	Use this to mark articles or sections that completely lack internal links.
{{disambiguation cleanup}} category links talk view	Use this for disambiguation pages not written according to the style in BattleTechWiki:Manual of Style/Disambiguation. Replace {{disambiguation}} with this.
{{orphan}} category links talk view	Template:Orphan Use this for articles that aren't linked to from any other pages.
{{uncategorized}} category links talk view	Place this at the bottom of an uncategorized article/category if you are unsure of which categories apply.
{{underlinked}} category links talk view	Use this to mark articles or sections with too few internal links.

Infobox needed

See also: Help:Infobox and Category:Infobox templates

Tag	Text that will be shown (and usage notes)
{{infobox requested}} category links talk view	Template:Infobox requested 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 view	Template:New infobox This template should be used on talk pages.

Infobox cleanup needed

Tag	Text that will be shown (and usage notes)
{{cleanup infobox}} category links talk view	Template:Cleanup infobox

Other article tags

There are also tags available for:

• merging articles;
• moving articles;
• splitting articles; and

See also

• Information:Responsible tagging
• Information:Tagging pages for problems
• Information:Tagging pages for problems