Difference between revisions of "Template:Clarify/doc"

From blackwiki
Jump to navigation Jump to search
imported>Yintan
m (Reverted edits by 119.30.38.94 (talk) to last revision by DixonDBot (HG))
imported>V2Blast
m (removed extraneous space in examples)
 
(79 intermediate revisions by 45 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
<!-- Categories at the end of this page, please; interwikis links at Wikidata. -->
 +
{{distinguish|Template:Unclear}}
 +
{{Caution|style=margin-bottom:1.0em; |Avoid using wikilinks. These can (and, with {{para|reason}}, will) corrupt the template's output. }}
  
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.  
+
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.
  
 
== Usage ==
 
== Usage ==
This is an [[Wikipedia:WikiProject Inline Templates|in-line template]], place the template immediately after the material in question, as one would do with a footnote. For example:
+
This is an [[Wikipedia:WikiProject Inline Templates|inline template]] which should be placed immediately after the material in question, as with a footnote. For example:
 +
: <code> This sentence needs clarification.{{tlp|clarify|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} </code> → This sentence needs clarification.{{clarify|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}
 +
::The wikilink on "clarification needed" is set to [[Wikipedia:Please clarify]].
  
:<code>This sentence needs clarification.{{Tlx|Clarify|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code>
+
== Parameters ==
 +
; Abbreviated parameter sets:  
  
The above text will cause the tag {{Clarify}} to appear inline. The tag links to [[Wikipedia:Please clarify]] for further information.
+
:{{tlx|clarify|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;}}
 +
:{{tlx|clarify|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;}}
  
=== Categorisation ===
+
; Full parameter set:
Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]], or a dated subcategory thereof.
+
 
 +
:{{tlx|clarify|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;|5=pre-text=&nbsp;|6=post-text=&nbsp;}}
 +
 
 +
;Parameter descriptions
 +
 
 +
; {{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) -->
  
=== Parameters ===
+
; {{para|text}} : The particular text needing clarification may be highlighted by wrapping this template around it:
;{{Para|date}}:
+
:: As an example:
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 - {{para|reason}} {{para|pre-text}} {{para|post-text}} - are given.
+
::: ''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|reason}}:
+
; {{para|pre-text}}
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.
+
; {{para|post-text}} : One can specify additional text to appear before and/or after the "clarify" tag using the two parameters listed above.
 +
::Examples follow:
 +
:# <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]])}}
  
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 mouseover 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.
+
== TemplateData ==
 +
{{TemplateData header}}
 +
<templatedata>
 +
{
 +
"description": "Use this inline template as a request for other editors to clarify text that is difficult to understand. Place immediately after the material in question.",
 +
"params": {
 +
"reason": {
 +
"label": "Reason",
 +
"type": "string",
 +
"description": "A brief reason for the tag. Avoid using wikilinks; these will corrupt the template's output.",
 +
"suggested": true
 +
},
 +
"text": {
 +
"label": "Text",
 +
"type": "string",
 +
"description": "Text fragment containing concerns the tag is supposed to address."
 +
},
 +
"date": {
 +
"label": "Date",
 +
"type": "string",
 +
"description": "The date the tag was added (this will be added automatically soon by a bot if not added manually).",
 +
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 +
"suggested": true
 +
},
 +
"pre-text": {
 +
"label": "Pre-text",
 +
"type": "string",
 +
"description": "Any string to be added before the \"Clarify\" tag, such as \"?\"",
 +
"autovalue": ""
 +
},
 +
"post-text": {
 +
"label": "Post-text",
 +
"type": "string",
 +
"description": "Any string to be added after the \"Clarify\" tag, such as \"complicated jargon\"."
 +
}
 +
}
 +
}
 +
</templatedata>
  
;Other:
+
== Categorization ==
One can specify additional text to appear before and or after the "clarify" tag. For example
+
Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]], or a dated subcategory thereof.
:<code><nowiki>{{Clarify|pre-text=?}}</nowiki></code>
 
will cause a question mark to appear before "clarify" like this{{Clarify|pre-text=?}}, and
 
:<code><nowiki>{{Clarify|post-text=(complicated jargon)}}</nowiki></code>
 
will cause text to appear after "clarify" like this{{Clarify|post-text=(complicated jargon)}}. You can use this feature to link to a discussion on the article's talk page:
 
:<code><nowiki>{{Clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}</nowiki></code>
 
  
 
== Redirects ==
 
== Redirects ==
* {{tlf|Clarification needed }}
+
{{startflatlist}}
 +
* {{tlf|Clarification needed}}
 
* {{tlf|Clarify me}}
 
* {{tlf|Clarify me}}
 +
* {{tlf|Confusing-inline}}
 +
* {{tlf|Confusing-short}}
 
* {{tlf|Define?}}
 
* {{tlf|Define?}}
 
* {{tlf|How?}}
 
* {{tlf|How?}}
 
* {{tlf|Huh}}
 
* {{tlf|Huh}}
 +
* {{tlf|What?}}
 
* {{tlf|What}}
 
* {{tlf|What}}
* {{tlf|Wtf?}}
+
{{endflatlist}}
  
 
== See also ==
 
== See also ==
;Inline
+
{{Columns
 +
|colwidth=auto |gapbetween=2.0em
 +
| col1 =
 +
'''Related inline templates'''
 +
* {{tl|Clarify span}}
 
* {{tl|Ambiguous}}
 
* {{tl|Ambiguous}}
* {{tl|Clarify span}}
 
 
* {{tl|Definition}}
 
* {{tl|Definition}}
* {{tl|Elucidate}}
+
* {{Tl|Examples}}
* {{tl|MIR}}
+
* {{tl|Explain}}
 +
* {{tl|Non sequitur}}
 
* {{tl|Vague}}
 
* {{tl|Vague}}
 
+
* {{tl|Which one}}
;Message boxes
+
| col2 =
 +
'''Message-box templates'''
 
* {{tl|Confusing}}
 
* {{tl|Confusing}}
 
* {{tl|Confusing section}}
 
* {{tl|Confusing section}}
 
+
* {{Tl|Expand section}}
;Other
+
* {{Tl|Missing information}}
 +
| col3 =
 +
'''Related pages'''
 
* [[Wikipedia:Citing sources]]
 
* [[Wikipedia:Citing sources]]
 
* [[Wikipedia:Explain jargon]]
 
* [[Wikipedia:Explain jargon]]
 
* [[Wikipedia:Please clarify]]
 
* [[Wikipedia:Please clarify]]
 +
}}
  
 
{{Inline tags}}
 
{{Inline tags}}
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
[[Category:Coherency templates|{{PAGENAME}}]]
 
[[Category:Inline cleanup templates|{{PAGENAME}}]]
 
  
<!-- ADD INTERWIKIS BELOW THIS LINE -->
+
<includeonly>{{Sandbox other||
</includeonly>
+
<!-- Categories after this line, please; interwikis links at Wikidata. -->
 +
[[Category:Coherency templates]]
 +
[[Category:Inline cleanup templates]]
 +
}}</includeonly>

Latest revision as of 09:11, 15 June 2020

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 {{specify}} 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 Wikipedia project rather than the encyclopedic content.

Usage

This is an inline template which should be placed immediately after the material in question, as with a footnote. For example:

This sentence needs clarification.{{clarify|date=January 2026}} → This sentence needs clarification.[clarification needed]
The wikilink on "clarification needed" is set to Wikipedia:Please clarify.

Parameters

Abbreviated parameter sets
{{clarify|date=January 2026 |reason= }}
{{clarify|date=January 2026 |reason= |text= }}
Full parameter set
{{clarify|date=January 2026 |reason= |text= |pre-text= |post-text= }}
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, the date parameter will be added soon after by a bot. Alternatively, you may add the date automatically (without requiring bot intervention) by substituting the template. That is: {{subst:clarify}} is equivalent to {{clarify|date=January 2026}}. This technique also works if other parametersTemplate:Snd |reason= |pre-text= |post-text=Template:Snd are given.
|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: {{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 reason parameter is, if provided, displayed when the mouse is hovered over the "clarification needed" link in the article.
|text= 
The particular text needing clarification may be highlighted by wrapping this template around it:
As an example:
Text preceding the template, {{clarify|text=unclear text,|date=January 2026}} text following the template.
produces:
Text preceding the template, unclear text,[clarification needed] text following the template.
|pre-text=
|post-text= 
One can specify additional text to appear before and/or after the "clarify" tag using the two parameters listed above.
Examples follow:
  1. {{clarify|pre-text=remove or}}
    will cause the text "remove or" to appear before "clarify" like this:[remove or clarification needed]
  2. {{clarify|post-text=(complicated jargon)}}
    will cause "(complicated jargon)" to appear after "clarify" like this:[clarification needed (complicated jargon)]
  3. {{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}
    can be used to link to a discussion on the article's talk page; this example produces:[clarification needed (see talk)]

TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Clarify

Use this inline template as a request for other editors to clarify text that is difficult to understand. Place immediately after the material in question.

Template parameters

ParameterDescriptionTypeStatus
Reasonreason

A brief reason for the tag. Avoid using wikilinks; these will corrupt the template's output.

Stringsuggested
Texttext

Text fragment containing concerns the tag is supposed to address.

Stringoptional
Datedate

The date the tag was added (this will be added automatically soon by a bot if not added manually).

Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
Pre-textpre-text

Any string to be added before the "Clarify" tag, such as "?"

Auto value
Stringoptional
Post-textpost-text

Any string to be added after the "Clarify" tag, such as "complicated jargon".

Stringoptional

Categorization

Adding this template to an article will automatically place the article into Category:Wikipedia articles needing clarification, or a dated subcategory thereof.

Redirects

Template:Startflatlist

  • {{Clarification needed}}
  • {{Clarify me}}
  • {{Confusing-inline}}
  • {{Confusing-short}}
  • {{Define?}}
  • {{How?}}
  • {{Huh}}
  • {{What?}}
  • {{What}}

See also