Template:Highlight/doc

From Gentoo Wiki
Jump to:navigation Jump to:search
Note
This page is a template. It contains some standardized, often used text, which can be transcluded inside other pages. As this template is widely used in our wiki, it may be protected in which case only staff members can change it. Use the discussion page to propose enhancements or fixes, or to voice your opinion.

This template highlights text in a different color. The default is green.

Parameters

Parameter name Required? Default value Description
Anonymous parameter 1 Yes (n/a) text to be highlighted
color No green CSS/HTML color or value to use

The value of color must be a proper CSS/HTML color name or value. For example, red, #FF0000, #f00, and rgb(255,0,0) can all be used to specify red.

Usage

{{Highlight|text}}

See the template's testcases:


Correct

One anonymous parameter
Wiki code
{{Highlight|notice me}}
Main version
notice me
Sandbox version


Specifying the color (anonymous parameter and named parameter color)
Wiki code
{{Highlight|me too|color=red}}
Main version
me too
Sandbox version


Incorrect

No parameter (results in an empty <span> element)
Wiki code
{{Highlight}}
Main version
Sandbox version