User:Jason Quinn/How to space your cite templates and stop sucking eggs
 | This is an essay. It contains the advice or opinions of one or more Wikipedia contributors. This page is not an encyclopedia article, nor is it one of Wikipedia's policies or guidelines, as it has not been thoroughly vetted by the community. Some essays represent widespread norms; others only represent minority viewpoints. |
 | This page in a nutshell: Please think about the spacing you are using when adding citations using {{cite}} and {{citation}}. Do it the "right way" as shown below. |
When you add cite templates to articles, make sure your spacing makes sense. Wikipedia is based on the manipulation of textual information and editing text is at its heart so you must mind such details. (This is of extreme importance for bot creators! As far as I'm concerned, any bot creator who never considered the spacing their bot produces has demonstrated poor judgement.)
The right way to space
editThere is only one way to space your cite templates that passes muster and withstands the test of time: a space before the pipe character and no spaces after or around the equal sign. The following example demonstrates:
This is, as objectively as possible, an optimal spacing choice. The text wrapping breaks the parameters up into easy to identify parts. It's still compact too. It's as best as can be done.
ALWAYS USE THIS STYLE! Not because it's mandatory but because it shows you care.
And the way to suck eggs
editThe following choices for the spacing in cite templates are absolutely terrible and I don't know why a sane person would ever do it any of the following ways:
Spacing?What'sthat?
editThis is bad because text editors have trouble wrapping the citation for display in the text editor. And when it does wrap, it only does so in spots that do not separate parameters but instead in the middle of the value of the parameter (eg in the middle of the title or a date). This runs the risk of a person not noticing the full value of the parameter when editing the source and causing errors.
NEVER USE THIS STYLE!
Fluffy spacing
editIn many ways this is worse than no spaces. The text is wrapping too much, leaving stray pipe characters or equal signs on the far right.
NEVER USE THIS STYLE!
Spaces after pipes and around equal signs
editThis version is confusing to parse. It continually tricks the eye and makes it difficult to tell where parameters start and end.
NEVER USE THIS STYLE!
Random slop
editNEVER USE THIS STYLE AND STAY OFF DRUGS.