Template:Clarify/doc: Difference between revisions

Use this template in the body of an article as a request for other editors to clarify text that is difficult to understand. When the problem is not with the wording, but the sourcing, one may use {{tl|specify}} 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 Wikipedia project rather than the encyclopedic content.

== Parameters ==

; Abbreviated parameter sets:  

 

; Full parameter set:  

 

:{{tlx|clarify|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}} |3=reason= |4=text= |5=pre-text= |6=post-text= }}

; {{para|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 [[WP:BOT|bot]]. Alternatively, you may add the date automatically (without requiring bot intervention) by [[WP:SUBST|substituting]] the template. That is: {{tlxs|clarify}} is equivalent to {{tlx|clarify|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This technique also works if other parameters{{snd}} {{para|reason}} {{para|pre-text}} {{para|post-text}}{{snd}} are given.

 

; {{para|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>&lt;!-- comment --&gt;</code> after the tag, as it is tidier to keep all of the {{Tlx|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>&amp;quot;</code> if it is essential to include a double quote. (Seems to no longer be a problem, since ca. 2015) -->

; {{para|text}} : The particular text needing clarification may be highlighted by wrapping this template around it:

:: As an example:

::: ''Text preceding the template'', <code>{{tlp|clarify|text{{=}}unclear text,|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}</code> ''text following the template''.  

:: produces:  

::: ''Text preceding the template'', {{clarify|text=unclear text,|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} ''text following the template''.

; {{para|pre-text}}

; {{para|post-text}} : One can specify additional text to appear before and/or after the "clarify" tag using the two parameters listed above.  

:# <code><nowiki>{{clarify|pre-text=remove or}}</nowiki></code>

:#:will cause the text "remove or" to appear before "clarify" like this:{{clarify|pre-text=remove or}}

:# <code><nowiki>{{clarify|post-text=(complicated jargon)}}</nowiki></code>

:#:will cause "(complicated jargon)" to appear after "clarify" like this:{{clarify|post-text=(complicated jargon)}}

:# <code><nowiki>{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}</nowiki></code>

:#:can be used to link to a discussion on the article's talk page; this example produces:{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}

{{colbegin|colwidth=25em}}

{{colend}}