Difference between revisions of "Template:Highlight/doc"

From blackwiki
Jump to navigation Jump to search
imported>Fuhghettaboutit
m (Fuhghettaboutit moved page Template:Hilite/doc to Template:Highlight/doc: Requested move; see talk page)
imported>Fuhghettaboutit
(Fix name in documentation, in conformity with move)
Line 6: Line 6:
 
=== Usage ===
 
=== Usage ===
  
<code><nowiki>{{hilite | text | color (optional) | expiration (optional) }}</nowiki></code>
+
<code><nowiki>{{highlight | text | color (optional) | expiration (optional) }}</nowiki></code>
  
 
'''Parameters'''
 
'''Parameters'''
Line 24: Line 24:
 
! code !! output !! notes
 
! code !! output !! notes
 
|-
 
|-
| <nowiki>{{hilite | text }}</nowiki> || {{hilite | text }} || The default highlight color is yellow
+
| <nowiki>{{highlight | text }}</nowiki> || {{highlight | text }} || The default highlight color is yellow
 
|-
 
|-
| <nowiki>{{hilite | text | lightblue }}</nowiki> || {{hilite | 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>{{hilite | text | pink | 2011-01-01 }}</nowiki> || {{hilite | text | pink | 2011-01-01 }} || This is not highlighted since 1 January 2011 is in the past
+
| <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>{{hilite | text | pink |</nowiki> {{CURRENTYEAR}}-{{CURRENTMONTH}}-{{CURRENTDAY2}} <nowiki>}}</nowiki> || {{hilite | 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 | 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>{{hilite | text | #00FF00 | 1 January 2099 }}</nowiki> || {{hilite | 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
 
|-
 
|-
| <nowiki>{{hilite | text || January 1, 2099 }}</nowiki> || {{hilite | text || January 1, 2099 }} || Note the color parameter, left blank, is still represented<br> with a pipe (followed by the expiration parameter pipe)
+
| <nowiki>{{highlight | text || January 1, 2099 }}</nowiki> || {{highlight | text || January 1, 2099 }} || Note the color parameter, left blank, is still represented<br> with a pipe (followed by the expiration parameter pipe)
 
|}
 
|}
  

Revision as of 20:27, 27 December 2015

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 | 2025-12-29 }} 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}} – redirects to this template
  • {{Highlight round}} – highlights the included text using a rounded box with shadows
  • {{tq}} – for quoting text on talk pages
  • {{font color}}