Template:Explain/doc: Difference between revisions
No edit summary |
m Text replacement - "Wikipedia[^:]" to "CAPipedia" |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE --> | <!-- 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 | 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 CAPipediaproject rather than the encyclopedic content. | ||
Use {{tl|Explain-wrap}} for a version with word wrap. | Use {{tl|Explain-wrap}} for a version with word wrap. | ||
| Line 27: | Line 27: | ||
== Categorisation == | == Categorisation == | ||
Adding this template to an article will automatically place the article into [[:Category: | Adding this template to an article will automatically place the article into [[:Category:CAPipediaarticles needing clarification]], or a dated subcategory thereof. | ||
== Redirects == | == Redirects == | ||
| Line 64: | Line 64: | ||
"type": "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.", | "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": " | "autovalue": "January 2024", | ||
"suggested": true | "suggested": true | ||
} | } | ||
Latest revision as of 14:39, 23 January 2024
 | This is a documentation subpage for Template:Explain. It contains usage information, categories and other content that is not part of the original Template page. |
[[Category:Template documentation pages{{#translation:}}]]
 | This template is used on approximately 2,800 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=October 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 CAPipediaproject 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=October 2024}}
The above text will cause the tag [further explanation needed] to appear inline. This tag is linked to Wikipedia:Please clarify for further information.
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=October 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
Adding this template to an article will automatically place the article into Category:CAPipediaarticles 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}}
- Relevant project pages:
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": "January 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 [clarification needed] instead. For dealing with dubious information, please use one of the following: [citation needed], [verification needed], [dubious ] or [disputed ]." } </templatedata>
