Difference between revisions of "Template:Example needed span/doc"
Jump to navigation
Jump to search
imported>SUM1 (Formatting) |
imported>Vanisaac m (→See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other) |
||
| (11 intermediate revisions by one other user not shown) | |||
| Line 2: | Line 2: | ||
<!-- Categories and interwikis go at the bottom of this page. --> | <!-- Categories and interwikis go at the bottom of this page. --> | ||
== Usage == | == Usage == | ||
| − | |||
| + | This inline template is used to highlight text that may need one or more examples. | ||
| − | + | :{{Tlx|Example needed-span|''Text needing an example''|date{{=}}''Month and year''}} | |
| − | : {{Tlx|Example needed-span|Lorem ipsum dolor sit amet}} | + | == Parameters == |
| + | |||
| + | * {{para|text}} or {{para|1}} (or an empty parameter): the text that is considered to need one or more examples | ||
| + | * {{para|date}}: the date the tag was added | ||
| + | * {{para|plural}}: enter 'y' or 'yes' to change 'example' to 'examples'. | ||
| + | |||
| + | == Example == | ||
| + | |||
| + | Input: | ||
| + | |||
| + | : {{Tlx|Example needed-span|Lorem ipsum dolor sit amet|date{{=}}{{Currentmonthname}} {{Currentyear}}}} | ||
Result: | Result: | ||
| − | : {{Example needed-span|Lorem ipsum dolor sit amet}} | + | : {{Example needed-span|Lorem ipsum dolor sit amet|date={{Currentmonthname}} {{Currentyear}}}} |
| + | |||
| + | Input with plural setting: | ||
| + | |||
| + | : {{Tlx|Example needed-span|Lorem ipsum dolor sit amet|date{{=}}{{Currentmonthname}} {{Currentyear}}|plural{{=}}y}} | ||
| + | |||
| + | Result: | ||
| + | |||
| + | : {{Example needed-span|Lorem ipsum dolor sit amet|date={{Currentmonthname}} {{Currentyear}}|plural=y}} | ||
| + | |||
| + | == TemplateData == | ||
| + | |||
| + | {{TemplateDataHeader}} | ||
| + | <templatedata> | ||
| + | { | ||
| + | "description": "Use this inline template to highlight text that may need one or more examples.", | ||
| + | "format": "inline", | ||
| + | "params": { | ||
| + | "1": { | ||
| + | "aliases": [ | ||
| + | "text" | ||
| + | ], | ||
| + | "label": "Text needing an example", | ||
| + | "description": "The text that is considered to need one or more examples", | ||
| + | "type": "string", | ||
| + | "required": true | ||
| + | }, | ||
| + | "date": { | ||
| + | "label": "Month and year", | ||
| + | "description": "Month and year of tagging; e.g., 'January 2013', but not 'jan13'", | ||
| + | "type": "string", | ||
| + | "autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}", | ||
| + | "example": "January 2013", | ||
| + | "suggested": true | ||
| + | }, | ||
| + | "plural": { | ||
| + | "label": "Plural", | ||
| + | "description": "Enter 'y' or 'yes' to change 'example' to 'examples'.", | ||
| + | "type": "string", | ||
| + | "autovalue": "y", | ||
| + | "example": "y" | ||
| + | } | ||
| + | }, | ||
| + | "paramOrder": [ | ||
| + | "1", | ||
| + | "date", | ||
| + | "plural" | ||
| + | ] | ||
| + | } | ||
| + | </templatedata> | ||
== See also == | == See also == | ||
| − | * [[:Template:Example needed]] | + | * [[:Template:Example needed]] |
| − | <includeonly> | + | <includeonly>{{Sandbox other|| |
<!-- Categories and interwikis go here: --> | <!-- Categories and interwikis go here: --> | ||
[[Category:Inline cleanup templates|{{PAGENAME}}]] | [[Category:Inline cleanup templates|{{PAGENAME}}]] | ||
| − | </includeonly> | + | }}</includeonly> |
Latest revision as of 04:04, 25 April 2020
| 40px | This is a documentation subpage for Template:Example needed span. It contains usage information, categories and other content that is not part of the original template page. |
Contents
Usage
This inline template is used to highlight text that may need one or more examples.
{{Example needed-span|Text needing an example|date=Month and year}}
Parameters
|text=or|1=(or an empty parameter): the text that is considered to need one or more examples|date=: the date the tag was added|plural=: enter 'y' or 'yes' to change 'example' to 'examples'.
Example
Input:
{{Example needed-span|Lorem ipsum dolor sit amet|date=March 2026}}
Result:
- Lorem ipsum dolor sit amet[example needed]
Input with plural setting:
{{Example needed-span|Lorem ipsum dolor sit amet|date=March 2026|plural=y}}
Result:
- Lorem ipsum dolor sit amet[examples needed]
TemplateData
This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.
TemplateData for Example needed span
Use this inline template to highlight text that may need one or more examples.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text needing an example | 1 text | The text that is considered to need one or more examples | String | required |
| Month and year | date | Month and year of tagging; e.g., 'January 2013', but not 'jan13'
| String | suggested |
| Plural | plural | Enter 'y' or 'yes' to change 'example' to 'examples'.
| String | optional |
See also