Difference between revisions of "Draft:Template index/Cleanup"
m (Updating) |
m (Some modifications) |
||
Line 3: | Line 3: | ||
{{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.}} | {{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 [[BattleTechWiki:Cleanup|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 | + | '''Template messages''' ('''maintenance tags''', '''cleanup tags''', '''cleanup messages''') may be added to articles needing [[BattleTechWiki:Cleanup|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 [[BattleTechWiki:No disclaimers in articles|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 {{Section link|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). | Unless otherwise noted, cleanup messages should be placed at the top of the page, before other templates, images, or infoboxes, but after hatnotes (see {{Section link|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). | ||
Line 24: | Line 24: | ||
==Does the article meet inclusion requirements?== | ==Does the article meet inclusion requirements?== | ||
− | Before placing templates on a page it is worthwhile to cast a [[Critical thinking|critical]] eye over the page to determine whether indeed it should be included in BattleTechWiki. | + | Before placing templates on a page it is worthwhile to cast a [[w:Critical thinking|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, [[Help:Deletion|please see this guideline in doing so]]. |
==Best practices in obscure or unpopular articles== | ==Best practices in obscure or unpopular articles== |
Revision as of 13:15, 29 August 2023
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 {{essay-like}}.
- 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 Does the article meet inclusion requirements?
- 2 Best practices in obscure or unpopular articles
- 3 Best practices in heavily monitored articles
- 4 Use in sections
- 5 Tag consolidation
- 6 Cleanup
- 6.1 Overarching copyright issues
- 6.2 Combined message boxes
- 6.3 General cleanup
- 6.4 Style of writing
- 6.5 Structure, formatting and sections
- 6.6 Potentially unwanted content
- 6.7 Context, statistics and detail
- 6.8 Expand and add
- 6.9 Expert needed
- 6.10 Time-sensitive
- 6.11 Contradiction and confusion
- 6.12 Content forks
- 6.13 Importance and notability
- 6.14 Neutrality and factual accuracy
- 6.15 Verifiability and sources
- 6.16 Categories
- 6.17 Images and other media
- 6.18 Lists
- 6.19 Wiki tech
- 7 Other article tags
- 8 See also
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 |
|
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}}
|
|
Tag | Text that will be shown (and usage notes) — multiple issues (section) | ||||||||
{{multiple issues|section=yes}}
|
|
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 |
| ||
{{cleanup AfD}} category |
Template:Cleanup AfD
| ||
{{cleanup rewrite}} category |
| ||
{{section rewrite}} category |
| ||
{{cleanup section}} category |
|
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 |
| ||
{{copy edit section}} category |
| ||
{{verify spelling}} category |
[spelling?] |
Inline with article text
Tag | Text that will be shown (and usage notes) |
---|---|
{{Copy edit inline}} category |
[needs copy edit]
|
Style of writing
Structure, formatting and sections
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup reorganize}} category |
Template:Cleanup reorganize | ||
{{copy edit}} category |
| ||
{{duplication}} category |
| ||
{{importance section}} category |
Template:Importance section | ||
{{organize section}} category |
Template:Organize section | ||
{{overcolored}} category |
Template:Overcolored | ||
{{overcoloured}} category |
Template:Overcoloured | ||
{{sections}} category |
| ||
{{summarize section}} category |
Template:Summarize section | ||
{{Too many sections}} category |
Template:Too many sections | ||
{{too many see alsos}} category |
Template:Too many see alsos | ||
{{trivia}} category |
Template:Trivia | ||
{{very long}} category |
|
Introduction
Tag | Text that will be shown (and usage notes) |
---|---|
{{Improve lead}} category |
Template:Improve lead |
{{lead extra info}} category |
Template:Lead extra info |
{{lead missing}} category |
Template:Lead missing |
{{lead rewrite}} category |
Template:Lead rewrite |
{{lead too long}} category |
Template:Lead too long |
{{lead too short}} category |
Template:Lead too short |
{{POV lead}} category |
Template:POV lead |
Potentially unwanted content
Message boxes
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 | ||
{{close paraphrasing}} category |
Template:Close paraphrasing | ||
{{copypaste}} category |
| ||
{{criticism section}} category |
Template:Criticism section | ||
{{external links}} category |
Template:External links | ||
{{further reading cleanup}} category |
Template:Further reading cleanup | ||
{{in popular culture}} category |
Template:In popular culture | ||
{{MOS}} category |
Template:MOS | ||
{{non-free}} category |
Template:Non-free | ||
{{overlinked}} category |
Template:Overlinked | ||
{{schedule}} category |
Template:Schedule | ||
{{trivia}} category |
Template:Trivia |
Inline with article text
Tag | Text that will be shown (and usage notes) |
---|---|
{{peacock term}} category |
Template:Peacock term
|
{{spam link}} category |
Template:Spam link |
{{weasel inline}} category |
Template:Weasel inline |
Context, statistics and detail
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{context}} category |
| ||
{{generalize}} category |
Template:Generalize | ||
{{human-centric}} category |
Template:Human-centric | ||
{{overly detailed}} category |
Template:Overly detailed | ||
{{Too many charts}} category |
Template:Too many charts | ||
{{specific}} category |
Template:Specific | ||
{{time-context}} category |
Template:Time-context |
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 |
|
Expand and add
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{biblio}} category |
Template:Biblio | ||
{{cleanup biography}} category |
Template:Cleanup biography | ||
{{expand section}} category |
| ||
{{formula missing descriptions}} category |
Template:Formula missing descriptions | ||
{{kmposts}} category |
Template:Kmposts
| ||
{{lacking ISBN}} category |
Template:Lacking ISBN
| ||
{{lacking overview}} category |
Template:Lacking overview | ||
{{mileposts}} category |
Template:Mileposts
| ||
{{missing information}} category |
Template:Missing information
| ||
{{expand language}} category |
Template:Expand language
|
Expert needed
Tag | Text that will be shown (and usage notes) |
---|---|
{{expert needed}} category |
Template:Expert needed
|
Time-sensitive
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{time-context}} category |
Template:Time-context | ||
{{update}} category |
| ||
{{update|inaccurate=y}} category |
|
Inline with article text
Tag | Text that will be shown (and usage notes) |
---|---|
{{clarify timeframe}} category |
For tagging BTW:DATED problems [timeframe?] |
{{update after}} category |
For facts that need updating now or at a specific future date [needs update] |
{{update inline}} category |
For facts that need updating [needs update] |
{{as of}} category |
Used within prose to attribute a specific time to potentially outdated statements. As of {{{1}}}[update] |
Contradiction and confusion
- Note: Templates relevant for when articles are confusing or hard to understand due specifically to translation issues can be found at BattleTechWiki:Template index/Translation.
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 | ||
{{unclear date}} category |
Template:Unclear date | ||
{{unfocused}} category |
Template:Unfocused
|
Inline with article text
Tag | Text that will be shown (and usage notes) |
---|---|
{{contradict-inline}} category |
Template:Contradict-inline
|
{{expand acronym}} |
[expand acronym]
|
{{inconsistent}} category |
Template:Inconsistent
|
{{vague}} category |
[vague]
|
Content forks
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{bad summary}} category |
Template:Bad summary | ||
{{duplication}} category |
|
Importance and notability
Tag | Text that will be shown (and usage notes) |
---|---|
{{importance inline}} |
Template:Importance inline
|
{{importance section}} |
Template:Importance section |
{{notability}} category |
Template:Notability
|
Neutrality and factual accuracy
Message boxes
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{autobiography}} category |
Template:Autobiography | ||
{{cherry-picked}} category |
Template:Cherry-picked | ||
{{coatrack}} category |
Template:Coatrack | ||
{{COI}} category |
Template:COI | ||
{{disputed}} category |
| ||
{{disputed section}} category |
| ||
{{geographical imbalance}} category |
Template:Geographical imbalance | ||
{{globalize}} category |
Template:Globalize | ||
{{hoax}} category |
Template:Hoax | ||
{{peacock}} category |
Template:Peacock | ||
{{political POV}} category |
Template:Political POV | ||
{{POV}} category |
| ||
{{POV lead}} category |
Template:POV lead | ||
{{POV section}} category |
| ||
{{recentism}} category |
Template:Recentism | ||
{{systemic bias}} category |
Template:Systemic bias | ||
{{unbalanced}} category |
Template:Unbalanced | ||
{{undisclosed paid}} category |
Template:Undisclosed paid | ||
{{undue weight}} category |
Template:Undue weight | ||
{{weasel}} category |
Template:Weasel |
Inline with superimposed text
Tag | Text that will be shown (and usage notes) |
---|---|
{{according to whom}} category |
For weasel words ("It was said..." It was thought...") Template:According to whom |
{{clarify}} category |
Do not use without first taking some steps to research the apparent problem [clarification needed] |
{{contentious label inline}} category |
Template:Contentious label inline |
{{dubious}} category |
[dubious ] |
{{editorializing}} category |
Template:Editorializing |
{{excessive citations inline}} category |
For abuse of citations, per BattleTechWiki:Citation overkill. [excessive citations] |
{{original research inline}} category |
Template:Original research inline |
{{POV statement}} category |
[neutrality is disputed] |
{{unbalanced opinion}} category |
Template:Unbalanced opinion |
{{undue weight inline}} category |
Template:Undue weight inline |
{{when}} category |
For ambiguous or vague time references of various kinds. [when?] |
{{who}} category |
For weasel words ("Many say..." Some people think...") Template:Who |
Verifiability and sources
Template:/Verifiability and sources
Categories
Tag | Text that will be shown (and usage notes) |
---|---|
{{check category}} category |
Template:Check category |
{{disputed category}} category |
Template:Disputed category |
{{improve categories}} category |
Template:Improve categories |
{{recategorize}} category |
Template:Recategorize |
{{uncategorized}} category |
|
{{unreferenced category}} category |
Template:Unreferenced category |
Images and other media
For tips on requesting images see: BattleTechWiki:Requested pictures.
- For template messages related to the clean up of images, see: BattleTechWiki:Template index/File namespace#Format and quality.
Tag | Text that will be shown (and usage notes) |
---|---|
{{audio requested}} category |
Template:Audio requested |
{{cleanup gallery}} |
Template:Cleanup gallery |
{{cleanup images}} category |
Template:Cleanup images |
{{diagram requested}} category |
Template:Diagram requested
|
{{image captions for cleanup}} category |
Template:Image captions for cleanup |
{{image requested}} category |
Template:Image requested
|
{{map requested}} category |
Template:Map requested
|
{{too many photos}} category |
Template:Too many photos |
Lists
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup list}} category |
| ||
{{create list}} category |
Template:Create list
| ||
{{disputed list}} category |
Template:Disputed list
| ||
{{example farm}} category |
Template:Example farm
| ||
{{famous}} category |
Template:Famous
| ||
{{fiction trivia}} category |
Template:Fiction trivia
| ||
{{in popular culture}} category |
Template:In popular culture
| ||
{{list entry too long}} category |
Template:List entry too long
| ||
{{list scope}} category |
Template:List scope
| ||
{{list to table}} category |
Template:List to table
| ||
{{MOSLOW}} category |
Template:MOSLOW
| ||
{{prose}} category |
Template:Prose
|
Wiki tech
Most of these issues are covered in the main Manual of Style.
Tag | Text that will be shown (and usage notes) | ||
---|---|---|---|
{{cleanup HTML}} category |
Template:Cleanup HTML
| ||
{{cleanup lang}} category |
Template:Cleanup lang
| ||
{{dablinks}} category |
Template:Dablinks
| ||
{{dead end}} category |
| ||
{{disambiguation cleanup}} category |
|
||
{{incoming links}} category |
Template:Incoming links
| ||
{{orphan}} category |
Template:Orphan
| ||
{{uncategorized}} category |
| ||
{{underlinked}} category |
|
Infobox needed
Tag | Text that will be shown (and usage notes) |
---|---|
{{infobox requested}} category |
Template:Infobox requested
|
{{new infobox}} category |
Template:New infobox
|
{{single infobox request}} category |
Template:Single infobox request
|
Infobox cleanup needed
Tag | Text that will be shown (and usage notes) |
---|---|
{{cleanup infobox}} category |
Template:Cleanup infobox |
Other article tags
There are also tags available for:
See also