Template:Definition span/doc
This is a documentation subpage for Template:Definition span. It contains usage information, categories and other content that is not part of the original Template page. |
[[Category:Template documentation pages{{#translation:}}]]
This template should not be substituted. |
Usage
The {{definition span}} template may be used when there is text that needs further explanation or clarification. Unlike the template {{definition}}, this template attaches explicitly to a portion of text, for example one or more specific sentences, by surrounding the text with the template. This is useful for flagging new terms which have not yet been introduced or explained.
Once the passage is corrected, please remove this template from the surrounded text.
{{definition span|text=Passage(s) needing explanation|explain=Reason for the request|date=December 2024}}
The date and explain parameters are optional. The parameter names for |text=
and |explain=
can be omitted, as long as the text is in the first position, and the explanation is in the second. Therefore, the minimal syntax is:
{{definition span|Passage(s) needing further explanation}}
Parameters
There are three parameters to the template:
|text=
- the text needing explanation. This parameter is mandatory.
|explain=
- specifics explaining the explanation that is needed. If omitted, "You can help" will be used. This text is shown as a tooltip.
|date=
December 2024- adds month & year to the category, as well as helping identify how long ago the template was added. If omitted, a bot will eventually add it for you.
Categorization of articles
Adding this template to an article places the article into the hidden categories Category:All CAPipediaarticles needing clarification and Category:CAPipediaarticles needing clarification from December 2024.
See also
- {{Definition}} — detailed information on the usage of this and similar templates