Template:Clarify/doc

Basic purpose
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.
 * The wikilink on "clarification needed" is set to Please clarify.

Parameters

 * Abbreviated parameter sets:




 * Full parameter set:




 * 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: is equivalent to . 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:  (this is preferable to using a HTML   after the tag, as it is tidier to keep all of the -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  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   if it is essential to include a double quote.


 * text : The particular text needing clarification may be highlighted by wrapping this template around it:
 * As an example:
 * Text preceding the template,, text following the template.
 * produces:
 * Text preceding the template,, 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:
 * will cause 3 question marks to appear before "clarify" like this:
 * will cause "(complicated jargon)" to appear after "clarify" like this:.
 * can be used to link to a discussion on the article's talk page; this example produces:
 * will cause "(complicated jargon)" to appear after "clarify" like this:.
 * can be used to link to a discussion on the article's talk page; this example produces:
 * can be used to link to a discussion on the article's talk page; this example produces:

Template data
{	"description":"", "params": { "reason": { "label": "reason", "type": "string", "description": "A brief reason for the tag; do not include any double quotes." },		"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)." },		"pre-text": { "label": "pre-text", "type": "string", "description": "Any string to be added before the \"Clarify\" tag, such as \"?\"" },		"post-text": { "label": "post-text", "type": "string", "description": "Any string to be added after the \"Clarify\" tag, such as \"complicated jargon\"." }	} }

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