 | This is a documentation subpage for Template:Box-header colour. It may contain usage information, categories and other content that is not part of the original template page. |
 | This template is used on approximately 2,900 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. |
 | This template uses Lua: |
This template can be used to easily create a box-header with MOS:COLOUR-compliant colours. It is intended to mainly be used in portals, but can also be used elsewhere.
Usage
Basic:
{{Box-header colour | Title | colour= | mode= }}
With an edit link:
{{Box-header colour | Title | Page to be edited | colour= | mode= }}
Parameters
|1=(or first unnamed parameter)- Title to show in box header
|2=(or second unnamed parameter)- Optional: the target page for the edit link.
- If not included, no edit link will be shown.
|colour=(or|color=)- Optional: Base colour to use when calculating appropriate colours. May either be a hue value (a number between
0and359), or a X11 colour name (likeaqua), or a hex triplet (like#92cor#6956D7) - If not specified, a "random" colour will be chosen (based on the characters in the root page name)
|mode=- Optional: How light or dark the calculated title background colour should be. Either
lightest,light,normal,dark, ordarkest - Defaults to "normal" if not specified.
Other parameters that are accepted by Template:Box-header can also be used in this template, apart from the following (which will be ignored if specified):
- title
- editpage
- noedit
- border
- titleforeground
- titlebackground
- foreground
- background
