Difference between revisions of "Template:Current event inline/doc"

From blackwiki
Jump to navigation Jump to search
imported>SUM1
m (→‎Usage: Heading)
imported>SUM1
(Added to usage and TemplateData)
Line 4: Line 4:
 
== Usage ==
 
== Usage ==
  
This inline template is used to indicate that a statement may be outdated and in need of updating.
+
{{Tlx|Current event inline}} creates {{Current event inline}}.
 +
 
 +
{{Tlx|Current event inline|date{{=}}{{Currentmonthname}} {{Currentyear}}}} creates {{Current event inline|date={{Currentmonthname}} {{Currentyear}}}}.
 +
 
 +
{{Tlx|Current event inline|date{{=}}{{Currentmonthname}} {{Currentyear}}|hide{{=}}y}} creates {{Current event inline|date={{Currentmonthname}} {{Currentyear}}|hide=y}}.
  
 
== Parameters ==
 
== Parameters ==
* {{Param|date}}: The date the tag was added.
+
* {{Param|date}}: The date the tag was added. This gets added to the template text.
 +
* {{Param|hide}}: Enter any text in this parameter to hide the date from the template text. For use in conjunction with "date".
  
 
== TemplateData ==
 
== TemplateData ==
Line 17: Line 22:
 
"date": {
 
"date": {
 
"label": "Month and year",
 
"label": "Month and year",
"description": "Month and year of tagging; e.g., 'January 2013', but not 'jan13'",
+
"description": "Month and year of tagging; e.g., 'January 2013', but not 'jan13'. Adds this to the template text, after 'as of'.",
 
"type": "string",
 
"type": "string",
 
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 
"autovalue": "{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}",
 
"example": "January 2013",
 
"example": "January 2013",
 +
"suggested": true
 +
},
 +
"hide": {
 +
"label": "Hide date from text",
 +
"description": "Enter any text in this parameter to hide the date from the template text. For use in conjunction with 'date'.",
 +
"type": "string",
 +
"example": "y",
 
"suggested": true
 
"suggested": true
 
}
 
}
}
+
},
 +
"paramOrder": [
 +
"date",
 +
"hide"
 +
]
 
}
 
}
 
</templatedata>
 
</templatedata>

Revision as of 19:09, 5 February 2020

Usage

{{Current event inline}} creates [may be outdated].

{{Current event inline|date=December 2025}} creates [may be outdated as of December 2025].

{{Current event inline|date=December 2025|hide=y}} creates [may be outdated].

Parameters

  • {{{date}}}: The date the tag was added. This gets added to the template text.
  • {{{hide}}}: Enter any text in this parameter to hide the date from the template text. For use in conjunction with "date".

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 Current event inline

Use this inline template indicate that a statement may be outdated and in need of updating.

Template parameters

ParameterDescriptionTypeStatus
Month and yeardate

Month and year of tagging; e.g., 'January 2013', but not 'jan13'. Adds this to the template text, after 'as of'.

Example
January 2013
Auto value
{{subst:CURRENTMONTHNAME}} {{subst:CURRENTYEAR}}
Stringsuggested
Hide date from texthide

Enter any text in this parameter to hide the date from the template text. For use in conjunction with 'date'.

Example
y
Stringsuggested