Jump to content

Template:Highlight/doc: Difference between revisions

From pool
[checked revision][checked revision]
Content deleted Content added
Created page with "{{Documentation subpage}} {{High-risk}} {{Commons Import}} <!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE --> {{Template shortcut|hl|hilite}} For adding..."
 
 
Line 42: Line 42:
=== See also ===
=== See also ===
For more detail see wikipedia page [[wikipedia:Template:Highlight]]
For more detail see wikipedia page [[wikipedia:Template:Highlight]]

=== Template Data ===
<templatedata>
{
"params": {
"1": {
"label": "Text to be highlighted",
"example": "Highlight this text",
"type": "string"
},
"2": {
"label": "Optional Colour",
"example": "lightblue or #ff8c00",
"type": "string"
},
"3": {
"label": "Expiration Date",
"example": "1 January 2099",
"type": "string"
}
},
"description": "Escalation Notice"
}
</templatedata>
[[Category:AutoDumpContentFromCommons]]
</noinclude>


<includeonly>{{Sandbox other||
<includeonly>{{Sandbox other||

Latest revision as of 16:31, 20 October 2020


For adding yellow highlight to specified text. The highlight color can be changed, and the highlight can also be set to expire at a certain date. Please keep template usage to talk pages only.

Usage

{{highlight | text | color (optional) | expiration (optional) }}

Parameters

  • text (parameter 1): Enter the text to be highlighted.

Optional parameters

These parameters are optional, but unused parameters must be separated by a pipe (see examples below):

  • color (parameter 2): Colors may be specified by word (e.g., "red", "blue", "lightgreen") or in hexadecimal format (e.g., "#FF0066", "#C0C0C0"). If no value is given for the color, the template defaults to yellow.
  • expiration (parameter 3): Highlights may be set to expire on a certain date, which leaves the text as-is, but removes the highlight color. The expiration value can be specified in any format.

Examples

code output notes
{{highlight | text }} text The default highlight color is yellow
{{highlight | text | lightblue }} text The second parameter is the highlight color
{{highlight | text | pink | 2011-01-01 }} text This is not highlighted since 1 January 2011 is in the past
{{highlight | text | pink | 2026-04-07 }} text There is no highlighting on the expiration date (purge this page's server cache if today's date is not shown)
{{highlight | text | #00FF00 | 1 January 2099 }} text This is highlighted since 1 January 2099 is in the future
{{highlight | text || January 1, 2099 }} text Note the color parameter, left blank, is still represented
with a pipe (followed by the expiration parameter pipe)

See also

For more detail see wikipedia page wikipedia:Template:Highlight

Template Data

Escalation Notice

Template parameters[Edit template data]

ParameterDescriptionTypeStatus
Text to be highlighted1

no description

Example
Highlight this text
Stringoptional
Optional Colour2

no description

Example
lightblue or #ff8c00
Stringoptional
Expiration Date3

no description

Example
1 January 2099
Stringoptional