Template:Clarification Needed
This is an example of how this template can be used: imagine that this is some sentence that is either dubious, vague, or otherwise ambiguous in some way.[clarify]
This template is similar in function and use to Wikipedia's little "Citation needed" message. Use it if you see a sentence or two that needs a clarification.
Contents |
Proper usage
Preferred usage is that you place the template at the end of the sentence -- after the sentence's ending punctuation mark, with nothing separating it and the punctuation mark -- and use the first unnamed parameter to specify what specific clarification needs to be provided. The reason is visible when editing the section, and can also be seen if you hover your mouse over the template's output. If no value is specified for the first unnamed parameter (and I strongly recommend that you always specify one!), it defaults to "No specifics were given.".
If you have the sufficient knowledge to clarify something, then don't even use this template -- just clarify the statement yourself.
Common problems
If the reason includes an equal sign, you need to prefix the whole thing with 1=, e.x. {{Clarification Needed|1=Guess what? E=MC^2.}}, or the template won't "notice" your text.[clarify] If you need to have a vertical bar in the text, you need to use the ! template instead ({{!}} -> |) to prevent errors or glitches. I wouldn't recommend trying to use curly brackets, as they have special meanings in template syntax (among other things, they're used to include templates in the first place).
The reason cannot include double quotes. However, in hover tips ("ToolTips"), two simultaneous single quotes often look exactly like double quotes, and thus make a suitable replacement.[clarify] Those who know HTML will know why double-quotes cause problems: the template is a SPAN with a TITLE attribute, and the TITLE attribute is specified in double-quotes; having double-quotes in the reason causes an HTML error, which the Wiki software sees and filters out, leaving a SPAN with no hover text.
Example
If you press the button Link moves.{{Clarification Needed|Which button do you press? What direction does Link move? How does he move? Walking? Swimming?}}
If you press the button Link moves.[clarify]
Notes
- Template:Clarifications Needed serves as a redirect. Use whichever spelling you prefer -- you can use the template's name with or without an "s" after "Clarification".
- Changed the text so that it reads "[clarify]" instead. I wonder if "[elaborate]" or "[explain]" might work better?
- I wonder if I should make a page listing the general kinds of common mistakes that warrant the usage of this template? And how to avoid or correct these mistakes? First, though, we'd have to figure out what kinds of mistakes are common.
- I should probably copy Wikipedia's Fix template over here; it can be used as a template for templates, to create a consistent appearance among inline templates like this one.
