Template:Example needed/sandbox
This is the template sandbox page for Template:Example needed (diff). See also the companion subpage for test cases. |
This template is used on many pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
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 |reason=
parameter, or on the talk page.
This template is a 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
[edit]This is an inline template which should be placed immediately after the material in question, as with a footnote. For example:
This sentence needs an example.{{example needed|date=December 2024}}
→ This sentence needs clarification.[example needed]- The wikilink on "example needed" is set to WP:AUDIENCE.
(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 {{Better example needed}}
template for when an example already exists but where you feel it should be improved.)
Parameters
[edit]- Abbreviated parameter sets
{{example needed|date=December 2024}}
{{example needed|date=December 2024|plural=yes}}
{{example needed|date=December 2024|reason= }}
{{example needed|date=December 2024|reason= |text= }}
- Full parameter set
{{example needed|date=December 2024|reason= |text= |pre-text= |post-text= |plural=|link=}}
- Parameter descriptions
|plural=
- Synonymous with
pl
,s
when used as the unnamed first parameter. Can also be invoked with the named parameterplural=yes
|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 bot. Alternatively, you may add the date automatically (without requiring bot intervention) by substituting the template. That is:
{{subst:Example needed}}
is equivalent to{{Example needed|date=December 2024}}
. 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 examples, it is generally helpful to add a brief reason for the tag:
{{Example needed|reason=What the problem is}}
(this is preferable to using an HTML<!-- comment -->
after the tag, as it is tidier to keep all of the{{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
reason
parameter is, if provided, displayed as a pop-up when the mouse is hovered over the 'example needed' link in the article.
|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,
{{Example needed|text=this is some text needing examples,|date=December 2024}}
and this is some understandable text following the template.
- This is some understandable text preceding the template,
- produces:
- This is some understandable text preceding the template, this is some text needing examples,[example needed] and this is some understandable text following the template.
- As an example:
- Please note: when using this
text=
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 'example needed' tag using either (or both) the two parameters listed above.
- Examples follow:
{{Example needed|pre-text=reference or}}
- will cause the text 'remove or' to appear before 'example needed' like this:[reference or example needed]
{{Example needed|post-text=(obscure)}}
- will cause '(obscure)' to appear after 'example needed' like this:[example needed (obscure)]
{{Example needed|post-text=(see [[Talk:Example#Example needed|talk]])}}
- can be used to link to a discussion on the article's talk page; this example produces:[example needed (see talk)]
|link=
- Used to specify the link on the "examples needed" text. For example:
{{Example needed|link=WP:EXAMPLES}}
- will produce: [example needed]
Examples
[edit]- 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.
- 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
[edit]- {{Exemplify}}
- {{For example?}}
- {{Like what?}}
- {{Such as?}}
- Also known as... – list of templates that redirect here and may also be used
TemplateData
[edit]Use this inline template to indicate that one or more examples are needed for the preceding statement.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Plural | 1 | Specifies whether multiple examples are needed
| String | optional |
Month and year | date | Provides a month and year for categorisation
| String | suggested |