Editing Template:Citation needed/doc

{{Documentation subpage}}
{{Notice|An introductory version of this documentation is provided at [[BattleTechWiki:Citation needed]].}}
{{Tl|Citation needed}} is a [[BattleTechWiki:Template messages|template]] used to identify claims in articles, particularly if questionable, that need a [[BattleTechWiki:Citing sources|citation]] to a reliable source. This template produces the superscripted message&nbsp;{{citation needed|date=May 2013|reason=example}} and is installed with no spaces directly after punctuation.

== Use ==
:{{tnull|Citation needed|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
:{{tnull|Citation needed|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}|reason{{=}}''Your explanation here''}}

=== Notes ===
* The {{para|date}} parameter consists of the full English name of the current month (with initial capital and rest lowercase), a space, and the year. For example, "{{xt|January 2013}}" but not "{{!xt|jan13}}" or "{{!xt|January 23, 2013}}". Deviation from this rule will place the article in [[:Category:Articles with invalid date parameter in template]]. 
:* To automatically add the current date, you can use [[Help:Substitution|substitution]] like this: <code><nowiki>{{subst:Citation needed}}</nowiki></code>. 
* The {{para|reason}} parameter is for an explanation why you think the material needs a source. It is optional but very helpful. It is displayed as a [[Template:tooltip|tooltip]] in some browsers (hover the mouse here {{Citation needed|reason=If and only if this text is displayed, the reason parameter is working in your browser|date={{currentmonth}} {{currentyear}}}} to check behaviour of your browser). For example, the following usage might be appropriate to the claim that "Humphrey Bogart was an avid snooker player":
:{{tnull|Citation needed|reason{{=}}This claim needs a reliable source; Bogart was a famous actor but his major biographies don't mention snooker.|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}
:* Use only plain text for the {{para|reason}} parameter. It does not support [[Help:Wikitags|wiki markup]] like wikilinks, which can mess up the tooltip.
:* Double quotation marks used within the {{para|reason}} parameter will likewise mess up the tooltip; use single quotes or the HTML code <code>&amp;quot;</code> instead.
:* If omitted, the tooltip "This claim needs references to reliable sources." is used by default.
* This template should usually be installed directly ''after'' punctuation, such as a full stop (period) or a comma.
* Use of this template places the article into [[:Category:All articles with unsourced statements]] and [[:Category:Articles with unsourced statements from {{CURRENTMONTHNAME}} {{CURRENTYEAR}}]] (example; past months are listed in [[:Category:Articles with unsourced statements]]).
* Remove the template when you add a citation for a statement.

== Examples ==
=== Example 1 ===
:<code><nowiki>This sentence shows the template used at the end.{{Citation needed|reason=Reliable source needed for the whole sentence|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code>

This wikitext will be rendered as follows:

:This sentence shows the template used at the end.{{Citation needed|reason=Reliable source needed for the whole sentence|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

=== Example 2 ===

:<code><nowiki>[[w:Humphrey Bogart|Humphrey Bogart]] was an avid snooker player.{{Citation needed|date=</nowiki>{{currentmonth}} {{currentyear}}}}</code>

The template indicates that it may be that Humphrey Bogart played snooker at some point and it may be that he was enthusiastic about the game but no ''reliable'', ''published'' sources were given to verify it and the information is not considered common knowledge. 

:[[w:Humphrey Bogart|Humphrey Bogart]] was an avid snooker player.{{Citation needed|date={{currentmonth}} {{currentyear}}}}

=== Example 3 ===

If it is considered that he might have played snooker but was not an avid player, a reason for the need of a citation may be given, displayed as a tooltip when the mouse hovers on "citation needed":

:<code><nowiki>[[w:Humphrey Bogart|Humphrey Bogart]] was an avid snooker player.{{Citation needed|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}|reason=Only aware he was photographed playing once. Not aware of any source that claims he played a lot.}}</code>

:[[w:Humphrey Bogart|Humphrey Bogart]] was an avid snooker player.{{Citation needed|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|reason=Only aware he was photographed playing once. Not aware of any source that claims he played a lot.}}

In this example, it may be better to use the {{tl|Citation needed span}}, which has slightly different syntax, template to highlight the word "avid".

== When not to use this template ==
The <nowiki>{{Citation needed}}</nowiki> template is intended for use when there is a general question of the verifiability of a statement, or when an editor believes that a reference verifying the statement should be provided. Other templates are available for other or more specific issues; see the [[#Inline templates|list of inline templates]]. For example, claims that you think are incorrect should be tagged with {{Tl|Dubious}}, and those which represent a non-neutral view should be tagged with {{Tl|POV statement}}. Being specific about the nature of the problem will help other editors correct it.

Within a lead section that is clearly written as a summary of a substantially sourced article,
* statements that are supported with citations within the body of the article should not be tagged,
* statements that are not supported in the article body should be tagged with {{tl|Not verified in body}}.

If you have the time and ability to find an authoritative reference, please do so. Then add the citation yourself, or correct the article text. After all, the ultimate goal is not to merely identify problems, but to fix them.

While an editor may add this template to any uncited passage for any reason, many editors object to what they perceive as overuse of this tag, particularly in what is known as "drive-by" tagging, which is applying the tag without attempting to address the issues at all. Consider whether adding this tag in an article is the best approach before using it, and use it judiciously. Wikipedia's [[Policy:Verifiability|verifiability policy]] does not require reliable sources for [[w:Common knowledge|common well-known facts]] (e.g., "the Moon orbits the Earth"), neither that citations be repeated through every sentence in a paragraph. All direct quotations and facts whose accuracy might be challenged (e.g., statistics) require citations.

This template is intended for specific passages that need citation. For entire articles or sections that contain significant material lacking citations (rather than just specific short passages), there are other, more appropriate templates, such as {{Tl|Unreferenced}} and {{Tl|More citations needed}} (for whole articles) as well as {{Tl|Unreferenced section}} and {{Tl|More citations needed section}} (for sections of articles).

Do not use this template to tag policies or guidelines.

== How to respond to this tag ==

The addition of this tag is a request for an inline citation to support the tagged statement. If you are able to provide a citation to support the claim, then please do so.

Except for [[Policy:Real People|contentious claims about living people]], which should be immediately removed if not cited, there is no specific deadline for providing citations. Please do not delete information that you believe is correct solely because no one has provided a citation within an arbitrary time limit. If there is some uncertainty about its accuracy, most editors are willing to wait at least a month to see whether a citation can be provided.

== Template data ==

{{TemplateData header}}
<templatedata>
{
	"description": "The template is used to identify claims in articles, particularly if questionable, that lack a citation to a reliable source.",
	"params": {
		"date": {
			"label": "Month and year",
			"description": "Provides the month and year of the citation request; e.g., 'January 2013', but not 'jan13'",
			"type": "string",
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true
		},
		"reason": {
			"label": "Reason for citation",
			"description": "A reason as to why, or for what content, the citation is needed; use single quotes, if any",
			"type": "string"
		}
	}
}
</templatedata>

== Tracking categories ==
* {{clc|Pages containing citation needed template with unsupported parameters}} – a hidden maintenance/tracking category which is added to pages using this template with unsupported parameters
* {{clc|All articles with unsourced statements}}

== See also ==
* [[Citation needed]], BTW's mainspace article about this template
* [[Template:Not verified in body]], a similar template specifically for the lead of articles
* [[Template:More citations needed]]
* [[BattleTechWiki:Citing sources]], especially [[Wikipedia:Citing sources#Unsourced material|Unsourced material]]
* [[BattleTechWiki:Reliable sources]]

=== Article message box templates ===
* {{Tl|Cite check}}: article or section may have inappropriate or misinterpreted citations.
* {{Tl|More citations needed}}: article or section has weak or incomplete sources, references, or citations.
* {{Tl|Unreferenced}} and {{Tl|Unreferenced section}}: article or section has no sources, references, or citations given at all.
* Citation method and style
** {{Tl|Citation style}}
** {{Tl|No footnotes}}

{{Inline cleanup tags}}

<includeonly>{{Sandbox other||
<!-- Template categories  -->
[[Category:Inline citation and verifiability dispute templates]]
[[Category:Templates that add a tracking category]]

}}</includeonly>