Template:Highlight/doc
 | This is a documentation subpage for Template:Highlight. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 8,100 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. |
 | Links should be clearly recognizable as clickable to readers. Avoid using colored links as it may hinder the reader's ability to distinguish links from regular text, particularly coloring links solely for aesthetic purposes. See the Manual of Style accessibility guideline sections on Contrast and Color. |
For adding yellow highlight to specified inline 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
[edit]{{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
[edit]| 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|lightblue|2011-01-01}} | text | This is not highlighted since 1 January 2011 is in the past |
{{highlight|text|lightblue|2026-07-27}} | text | There is no highlighting on the expiration date ( if today's date is not shown) |
{{highlight|text|#00FF00|1 January 2076}} | text | This is highlighted since 1 January 2076 is in the future |
{{highlight|text||January 1, 2076}} | text | Note the color parameter, left blank, is still represented with a pipe (followed by the expiration parameter pipe) |
See also
[edit]- {{Highlight round}} – highlights the included text using a rounded box with shadows
- {{tq}} – for quoting text on talk pages
- {{font color}}
Highlights the given text.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Text to be highlighted | 1 text | no description
| Content | required |
| Highlight color | 2 color | CSS color to be used for highlight, like lightblue or #FF0066
| Unknown | optional |
| Expiration date of highlight | 3 expiration | After this date, the text will remain but the highlight color will not display.
| Date | optional |