View source for Template:Clarify/doc

{{Documentation subpage}}
<!-- Categories at the end of this page, please; interwikis links at Wikidata. -->
{{Caution|style=margin-bottom:1.0em; |Avoid using wikilinks. These can (and, with {{para|reason}}, will) corrupt the template's output. }}

Use this template in the body of an article as a request for other editors to clarify text that is difficult to understand. For dealing with dubious information, please use one of the following: {{tl|citation needed}} or {{tl|dubious}}. 

== Usage ==
This is an inline template which should be placed immediately after the material in question, as with a footnote. For example:
: <code> This sentence needs clarification.{{tlp|clarify|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} </code> → This sentence needs clarification.{{clarify|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}
::The wikilink on "clarification needed" is set to [[w:Wikipedia:Please clarify]]. 

== Parameters ==
; Abbreviated parameter sets: 

:{{tlx|clarify |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;}}
:{{tlx|clarify |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;}}

; Full parameter set: 

:{{tlx|clarify |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;|5=pre-text=&nbsp;|6=post-text=&nbsp;}}

;Parameter descriptions

; {{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{{snd}} {{para|reason}} {{para|pre-text}} {{para|post-text}}{{snd}} 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.
: 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 mouse-over 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. (Seems to no longer be a problem, since ca. 2015) -->

; {{para|text}} : The particular text needing clarification may be highlighted by wrapping this template around it:
:: As an example:
::: ''Text preceding the template'', <code>{{tlp|clarify|text{{=}}unclear text,|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}</code> ''text following the template''. 
:: produces: 
::: ''Text preceding the template'', {{clarify|text=unclear text,|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} ''text following the template''.

; {{para|pre-text}}
; {{para|post-text}} : One can specify additional text to appear before and/or after the "clarify" tag using the two parameters listed above. 
::Examples follow:
:# <code><nowiki>{{clarify|pre-text=remove or}}</nowiki></code>
:#:will cause the text "remove or" to appear before "clarify" like this:{{clarify|pre-text=remove or}}
:# <code><nowiki>{{clarify|post-text=(complicated jargon)}}</nowiki></code>
:#:will cause "(complicated jargon)" to appear after "clarify" like this:{{clarify|post-text=(complicated jargon)}}
:# <code><nowiki>{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}</nowiki></code>
:#:can be used to link to a discussion on the article's talk page; this example produces:{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}

== TemplateData ==
{{TemplateData header}}
<templatedata>
{
	"description": {
		"en": "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.",
		"fr": "Utilisez ce modèle en ligne pour demander aux autres éditeurs de préciser un texte difficile à comprendre. A placer juste après l'élément concerné."
	},
	"params": {
		"reason": {
			"label": {
				"en": "Reason",
				"fr": "Motif"
			},
			"type": "string",
			"description": {
				"en": "A brief reason for the tag. Avoid using wikilinks; these will corrupt the template's output.",
				"fr": "Une brève explication de la présence de cette balise Evitez d'utiliser des liens wiki cela va perturber la sortie du modèle."
			},
			"suggested": true
		},
		"text": {
			"label": {
				"en": "Text",
				"fr": "Texte"
			},
			"type": "string",
			"description": {
				"en": "Text fragment containing concerns the tag is supposed to address.",
				"fr": "Fragment du texte concerné sujet à confusion."
			}
		},
		"date": {
			"label": {
				"en": "Date",
				"fr": "Date"
			},
			"type": "string",
			"description": {
				"en": "The date the tag was added (this will be added automatically soon by a bot if not added manually).",
				"fr": "Date à laquelle la balise a été ajoutée (sera inséré automatiquement bientôt par un robot s'il elle n'a pas été mise manuellement)"
			},
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true
		},
		"pre-text": {
			"label": {
				"en": "Pre-text",
				"fr": "Avant texte"
			},
			"type": "string",
			"description": {
				"en": "Any string to be added before the \"Clarify\" tag, such as \"?\"",
				"fr": "Texte libre à placer avant la balise \"Clarify\""
			},
			"example": {
				"fr": "\"quoi ?\""
			}
		},
		"post-text": {
			"label": {
				"en": "Post-text",
				"fr": "Après texte"
			},
			"type": "string",
			"description": {
				"en": "Any string to be added after the \"Clarify\" tag, such as \"complicated jargon\".",
				"fr": "Texte libre à ajouter après la balise \"Clarify\"."
			},
			"example": {
				"fr": "\"jargon pas très clair\"."
			}
		}
	}
}
</templatedata>

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

{{Inline tags}}