Difference between revisions of "Template:Example needed span/doc"

From blackwiki
Jump to navigation Jump to search
imported>SUM1
(Formatting)
imported>SUM1
(Additions and added TemplateData)
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 ==
{{Tlx|Example needed-span|Text needing an example}}
 
  
 +
This inline template is used to highlight text that may need one or more examples.
  
For example:
+
:{{Tlx|Example needed-span|Text needing an example|date{{=}}Month and year}}
  
: {{Tlx|Example needed-span|Lorem ipsum dolor sit amet}}
+
== Parameters ==
 +
 
 +
* {{param|date}}: The date the tag was added
 +
* {{param|text}} or {{param|1}} (empty): The text that is considered to need one or more examples
 +
 
 +
== Example ==
 +
 
 +
Input:
 +
 
 +
: {{Tlx|Example needed-span|Lorem ipsum dolor sit amet|date{{=}}January 2013}}
  
 
Result:
 
Result:
  
: {{Example needed-span|Lorem ipsum dolor sit amet}}
+
: {{Example needed-span|Lorem ipsum dolor sit amet|date=January 2013}}
 +
 
 +
== TemplateData ==
 +
 
 +
{{TemplateDataHeader}}
 +
<templatedata>
 +
{
 +
"description": "Use this inline template to highlight text that may need one or more examples.",
 +
"params": {
 +
"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
 +
        },
 +
"1": {
 +
"aliases": [
 +
"text"
 +
],
 +
"label": "Text needing examples",
 +
"description": "The text that is considered to need one or more examples",
 +
"type": "string",
 +
"required": true
 +
}
 +
}
 +
}
 +
</templatedata>
  
 
== See also ==
 
== See also ==

Revision as of 13:12, 5 February 2020

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

  • {{{date}}}: The date the tag was added
  • {{{text}}} or {{{1}}} (empty): The text that is considered to need one or more examples

Example

Input:

{{Example needed-span|Lorem ipsum dolor sit amet|date=January 2013}}

Result:

Lorem ipsum dolor sit amet[example 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.

Template parameters

ParameterDescriptionTypeStatus
Month and yeardate

Month and year of tagging; e.g., 'January 2013', but not 'jan13'

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
Text needing examples1 text

The text that is considered to need one or more examples

Stringrequired

See also