Template:Clarify/doc

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. For sentences that are simply ungrammatical or awkwardly written, rather than unclear in their content, use awkward. 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
 * Like all inline templates, this Clarify template allows a date parameter which records when the clarify tag was added. If the date parameter was not included when this template was added, the date parameter will automatically 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 substitution technique also works if other parameters –  reason pre-text post-text –  are included.


 * reason
 * Because it may not be immediately apparent to other readers and / or editors what the specific reason the tagged passage is in need of clarification, it is generally helpful to add a brief reason for the Clarify tag:  (this is preferable to using an HTML   after the tag, as it is tidier to keep all of the -related code inside the template).  If the request reason would be lengthy, use the article's talk page to address the issue in detail.
 * As well as being visible in the source code for readers and editors' benefit, the  parameter is, if provided, displayed as a pop-up when the mouse is hovered over the 'clarification needed' link in the article.


 * text
 * The particular text needing clarification may be highlighted within the prose by wrapping this Clarify template around it:
 * As an example:
 * Understandable text preceding the template,  understandable text following the template.
 * produces:
 * Understandable text preceding the template, understandable text following the template.
 * Please note: when using this  parameter, please ensure you leave a space before starting the template code.


 * pre-text
 * post-text
 * One can specify additional text to appear before and / or after the displayed 'clarification needed' tag using either (or both) the two parameters listed above.
 * Examples follow:
 * will cause the text 'remove or' to appear before 'clarification needed' like this:
 * will cause '(complicated jargon)' to appear after 'clarification needed' 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 'clarification needed' 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:

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, as they will be converted to plain text in the 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": " ", "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\"." }	} }

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