Difference between revisions of "Template:Clarify/doc"

From blackwiki
Jump to navigation Jump to search
imported>Redrose64
m (Reverted edits by Yashvora43 (talk) to last version by Amalthea)
imported>Debresser
(Update.)
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
  
 
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==
 
This is an [[WP:ILT|in-line template]], place the template immediately after the material in question, as one would do with a footnote. For example:
 
  
:<code><nowiki>This sentence needs clarification.{{clarify}}</nowiki></code>
+
== 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:
  
The above text will cause the tag {{clarify}} to appear inline. This tag is linked to [[Wikipedia:Please clarify]] for further information.
+
:<code>This sentence needs clarification.{{Tlx|Clarify|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code>
  
===Categorisation===
+
The above text will cause the tag {{Clarify}} to appear inline. The tag links to [[Wikipedia:Please clarify]] for further information.
Adding this template to an article will automatically place the article into [[:Category:Wikipedia articles needing clarification]].
+
 
 +
=== Categorisation ===
 +
 
 +
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.
+
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]].
<!-- The following appears to have no effect or is not implemented: This helps with the categorisation of articles requiring citations.
 
If this template is added without the date parameter, the date parameter will be added soon after by a [[WP:BOT|bot]].  Thus, one can just add <code><nowiki>{{clarify}}</nowiki></code> and let the bot handle the date.
 
-->
 
 
 
One can specify the date manually. For example, to date the tag in the current month, enter <code><nowiki>{{clarify|date=</nowiki>{{CURRENTMONTHNAME}} {{CURRENTYEAR}}<nowiki>}}</nowiki></code>.  Even more simply, one can simply use <code><nowiki>{{subst:clarify}}</nowiki></code> to get the same result.
 
  
 
;{{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>{{subst: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 more tidy to keep all of the {{tlx|clarify}}-related code inside the template). The <code>reason</code> parameter is not displayed or otherwise acted upon by the template; it is simply present in the source code for editors' benefit. 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>{{subst: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 more tidy to keep all of the {{Tlx|Clarify}}-related code inside the template). The <code>reason</code> parameter is not displayed or otherwise acted upon by the template; it is simply present in the source code for editors' benefit. If the explanation would be lengthy, use the article's talk page.
  
 
;Other:
 
;Other:
 
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>
 +
 
 +
== Redirects ==
  
==Redirects==
+
* {{Tl|Huh}}
The alternative names {{tl|huh}}, {{tl|what}}, {{tl|how?}}, {{tl|clarify me}} and {{tl|clarifyme}} are all redirects to this template.
+
* {{Tl|What}}
 +
* {{Tl|How?}}
 +
* {{Tl|Clarify me}}
 +
* {{Tl|Clarifyme}}
  
==See also==
+
== See also ==
*[[Template:Ambiguous]]
+
* [[Template:Ambiguous]]
*[[Template:Confusing]]
+
* [[Template:Confusing]]
*[[Template:Definition]]
+
* [[Template:Definition]]
*[[Template:Elucidate]]
+
* [[Template:Elucidate]]
*[[Wikipedia:Citing sources]]
+
* [[Wikipedia:Citing sources]]
*[[Wikipedia:Explain jargon]]
+
* [[Wikipedia:Explain jargon]]
*[[Wikipedia:Please clarify]]
+
* [[Wikipedia:Please clarify]]
  
 
<includeonly>
 
<includeonly>

Revision as of 21:23, 10 December 2011

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}}

The above 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.

|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: {{subst:Clarify|reason=what the problem is}} (this is preferable to using an HTML <!--comment--> after the tag, as it is more tidy to keep all of the {{Clarify}}-related code inside the template). The reason parameter is not displayed or otherwise acted upon by the template; it is simply present in the source code for editors' benefit. If the explanation would be lengthy, use the article's talk page.

Other

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]])}}

Redirects

See also