View source for Template:Non sequitur/doc

{{Documentation subpage}}

<!-- Categories at the end of this page, please; interwikis links at Wikidata. -->

{{Caution|Avoid using markup inside the {{para|reason}} parameter, which can corrupt the template's output. }}

== Purpose ==
Use this template in the body of an article as a request for other editors to clarify text that is likely to be confusing to readers because it is a ''[[wikt:non sequitur|non sequitur]]'', especially the introduction of a name, term, or other reference that was not previously mentioned, and the relevance of which is unclear.  This most often happens when material is moved from its original context, in which it made sense, and pasted into an earlier section or into a different page.  It also often happens when a source is quoted as mentioning someone by name, and this name is not linked or explained in the context of the Wikipedia article.

It also frequently happens when new editors used to an academic style use it in Wikipedia, e.g. writing "According to Johnson and Xiang...," without the article ever mentioning these people otherwise.  It is not Wikipedia-normal to "namedrop" in mid-prose in this manner, even if it's a common form of attribution in journals in some fields.  In this respect, encyclopedic writing is closer to news style than academic style: The reader needs to know why a particular person (or company, or whatever) is relevant before they'll understand why it's being mentioned; by contrast, academics in a field probably already know which other researchers are being referred to, and at least understand that the references to them are a short-hand form of citation to things given in detail in the footnotes.  Most of our readers do not care about the footnotes, and Wikipedia content is often [[WP:REUSE|reused]] without them, so our article prose has to stand on its own.
This template is not for material that is probably irrelevant (use {{tlx|relevance inline}}), but for material that probably is relevant, but the relevance of which is confused or confusing.

== Usage ==

This is an [[Wikipedia:WikiProject Inline Templates|inline template]] which should be placed immediately after the material in question, as with a footnote. For example:<br />
{{in5}}<code> A reference to someone or something that needs explanation.{{tlp|non sequitur|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}</code><br />
gives:<br />
{{in5}}A reference to someone or something that needs explanation.{{non sequitur|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}<br />
The wikilink on "''non sequitur''" is set to [[Wikipedia:Please clarify]].

=== Parameters ===

; Abbreviated parameter sets{{colon}} 
:{{tlx|non sequitur |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;}}
:{{tlx|non sequitur |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;}}

; Full parameter set{{colon}}
:{{tlx|non sequitur |2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}&nbsp;|3=reason=&nbsp;|4=text=&nbsp;|5=pre-text=&nbsp;|6=post-text=&nbsp;|7=show=&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|non sequitur}} is equivalent to {{tlx|non sequitur|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This technique also works if other parameters – {{para|reason}} {{para|pre-text}} {{para|post-text}} – are given.
; {{para|reason}}: <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|non sequitur}}-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.
; <span style="font-weight: normal;">{{para|text}} a.k.a. {{para|1}} or first, unnumbered parameter</span>
: The particular text needing clarification may be highlighted by wrapping this template around it:
:* <code>''Text preceding the template'', {{tlp|non sequitur|text{{=}}unclear namedropping,|date{{=}}{{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} ''text following the template''.</code><br />''Text preceding the template'', {{non sequitur|text=unclear namedropping,|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}} ''text following the template''.
:As with any template, if the material to be wrapped contains an equals character (<code>=</code>}, the parameter must be explicitly named or numbered.
; {{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{{colon}}
:* <code><nowiki>{{clarify|pre-text=irrelevant}}</nowiki></code><br />will cause the words "irrelevant or" to appear before "clarify" like this:{{non sequitur|pre-text=irrelevant or}}
:* <code><nowiki>{{clarify|post-text=(complicated jargon)}}</nowiki></code><br />will cause "(mentioned below not above)" to appear after "non sequitur" like this:{{non sequitur|post-text=(mentioned below not above)}}.
:* <code><nowiki>{{clarify|post-text=(see [[Talk:Example#Clarification needed|talk]])}}</nowiki></code><br />can be used to link to a discussion on the article's talk page; this example produces:{{non sequitur|post-text=(see [[Talk:Example#Unexplained namedropping|talk]])}}
; {{para|show}}
: Change the displayed main wording of the template from ''non sequitur'' to something else, e.g. {{para|show|who?}} (the template {{tl|Who2}} is a shortcut wrapper for that particular case).

=== Style ===
When resolving this template, please note that the excessively news-style or "headline-ese" form of explaining a reference, as in "according to historian Jane Doe", is considered substandard by many readers and editors, especially non-North Americans. The more complete form, "according to the historian Jane Doe", is preferred and is acceptable in all dialects of English.  Note also the difference between a clipped reference like "Said Oxford historian Doe, ..." versus the more informative and easier to parse version "According to the historian Jane Doe of Oxford University, ...".  Shortening might be appropriate if Doe and Oxford have previously been mentioned in the article.

=== TemplateData ===
{{Collapse top|[[Wikipedia:TemplateData|TemplateData]] documentation used by [[Wikipedia:VisualEditor|VisualEditor]] and other tools}}
{{TemplateData header|noheader=1}}
<templatedata>
{
	"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.",
			"autovalue": ""
		},
		"date": {
			"label": "Month and year",
			"type": "string",
			"description": "The date the tag was added (this will be added automatically soon by a bot if not added manually).",
			"example": "January 2019",
			"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
			"suggested": true
		},
		"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\"."
		}
	}
}
</templatedata>
{{Collapse bottom}}

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

== Redirects ==

{{startflatlist}}
* {{tlx|nonsequitur}}
* {{tlx|non-sequitur}}
* {{tlx|namedropping}}
* {{tlx|name dropping}}
* {{tlx|name-dropping}}
{{endflatlist}}

== See also ==
{{colbegin|colwidth=25em}}
{|
|'''Related inline templates'''
* {{tl|Context inline}}
* {{tl|Clarify}}
* {{tl|Clarify span}}
* {{tl|Ambiguous}}
* {{tl|Definition}}
* {{tl|Elucidate}}
* {{tl|Vague}}
* {{tl|Who2}}
|}
{|
|'''Message-box templates'''
* {{tl|Context}}
* {{tl|Confusing}}
* {{tl|Confusing section}}
|}
{|
|'''Related pages'''
* [[Wikipedia:Citing sources]]
* [[Wikipedia:Explain jargon]]
* [[Wikipedia:Please clarify]]
|}
{{colend}}
{{Inline tags}}

<includeonly>{{Sandbox other||
<!-- Categories after this line, please; interwikis links at Wikidata. -->
[[Category:Coherency templates]]
[[Category:Inline cleanup templates]]
}}</includeonly>