Editing Template:Explain/doc

{{Documentation subpage}}
{{High-use}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

Use {{Tlx|Explain|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} in the body of an article as a request for other editors to add further explanation to text that assumes expert understanding of a subject. When the problem is not with the level of information given, but simply with the wording, one may use {{Tl|Clarify}} instead. For dealing with dubious information, please use one of the following: {{Tl|citation needed}}, {{Tl|Verify source}}, {{Tl|Dubious}} or {{Tl|Disputed inline}}. This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]] and so is part of the Wikipedia project rather than the encyclopedic content.

Use {{tl|Explain-wrap}} for a version with word wrap.

== Usage ==

This is an [[wikipedia:WP:ILT|in-line template]], place the template immediately after the material in question, as one would do with a footnote. For example:

:<code>A fact that needs further explanation.<nowiki>{{</nowiki>Explain|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>

The above text will cause the tag {{Elucidate|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} to appear inline. This tag is linked to [[Wikipedia:Please clarify]] for further information. 

=== Parameters ===

;{{Para|date}}:
This template allows an optional date parameter that records when the tag was added. If this template is added without the date parameter, the date parameter will be added soon after by a [[wikipedia:WP:BOT|bot]].

;{{Para|reason}}:
Because it may not be immediately apparent to other editors what about the tagged passage is in need of further explanation, it is generally helpful to add a brief reason for the tag: {{Tlx|Explain|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}|reason{{=}}<var>What the problem is.</var>}}. The {{Para|reason}} parameter displays when the cursor is placed over the template, eg. {{Elucidate|reason=What the problem is.}} 

If the explanation would be lengthy, use the article's talk page. The reason parameter does not display properly if it contains quotation marks.

== Categorisation ==

Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]], or a dated subcategory thereof.

== Redirects ==
* {{Tl|Elucidate}}
* {{Tl|Further explanation needed}}

== See also ==
* {{tl|Explain-wrap}}
* Similar inline templates:
** {{Tl|Clarify}}
** {{Tl|Definition}}
** {{Tl|Examples}}
** {{tl|Non sequitur}}
* Related box templates:
** {{Tl|Confusing}}
** {{Tl|Missing information}}
** {{Tl|Expand section}}
* Relevant project pages:
** [[Wikipedia:Citing sources]]
** [[Wikipedia:Explain jargon]]
** [[Wikipedia:Please clarify]]

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"params": {
		"reason": {
			"label": "Reason",
			"type": "string",
			"suggested": true,
			"description": "A brief reason for the tag. Because it may not be immediately apparent to other editors what about the tagged passage is in need of further explanation, a brief reason is generally helpful. The reason parameter displays when the mouse cursor is placed over the text the template inserts."
		},
		"date": {
			"label": "Date",
			"type": "date",
			"description": "An optional date parameter that records when the tag was added. If this template is added without the date parameter, the date parameter will be added soon after by a bot.",
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true
		}
	},
	"description": "Use {{Explain}} in the body of an article as a request for other editors to add further explanation to text that assumes expert understanding of a subject. When the problem is not with the level of information given, but simply with the wording, one may use {{Clarify}} instead. For dealing with dubious information, please use one of the following: {{citation needed}}, {{Verify source}}, {{Dubious}} or {{Disputed inline}}."
}
</templatedata>

{{Inline tags}}
<includeonly>{{Sandbox other||
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Coherency templates|{{PAGENAME}}]]
[[Category:Inline cleanup templates|{{PAGENAME}}]]

<!-- ADD INTERWIKIS BELOW THIS LINE -->
}}</includeonly>