Template:Clarify: Difference between revisions
Jump to navigation
Jump to search
test - remove delink |
{{TALKPAGENAME}} |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Fix-span | {{Fix-span | ||
|link= | |link={{TALKPAGENAME}} | ||
|text=clarify | |text=clarify | ||
|title={{{reason|The text near this tag may need clarification or removal of jargon.}}} | |title={{{reason|The text near this tag may need clarification or removal of jargon.}}} | ||
| Line 11: | Line 11: | ||
=== Usage === | === Usage === | ||
This is an [[Help:Inline tag|inline template]] which should be placed immediately after the material in question, as with a footnote. | This is an [[Help:Inline tag|inline template]] which should be placed immediately after the material in question, as with a footnote. It will create a link to the [[Help:Talk pages|talk page]] where details of clarification request should be specified. | ||
== Parameters == | == Parameters == | ||
; Abbreviated example: | ; Abbreviated example: | ||
| Line 21: | Line 22: | ||
; date : This template allows an optional date parameter that records when the tag was added. If this template is added without the date parameter there is no date bot installed on this wiki. | ; date : This template allows an optional date parameter that records when the tag was added. If this template is added without the date parameter there is no date bot installed on this wiki. | ||
; reason : Because it may not be immediately apparent to other editors what about the tagged passage is in need of clarification, it is generally helpful to add a brief reason for the tag: <code><nowiki>{{Clarify|reason=</nowiki><var>What the problem is</var><nowiki>}}</nowiki></code> (this is preferable to using an HTML <code><!-- comment --></code> after the tag, as it is tidier to keep all of the clarify-related code inside the template). If the explanation would be lengthy, use the article's talk page. | ; reason : | ||
:Reason parameter not implemented - need a simple way of making tooltip (perhaps using a mediawiki extension) | |||
:Because it may not be immediately apparent to other editors what about the tagged passage is in need of clarification, it is generally helpful to add a brief reason for the tag: <code><nowiki>{{Clarify|reason=</nowiki><var>What the problem is</var><nowiki>}}</nowiki></code> (this is preferable to using an HTML <code><!-- comment --></code> after the tag, as it is tidier to keep all of the clarify-related code inside the template). If the explanation would be lengthy, use the article's talk page. | |||
: As well as being visible in the source code for editors' benefit, the <code>reason</code> parameter is, if provided, displayed when the mouse is hovered over the "clarification needed" link in the article.<!-- For technical reasons, this mouse-over feature does not work if the reason text contains double quotes. Use single quotes instead, or use the code <code>&quot;</code> if it is essential to include a double quote. (Seems to no longer be a problem, since ca. 2015) --> | : As well as being visible in the source code for editors' benefit, the <code>reason</code> parameter is, if provided, displayed when the mouse is hovered over the "clarification needed" link in the article.<!-- For technical reasons, this mouse-over feature does not work if the reason text contains double quotes. Use single quotes instead, or use the code <code>&quot;</code> if it is essential to include a double quote. (Seems to no longer be a problem, since ca. 2015) --> | ||
[[Category:Templates highlighting]] | [[Category:Templates highlighting]] | ||
</noinclude> | </noinclude> | ||
Latest revision as of 15:14, 8 February 2019
[clarify]
Documentation
Usage
This is an inline template which should be placed immediately after the material in question, as with a footnote. It will create a link to the talk page where details of clarification request should be specified.
Parameters
- Abbreviated example
{{clarify|date=February 2019|reason=Please state location.}}
- Parameter descriptions
- date
- This template allows an optional date parameter that records when the tag was added. If this template is added without the date parameter there is no date bot installed on this wiki.
- reason
- Reason parameter not implemented - need a simple way of making tooltip (perhaps using a mediawiki extension)
- Because it may not be immediately apparent to other editors what about the tagged passage is in need of clarification, it is generally helpful to add a brief reason for the tag:
{{Clarify|reason=What the problem is}}(this is preferable to using an HTML<!-- comment -->after the tag, as it is tidier to keep all of the clarify-related code inside the template). If the explanation would be lengthy, use the article's talk page. - As well as being visible in the source code for editors' benefit, the
reasonparameter is, if provided, displayed when the mouse is hovered over the "clarification needed" link in the article.