Difference between revisions of "Template:Highlight/doc"

From blackwiki
Jump to navigation Jump to search
imported>BrandonXLF
imported>Iketsi
m (Using lightblue as above, as keeping the color constant makes for a clearer explanation. Some users might think something is wrong with pink.)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->
{{Template shortcut|h|hl|hilite}}
+
{{Template shortcut|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.
 
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.
  
Line 28: Line 28:
 
| <nowiki>{{highlight | text | lightblue }}</nowiki> || {{highlight | text | lightblue }} || The second parameter is the highlight color
 
| <nowiki>{{highlight | text | lightblue }}</nowiki> || {{highlight | text | lightblue }} || The second parameter is the highlight color
 
|-
 
|-
| <nowiki>{{highlight | text | pink | 2011-01-01 }}</nowiki> || {{highlight | text | pink | 2011-01-01 }} || This is not highlighted since 1 January 2011 is in the past
+
| <nowiki>{{highlight | text | lightblue | 2011-01-01 }}</nowiki> || {{highlight | text | lightblue | 2011-01-01 }} || This is not highlighted since 1 January 2011 is in the past
 
|-
 
|-
| <nowiki>{{highlight | text | pink |</nowiki> {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} <nowiki>}}</nowiki> || {{highlight | text || {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}}}} || There is no highlighting on the expiration date ({{Purge|purge this page's server cache}} if today's date is not shown)
+
| <nowiki>{{highlight | text | lightblue |</nowiki> {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} <nowiki>}}</nowiki> || {{highlight | text || {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}}}} || There is no highlighting on the expiration date ({{Purge|purge this page's server cache}} if today's date is not shown)
 
|-
 
|-
 
| <nowiki>{{highlight | text | #00FF00 | 1 January 2099 }}</nowiki> || {{highlight | text | #00FF00 | 1 January 2099 }} || This is highlighted since 1 January 2099 is in the future
 
| <nowiki>{{highlight | text | #00FF00 | 1 January 2099 }}</nowiki> || {{highlight | text | #00FF00 | 1 January 2099 }} || This is highlighted since 1 January 2099 is in the future
Line 42: Line 42:
 
* {{tl|font color}}
 
* {{tl|font color}}
  
<includeonly>
+
<includeonly>{{Sandbox other||
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
<!-- CATEGORIES AND INTERWIKIS HERE, THANKS -->
 
[[Category:Typing-aid templates]]
 
[[Category:Typing-aid templates]]
 
[[Category:Text color templates]]
 
[[Category:Text color templates]]
</includeonly>
+
}}</includeonly>

Latest revision as of 04:30, 7 December 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 | lightblue | 2011-01-01 }} text This is not highlighted since 1 January 2011 is in the past
{{highlight | text | lightblue | 2026-01-01 }} text There is no highlighting on the expiration date (Script error: No such module "Purge". 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

  • {{Highlight round}} – highlights the included text using a rounded box with shadows
  • {{tq}} – for quoting text on talk pages
  • {{font color}}