Difference between revisions of "Template:Clarify/doc"

From blackwiki
Jump to navigation Jump to search
imported>Magioladitis
(ambox not tmbox to prevent wrong categorisation)
imported>Nnemo
(Notably rephrase, clearer, accessibility, more meaningful link)
Line 1: Line 1:
{{Documentation subpage}}
+
{{Documentation subpage}}  
{{ambox|text=Double quotes will ''not'' work. See [[Template talk:Clarify#Bug in hover text|this thread]] for a more detailed explanation}}
+
{{ambox|text=Double quotes will ''not'' work. See [[Template talk:Clarify#Bug in hover text|this discussion]] for a more detailed explanation.}}  
<!-- Categories go at the bottom of this page and interwikis go in Wikidata. -->
+
<!-- Categories go at the end of this page and interwikis links 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:
 
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>
 
:<code>This sentence needs clarification.{{Tlx|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 code text will cause the tag {{Clarify}} to appear inline. 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}}:
 
;{{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.
+
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}}:
 
;{{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.
+
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 a [[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 straight double quotes <code>"</code>. Instead, use curly quotes <code>“ ”</code>, or use the code <code>&amp;quot;</code> if it is essential to include straight double quotes.
  
;Other:
+
;Others:
 
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>
Line 32: Line 35:
 
:<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 40: Line 44:
 
"label": "reason",
 
"label": "reason",
 
"type": "string",
 
"type": "string",
"description": "A brief reason for the tag; do not include any double quotes."
+
"description": "A brief reason for the tag; do not include any straight double quotes."
 
},
 
},
 
"date": {
 
"date": {
 
"label": "date",
 
"label": "date",
 
"type": "string",
 
"type": "string",
"description": "The date the tag was added (this will be added automatically soon by a bot if not added manually)"
+
"description": "The date the tag was added (this will be added automatically soon by a bot if not added manually)."
 
},
 
},
 
"pre-text": {
 
"pre-text": {
 
"label": "pre-text",
 
"label": "pre-text",
 
"type": "string",
 
"type": "string",
"description": "Any string to be added before the \"Clarify\" tag, such as \"?\""
+
"description": "Any string to be added before the \"Clarify\" tag, such as \"?\"."
 
},
 
},
 
"post-text": {
 
"post-text": {
 
"label": "post-text",
 
"label": "post-text",
 
"type": "string",
 
"type": "string",
"description": "Any string to be added after the \"Clarify\" tag, such as \"Complicated jargon\""
+
"description": "Any string to be added after the \"Clarify\" tag, such as \"Complicated jargon\"."
 
}
 
}
 
}
 
}
Line 70: Line 74:
  
 
== See also ==
 
== See also ==
 +
 
;Inline
 
;Inline
 
* {{tl|Ambiguous}}
 
* {{tl|Ambiguous}}
Line 82: Line 87:
 
* {{tl|Confusing section}}
 
* {{tl|Confusing section}}
  
;Other
+
;Others
 
* [[Wikipedia:Citing sources]]
 
* [[Wikipedia:Citing sources]]
 
* [[Wikipedia:Explain jargon]]
 
* [[Wikipedia:Explain jargon]]
Line 88: Line 93:
  
 
{{Inline tags}}
 
{{Inline tags}}
 +
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
<!-- Categories go here and interwikis go in Wikidata. -->
+
 
 +
<!-- Categories go here and interwikis links go in Wikidata. -->
 
[[Category:Coherency templates|{{PAGENAME}}]]
 
[[Category:Coherency templates|{{PAGENAME}}]]
 
[[Category:Inline cleanup templates|{{PAGENAME}}]]
 
[[Category:Inline cleanup templates|{{PAGENAME}}]]
 +
 
}}</includeonly>
 
}}</includeonly>

Revision as of 19:28, 10 June 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 in-line template, place the template immediately after the material in question, as one would do with a footnote. For example:

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

This code text will cause the tag[clarification needed] to appear inline. 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 a 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 straight double quotes ". Instead, use curly quotes “ ”, or use the code &quot; if it is essential to include straight double quotes.

Others

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 straight double quotes.

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

  • {{Clarification needed}}
  • {{Clarify me}}
  • {{Define?}}
  • {{How?}}
  • {{Huh}}
  • {{What}}

See also

Inline
Message boxes
Others