Jump to content

Wikipedia:Corrector's manual

From Wikipedia, the free encyclopedia

There are many manuals of style in English Wikipedia. But if an editor even knows them all, then s/he is not necessarily good in fixing mistakes of another editors. This manual presents several mistakes which are not especially well-known. They either are not recognized as mistakes by most Wikipedians, or are not easy to fix properly, without adding further errors.

Fully automatic rules for fixing poor wikicode cannot exist. If the code's author is MoS-unaware, then s/he is not know what s/he is doing. You ever have to think, instead him/her. You also have to think after a blind button-pushing fixer who edited the article between the original author and you.

The aim of this manual is not only the manual itself. One day, a smart wikicode analyser will be created. This manual will help to identify common problems.

Before starting to fix

[edit]

Before investing a considerable amount of your work to fixing errors, you should identify the reason of their presence. When numerous errors are present, there are roughly three common scenarios: an article was edited by competent (though MoS-unaware) editors; an incompetently-written article; and a severely degraded article. The last case does not necessary imply vandalism, but it implies existence of a much better revision in the edit history.

Scenario: Fine article Reasonably written article with poor formatting Clueless article Severely degraded article
Possible
causes:
  • A MoS-aware author
  • A corrector already edited the article
  • A competent, but MoS-unaware author, and no correctors touched the article
  • (rarely) A malfunction or obsolescence of templates, styles, or other software, degraded once correctly formatted article
Main editors were incompetent in both senses
  • Vandalism
  • Good-faith incompetent edits
  • Malfunction
Indications: The article is grammatically correct, does not contain shouting, grossly inappropriate or out-of-context fragments, and traces of content removal. There are no pieces of article demonstrating a competent authorship. The article shows bizarre omissions, out-of-context fragments, or is remarkably heterogenous with intermixed good/poor fragments.
Good typography, no dab links, all red links lead to reasonable targets.
  • Bad typography
  • Multiple dab links
  • Signs of broken wiki code, such as out-of-place square or curly brackets, and implausible red links
Recom­mended
actions:
Do not edit unless you have an intention to improve the content. Fix errors along the lines of the present manual. If not subject to WP:AfD, rewrite (merge, or convert) the article and only then start to fix errors in its remaining parts. Alert a WP:WikiProject if you are unwilling to start content manipulations yourself. Examine the edit history, then rollback or otherwise revert degradations. If later (or same) edits introduced something useful, then port useful pieces to the good version, but do not start editing from a heavily damaged revision.


[edit]

General typography

[edit]

Spaced hyphen ⟨- ⟩

[edit]

The ⟨- ⟩ (U+002D U+0020) character sequence, except inside <math> and source codes, is a certain indicator of poor typography. It is quite common knowledge that ⟨ - ⟩ should be replaced with ⟨ – ⟩ (U+00A0 U+2013 U+0020), but should it, really? The answer is: yes, if the spaced en dash is appropriate in this place. There are other choices, though. The original author does not necessarily know that genuine hyphens may not be spaced, hence if there should be a hyphen, then just delete spaces. Another possibility is an unspaced dash, one of two its main varieties (⟨–⟩ or ⟨—⟩).

There is an observation that the hyphen-minus has a strong appeal to some of "keyboard layout-only" editors, who use it instead punctuational marks, sometimes not even remotely homoglyphic, such as colon. For texts like

the correct fix will be: "Punctuation: he is doing it wrong."

Pattern Replacements
- Main route: ⟨ – ⟩
Alternative routes: ⟨-⟩
⟨–⟩
⟨—⟩
Minus sign
word- Main route: ⟨: ⟩

Unspaced hyphen ⟨-⟩

[edit]

A construction word-word or, especially, word-number, may be perfectly correct. There are no clear-cut rule which specifies all appropriate uses of hyphens, but there are several cases of improper use:

  1. Name-Name: replace with ⟨–⟩ (en dash)
    • Exception: compound names (both compound family names and multiple given names)
    • Exception: trademarks and organization names which are written with hyphen
  2. Location-Location: replace with ⟨–⟩ (en dash)
    a distance, road, railroad, other route or communication
  3. Number-Number: actually, three separate cases:
    • A code (telephone number, ISBN, or so): replacement not needed; in some cases U+2012 FIGURE DASH can be appropriate
    • A range: replace with ⟨–⟩ (en dash)
    • Subtraction notation: see below

Spurious dashes or other homoglyphs

[edit]

Letter ⟨x⟩

[edit]

Aside of words and variables, there are two appropriate and one improper uses of ⟨x⟩. The improper one substitutes it for the multiplication sign.

Pattern Replacements
0xhexadecimal not needed
x (as a placeholder) not needed
numberxnumber Main route: number⟨ × ⟩number
(thin spaces)
Alternative routes: number⟨×⟩number
number⟨ × ⟩number
numberx Main route: number⟨×⟩

Examples of valid use of ⟨x⟩ as a placeholder include x86 and Windows 9x.

Math typography

[edit]

<math> tag

[edit]

The <math> tag, also imprecisely referred to as LaTeX, is a powerful tool to make mathematical typesetting readable both on legacy and modern browsers, but it is not intended for general typesetting. In MathJax mode, it consumes both traffic and client's computational resources, as well as makes other undesirable effects. It should be used only if it is really necessary, not when the author is lazy to acquire some bits of HTML and Unicode.

When you see the code which clumsily attempts to emulate usual ASCII characters, something like <math>_{_-}</math> for an underscore, then it is certain that the original author does not understand what s/he is doing. Entire formulastuff inside <math> and </math> has to be refactored in this case. Very likely, only parts of the expression needs <math>, or the tag is not needed at all because it has to be formatted under general typesetting rules, not mathematical ones.

<math>… + … \rightarrow …</math> is also never a good sign. Refer to WP:MOSCHEM and WP:MOSPHYS for instructions how reactions should be written in Wikipedia.

Minus sign ⟨−⟩: the symbol most susceptible to corruption

[edit]

The minus sign has three valid representations:

  • ⟨−⟩ (also spelled ⟨&minus;⟩), the only correct in a bare wikicode;
  • ⟨-⟩, the only correct inside <math>;
  • ⟨-⟩ again, in parser functions and certain templates.

This pluralism contributes to the fact that this symbol suffers from editors' ignorance and clumsiness more than anything else. There are three lines of attack against it:

  • Casual: approximating with ⟨-⟩
    • because of laziness and/or general cluelessness;
    • in botched conversions from <math> to something else.
  • Miscorrection/cluelessness: intermixing with dashes ⟨–⟩: see above and thank drive-by typography fixers.
  • Esoteric exercises: replacements with non-breaking hyphens ⟨‑⟩, line drawing characters[1] and other exotic symbols.

In Wikipedia, you never can be sure that a horizontal stroke between numerals, variables, or other expressions, is actually a properly encoded minus sign.

Pattern Replacements
minuend(whatever)subtrahend Anywhere except <math> minuend⟨ − ⟩subtrahend
(whatever)operand Bare wikicode and
math formatting templates
⟨−⟩operand
Parser functions, {{val|e=}}, and similar ⟨-⟩operand
<source>…[minuend]-operand…</source>
<code>…[minuend]-operand…</code>
not needed

Asterisk ⟨*⟩ not necessarily is a botched multiplication sign

[edit]

Asterisk is known to be mistakenly used for a multiplication sign. Before fixing, you should be aware about three things:

  • A postfix asterisk (a*) is a valid notation for dual space and conjugate transpose/Hermitian adjoint;
  • Infix and prefix asterisks have legitimate uses in mathematics, but its correct typography is represented by symbols U+2217 ASTERISK OPERATOR (though, encoded as ordinary ASCII asterisk under <math>) and U+22C6 STAR OPERATOR respectively;
  • ASCII asterisk may and should be used as a multiplication sign in source codes in computer languages which use it in this rôle.
Pattern Replacements
factor*factor Main route: factor⟨ ⟩factor
(thin space)
Alternative routes: factor⟨⟩factor
factor⟨⋅⟩factor
operand* not needed
operand<sup>*</sup> Main route: operand⟨*⟩
operand*operand Main route: operand⟨∗⟩operand
<math>…factor*factor…</math> Main route: <math>…factor⟨⟩factor…</math>
Alternative route: <math>…factor⟨\cdot⟩factor…</math>
<math>…operand*…</math> Main route: <math>…operand⟨^*⟩…</math>
<math>…operand^*…</math> not needed
<math>…operand*operand…</math> not needed
<math>…*operand…</math> Main route: <math>…⟨\star⟩operand…</math>
(for Hodge dual)
<source>…factor*factor…</source>
<code>…factor*factor…</code>
not needed

Wording

[edit]

Footnotes

[edit]
  1. ^ Only a theoretical prediction of user: Incnis Mrsi. It was never reported.