Template:Highlight

A checked version of this page, approved on 20 October 2020, was based on this revision.

This content is in the Template Namespace. Used for page-templates that can be re-used across the wiki.

Template documentation[view] [edit] [history] [purge]

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.

Shortcuts

{{hl}}
{{hilite}}

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)

Template Data

Escalation Notice

Template parameters[Edit template data]
Parameter		Description	Type	Status
Text to be highlighted	`1`	no description Example Highlight this text	String	optional
Optional Colour	`2`	no description Example lightblue or #ff8c00	String	optional
Expiration Date	`3`	no description Example 1 January 2099	String	optional

</noinclude>

The above documentation is transcluded from Template:Highlight/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.