Template:Explain/doc
 | This is a documentation subpage for Template:Explain. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Use {{Explain|date=November 2024}} 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}}. This template is a self-reference and so is part of the Wikipedia project rather than the encyclopedic content.
Use {{Explain-wrap}} for a version with word wrap.
Usage
This is an in-line template, place the template immediately after the material in question, as one would do with a footnote. For example:
A fact that needs further explanation.{{Explain|date=November 2024}}
The above text will cause the tag [further explanation needed] to appear inline.
Parameters
|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 bot.
|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: {{Explain|date=November 2024|reason=What the problem is.}}. The |reason= parameter displays when the cursor is placed over the template, eg. [further explanation needed]
If the explanation would be lengthy, use the article's talk page. The reason parameter does not display properly if it contains quotation marks.
Categorization
Adding this template to an article will automatically place the article into Category:Articles needing clarification, or a dated subcategory thereof.
Redirects
- {{Elucidate}}
- {{Further explanation needed}}
See also
- {{Explain-wrap}}
- Similar inline templates:
- {{Clarify}}
- {{Definition}}
- {{Examples}}
- {{Non sequitur}}
- Related box templates:
- {{Confusing}}
- {{Missing information}}
- {{Expand section}}
TemplateData
TemplateData for Explain
<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": "August 2024", "suggested": true } }, "description": "Use [further explanation needed] 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 instead. For dealing with dubious information, please use one of the following:[citation needed],[verification needed], [dubious – discuss] or [disputed – discuss]." } </templatedata>