Difference between revisions of "Template:Clarify/doc"

From blackwiki
Jump to navigation Jump to search
imported>Thnidu
imported>Sardanaphalus
(replaced double Ambox with Caution, slight rephrasing, Redirects formatting, subheadings, template name update)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 +
{{Caution|style=margin-bottom:1.0em; |{{Bulleted list|style=padding-bottom:0.25em; |Double quotes will ''not'' work with this template (see [[Template talk:Clarify#Bug in hover text|this thread]] for more detailed explanation). |Avoid using wikilinks. These can (and, with {{para|reason}} will) corrupt the template's output.}} }}
 
{{distinguish|Template:Unclear}}
 
{{distinguish|Template:Unclear}}
{{ambox|text=Double quotes will ''not'' work. See [[Template talk:Clarify#Bug in hover text|this thread]] for a more detailed explanation}}
+
<!-- Categories at the bottom of this page, please; interwikis at Wikidata. -->
{{ambox|text=Wikilinks, at least in the <code>reason=</code> parameter, will mess up the output badly.}}
 
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
 
  
 
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:
 
  
:<code>This sentence needs clarification.{{Tlx|Clarify|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code>
+
This is an [[Wikipedia:WikiProject Inline Templates|inline template]]; place it immediately after the material in question, as with a footnote. For example:
 +
: <code> This sentence needs clarification.{{tlp|clarify|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} </code>
  
The above text will cause the tag {{Clarify}} to appear inline. The tag links to [[Wikipedia:Please clarify]] for further information.  
+
This causes the tag:&nbsp; {{clarify}} &nbsp;to appear inline thus:
 +
: This sentence needs clarification.{{clarify}}
 +
The tag links to [[Wikipedia:Please clarify]] for further information.  
  
=== Categorisation ===
+
===Categorisation===
 
Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]], or a dated subcategory thereof.
 
Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]], or a dated subcategory thereof.
  
=== Parameters ===
+
===Parameters===
;{{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 - {{para|reason}} {{para|pre-text}} {{para|post-text}} - are given.
+
; {{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 - {{para|reason}} {{para|pre-text}} {{para|post-text}} - 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.
+
; {{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 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.
  
: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.
+
; {{para|text}} : The particular text needing clarification may be highlighted by wrapping this template around it:
 
+
{{Markup
;{{Para|text}}:The particular text needing clarification may be highlighted by wrapping this template around it:
+
| <nowiki>Clear text, {{clarify|text=unclear text,|date={{{subst:DATE}}}}} clear text.</nowiki>
{{markup
+
| Clear text, {{clarify|text=unclear text,|date={{{DATE}}}}} clear text.
|<nowiki>Clear text, {{clarify|text=unclear text,|date={{{subst:DATE}}}}} clear text.</nowiki>
 
|Clear text, {{clarify|text=unclear text,|date={{{DATE}}}}} clear text.
 
 
}}
 
}}
  
;Other:
+
; Other parameters
 
One can specify additional text to appear before and or after the "clarify" tag. For example
 
One can specify additional text to appear before and or after the "clarify" tag. For example
:<code><nowiki>{{Clarify|pre-text=?}}</nowiki></code>
+
: <code><nowiki>{{clarify|pre-text=?}}</nowiki></code>
will cause a question mark to appear before "clarify" like this{{Clarify|pre-text=?}}, and  
+
will cause a question mark to appear before "clarify" like this{{clarify|pre-text=?}}, and  
:<code><nowiki>{{Clarify|post-text=(complicated jargon)}}</nowiki></code>
+
: <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:
+
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>
+
: <code><nowiki>{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}</nowiki></code>
  
==TemplateData==
+
== TemplateData ==
 
<templatedata>
 
<templatedata>
 
{
 
{
Line 73: Line 73:
  
 
== Redirects ==
 
== Redirects ==
* {{tlf|Clarification needed }}
+
{{startflatlist}}
* {{tlf|Clarify me}}
+
* {{tnf|Clarification needed}}
* {{tlf|Define?}}
+
* {{tnf|Clarify me}}
* {{tlf|How?}}
+
* {{tnf|Define?}}
* {{tlf|Huh}}
+
* {{tnf|How?}}
* {{tlf|What}}
+
* {{tnf|Huh}}
 +
* {{tnf|What}}
 +
{{endflatlist}}
  
 
== See also ==
 
== See also ==
'''Inline'''
+
'''Related inline templates'''
 
* {{tl|Ambiguous}}
 
* {{tl|Ambiguous}}
 
* {{tl|Clarify span}}
 
* {{tl|Clarify span}}
Line 88: Line 90:
 
* {{tl|Vague}}
 
* {{tl|Vague}}
  
'''Message boxes'''
+
'''Message-box templates'''
 
* {{tl|Confusing}}
 
* {{tl|Confusing}}
 
* {{tl|Confusing section}}
 
* {{tl|Confusing section}}
  
'''Other'''
+
'''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>{{Basepage subpage|
+
 
<!-- Categories go here and interwikis go in Wikidata. -->
+
<includeonly>{{When on basepage
 +
| <!-- Categories below this line, please; interwikis at Wikidata. -->
 
[[Category:Coherency templates]]
 
[[Category:Coherency templates]]
 
[[Category:Inline cleanup templates]]
 
[[Category:Inline cleanup templates]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 13:22, 26 November 2014

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; place it immediately after the material in question, as with a footnote. For example:

This sentence needs clarification.{{clarify|date=January 2026}}

This causes the tag: [clarification needed]  to appear inline thus:

This sentence needs clarification.[clarification needed]

The tag links to Wikipedia:Please clarify for further information.

Categorisation

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

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. 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 parameters - |reason= |pre-text= |post-text= - 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. For technical reasons, this mouseover feature does not work if the reason text contains double quotes. Use single quotes instead, or use the code &quot; if it is essential to include a double quote.
|text= 
The particular text needing clarification may be highlighted by wrapping this template around it:
Markup Renders as
Clear text, {{clarify|text=unclear text,|date={{{subst:DATE}}}}} clear text.

Clear text, unclear text,[clarification needed] clear text.

Other parameters

One can specify additional text to appear before and or after the "clarify" tag. For example

{{clarify|pre-text=?}}

will cause a question mark to appear before "clarify" like this[? clarification needed], and

{{clarify|post-text=(complicated jargon)}}

will cause text to appear after "clarify" like this:[clarification needed (complicated jargon)]. You can use this feature to link to a discussion on the article's talk page:

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

TemplateData

Use this template in the body of an article as a request for other editors to clarify text that is difficult to understand.

Template parameters

ParameterDescriptionTypeStatus
reasonreason

A brief reason for the tag; do not include any double quotes.

Stringoptional
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)

Stringoptional
pre-textpre-text

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

Stringoptional
post-textpost-text

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

Stringoptional

Redirects

Template:Startflatlist

See also

Related inline templates

Message-box templates

Related pages