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. |
Use {{Explain|date=May 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}}, or {{Disputed inline}}.
Usage[edit]
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=May 2024}}
The above text will cause the tag [further explanation needed] to appear inline. This tag is linked to BattleTechWiki:Please clarify for further information.
Parameters[edit]
|date=
This template allows an optional date parameter that records when the tag was added.
|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=May 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.
Categorisation[edit]
Adding this template to an article will automatically place the article into Category:Articles needing clarification, or a dated subcategory thereof.
Redirects[edit]
- {{Elucidate}}
- {{Further explanation needed}}
See also[edit]
TemplateData[edit]
TemplateData for Explain
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}}.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Reason | reason | 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. | String | suggested |
Date | date | 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.
| Date | suggested |