Template:Example needed/doc: Difference between revisions

Revision as of 19:10, 24 January 2013

Latest revision as of 21:15, 2 December 2024

(26 intermediate revisions by 14 users not shown)

Line 1:

{{Documentation subpage}}

{{High use}}

<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

<!----PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE---->

Use this template in the [[body text]] where you believe an example is needed in an article, or that some line of reasoning would greatly benefit from an example. Strongly consider explaining why and how in the <code>|reason=</code> parameter, or on the talk page.

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. It also adds articles to [[:Category:Articles needing examples]] or a dated subcategory of it.

=== Usage ===

== Usage ==

{{No documentation}}

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:

: <code> This sentence needs an example.{{tlp|example needed|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} </code> → This sentence needs clarification.{{egn|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}

::The wikilink on "example needed" is set to [[WP:AUDIENCE]].

=== Redirects ===

(If there already is an example, just not one that meets your standards (in some way), use this template and explain in the reason parameter, an edit summary, or on the talk page. There isn't a specific {{tlx|Better example needed}} template for when an example already exists but where you feel it should be improved.)

* {{tl|Like what?}}

==Parameters==

;Abbreviated parameter sets:

: {{tlx|example needed|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}

: {{tlx|example needed|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=plural=yes}}

:{{tlx|example needed|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason=&nbsp;}}

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

;Full parameter set:

:{{tlx|example needed|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|3=reason=&nbsp;|4=text=&nbsp;|5=pre-text=&nbsp;|6=post-text=&nbsp;|7=plural=|8=link=}}

;Parameter descriptions

;{{Para|plural}}

:Synonymous with <code>pl</code>, <code>s</code> when used as the unnamed first parameter. Can also be invoked with the named parameter <code>plural=yes</code>

;{{Para|date}}

:Like all inline templates, this template allows a date parameter which records when the 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 [[WP:BOT|bot]]. Alternatively, you may add the date automatically (without requiring bot intervention) by [[WP:SUBST|substituting]] the template. That is: {{tlxs|Example needed}} is equivalent to {{tlx|Example needed|2=date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}}}. This substitution technique also works if other parameters{{snd}} {{para|reason}} {{para|pre-text}} {{para|post-text}}{{snd}} are included.

;{{Para|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 examples, it is generally helpful to add a brief reason for the tag: <code><nowiki>{{Example needed|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|Example needed}}-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 <code>reason</code> parameter is, if provided, displayed as a pop-up when the mouse is hovered over the 'example needed' link in the article.<!-- For technical reasons, this mouse-over pop-up 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 examples may be highlighted within the prose by wrapping this template around it:

::As an example:

:::''This is some understandable text preceding the template'', <code>{{tlp|Example needed|text{{=}}this is some text needing examples,|date{{=}}{{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}}</code> ''and this is some understandable text following the template''.

::produces:

:::''This is some understandable text preceding the template'', {{Example needed|text=this is some text needing examples,|date={{CURRENTMONTHNAME}}&nbsp;{{CURRENTYEAR}}}} ''and this is some understandable text following the template''.

:Please note: when using this <code>text=</code> parameter, please ensure you leave a '''space''' before starting the template code.

;{{Para|pre-text}}

;{{Para|post-text}}

:One can specify additional text to appear before and / or after the displayed 'example needed' tag using either (or both) the two parameters listed above.

::Examples follow:

:#<code><nowiki>{{Example needed|pre-text=reference or}}</nowiki></code>

:#:will cause the text 'remove or' to appear <u>before</u> 'example needed' like this:{{Example needed|pre-text=reference or}}

:#<code><nowiki>{{Example needed|post-text=(obscure)}}</nowiki></code>

:#:will cause '(obscure)' to appear <u>after</u> 'example needed' like this:{{Example needed|post-text=(obscure)}}

:#<code><nowiki>{{Example needed|post-text=(see [[Talk:Example#Example needed|talk]])}}</nowiki></code>

:#:can be used to link to a discussion on the article's [[talk page]]; this example produces:{{Example needed|post-text=(see [[Talk:Example#Example needed|talk]])}}

;{{Para|link}}

:Used to specify the link on the "examples needed" text. For example:

:<code><nowiki>{{Example needed|link=WP:EXAMPLES}}</nowiki></code>

::will produce: {{Example needed|date={{CURRENTMONTHNAME}} {{CURRENTYEAR}}|link=WP:EXAMPLES}}

== Examples ==

{{Box|Responding to the Presidential mandate, professional organizations began to support the effort via further promulgation of Decade of the Brain materials, and Decade of the Brain lectures became commonplace at annual meetings of prominent scientific communities.^{[examples needed]}}}

::Here the example editor likely thinks the article would be improved if at least some Decade of the Brain lectures were added. The talk page or edit summary may contain more.

{{Box|The alveolar ejective fricative (sʼ) is used in Lakota language words.^{[example needed]}}}

::Here the example editor probably would like to see at least one Lakotan word that uses the alveolar ejective fricative. The talk page or edit summary may contain more.

== Redirects ==

{{div col}}

* {{tl|Exemplify}}

* {{tl|For example?}}

* {{tl|Like what?}}

* {{tl|Such as?}}

{{div col end}}

* {{Talias}}

=== SeeTemplateData also ===

<!-- needs updating as of 2024 edits -->

* Similar to {{tl|Examples}}, but with a different link.

<templatedata>

{

"description": "Use this inline template to indicate that one or more examples are needed for the preceding statement.",

"format": "inline",

"params": {

"1": {

"label": "Plural",

"example": "s",

"autovalue": "s",

"type": "string",

"description": "Specifies whether multiple examples are needed"

},

"date": {

"label": "Month and year",

"description": "Provides a month and year for categorisation",

"type": "string",

"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",

"example": "January 2013",

"suggested": true

}

}

}

</templatedata>

== See also ==

<includeonly>

{{Inline tags |collapsed}}

<includeonly>{{Sandbox other||

[[Category:Templates needing substitution checking]]

<!------CATEGORIES BELOW THIS LINE, PLEASE:------->

[[Category:Inline cleanup templates]]

[[Category:Templates needing substitution checking]]

[[mk:Шаблон:Се бара пример]]

}}</includeonly>