Template:Box-header/doc
| 40px | This is a documentation subpage for Template:Box-header. It contains usage information, categories and other content that is not part of the original template page. |
| 40px | This template is used on approximately 5,400 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. |
| 30px | This template uses Lua: |
Usage
A template standardizing the portal templates and for other purposes. If used for other purposes, note that if the TOC and EDIT parameters are missing or not set to yes, the table of contents and all section editing will be suppressed.
Syntax
The template is not a stand-alone template and so once the box header is typed or pasted the template Box-footer must immediately follow it.
This example assumes that you have a separate page containing the content, and transclude it onto the page.
{{Box-header
| title=
| editpage= <!-- This data must be the same -->
| noedit=
| titleforeground=
| titlebackground=
| background=
| viewpage= <!-- This data must be the same -->
}}
{{ <!-- This data must be the same --> }}
{{Box-footer | text }}
This example assumes that the content is entered between the header and footer. Notice that viewpage is not in there. It will not work because it links to the page you are on, and therefore Wikipedia does not link it.
{{Box-header
| title=
| editpage= <!-- This field must be the same as the name of the page it is on. -->
| titleforeground=
| titlebackground=
| background=
}}
Box Content
{{Box-footer | text }}
Sample
{{Box-header
| title= The Quotes of Quotes
| editpage= Box-header/sample
| titleforeground= white
| titlebackground= red
| background= white
}}
{{Box-header/sample}}
{{Box-footer| [[William Shakespeare|more...]] }}
The Quotes of Quotes
Doubt thou the stars are fire. Doubt that the sun doth move. Doubt truth to be a liar. But never doubt my love.
Primary parameters
- editpage – by default, the "edit" link applies to the page named Template:Box-header/doc/. Use this parameter to specify a different page to edit. This will normally be the page where the
{{Box-header}}is used. - noedit – by default, an "edit" link is shown towards the right-hand side. Specify
|noedit=yes(or any non-blank value) to hide this. The "edit" link is also hidden if|EDITLINK=is non-blank. - section – by default, the "edit" link applies to the whole page. Use this parameter to specify the number of a specific section, e.g.
|section=2 - title – the title of the box, for example
|title=Portals - top – extra text to display after the "edit" and "view" links. Hidden if
|EDITLINK=is non-blank. - viewpage – if non-blank, this should be a valid Wikipedia page name, it creates a "view" link after the "edit" link. Hidden if
|EDITLINK=is non-blank.
Behaviour options
- EDIT – by default, all section edit links are suppressed. Set
|EDIT=yes(or any non-blank value) to override this. - EDITLINK – set
|EDITLINK=no(or any non-blank value) to hide the "edit" and "view" links, and the text after those - SPAN – by default, the box title is enclosed in
<h2>...</h2>tags. Set|SPAN=yes(or any non-blank value) to use<span>...</span>tags instead. - TOC – by default, the table of contents is suppressed. Set
|TOC=yes(or any non-blank value) to override this.
Styling options
- background –
- background-opacity –
- border –
- border-top –
- border-type –
- border-width –
- extra –
- font-family –
- font-size –
- foreground –
- padding –
- padding-top –
- padding-left –
- padding-right –
- padding-bottom –
- text-align –
- title-align –
- titlebackground –
- titleborder –
- title-font-family –
- title-font-size –
- titlefont-size –
- title-font-weight –
- titleforeground –
- title-border-radius –
- border-radius –
These are all used to set CSS styling properties, in many cases the property of the same name – for instance, |background= is used to set the 'background' property.
See also
{{Box-footer}}
Tracking categories
Colour combinations with poor accessibility (i.e. that are not MOS:COLOR-compliant) are tracked in the following categories:
- Category:Box-header with insufficient title contrast
- Category:Box-header with insufficient body contrast
Box-header color palettes
The following box-headers are examples of HSV color palettes arranged by hue. They can be copied to your portal's /box-header subpage, or used directly on the portal page (preferred). Note that the second parameter for the edit link is optional; if not defined then no link will be displayed.
Border: Hn/S15/V75 • Background: Hn/S4/V100 • Header 1: Hn/S40/V85 • Header 2: Hn/S15/V95 • Header 3: Hn/S10/V100
H0
{{{1}}}
{{{1}}}
{{{1}}}
H30
{{{1}}}
{{{1}}}
{{{1}}}
H60
Border: H60/S15/V75 • Background: H60/S4/V100 • Header 1: H60/S40/V100 • Header 2: H60/S15/V100 • Header 3: H60/S10/V100
{{{1}}}
{{{1}}}
{{{1}}}
H60
{{{1}}}
{{{1}}}
{{{1}}}
H90
{{{1}}}
{{{1}}}
{{{1}}}
H120
{{{1}}}
{{{1}}}
{{{1}}}
H150
{{{1}}}
{{{1}}}
{{{1}}}
H180
{{{1}}}
{{{1}}}
{{{1}}}
{{{1}}}
H210
{{{1}}}
{{{1}}}
{{{1}}}
H240
{{{1}}}
{{{1}}}
{{{1}}}
{{{1}}}
H270
{{{1}}}
{{{1}}}
{{{1}}}
H300
{{{1}}}
{{{1}}}
{{{1}}}
H330
{{{1}}}
{{{1}}}
{{{1}}}
H0 S0
Border: H0/S0/V75 • Background: H0/S0/V100 • Header 1: H0/S0/V75 • Header 2: H0/S0/V85 • Header 3: H0/S0/V95
{{{1}}}
{{{1}}}
{{{1}}}
{{{1}}}
TemplateData
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. Click here to see a monthly parameter usage report for this template based on this TemplateData.
TemplateData for Box-header No description.
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
See also
Main portal creation templates
- {{Basic portal start page}} (deleted)—Used to create portal main pages.
- {{Random portal component}}—Used on the portal main page to randomly display articles from the portal sub-pages.
- {{Random subpage}}—Used on the portal main page to randomly display articles from the portal sub-pages. This template is best used for creating randomly populated Did you know... sections on the portal main page that are intended to include multiple Did you know... facts.
- {{Portal subpage}}—Used to output a box containing a link to subpage.
- {{Numbered subpages}}—Used to create article links on portal sub-pages.
- {{Random box-header subpage}}—Used to transclude a numbered subpage.
Main portal page formatting templates
- {{Box-header}}
- {{Box-header-plain}}
- {{Box-header-round}}
- {{Box-header-square}}
- {{Box-header-watch}}
- {{Box-footer}}
Templates that configure links
- {{Portal}}
- {{Portal bar}}
- {{Portal-inline}}
- {{Portals}}
- {{Portal-image}}
- {{Portals browsebar}}
- {{Related portals}}
- {{Related portals2}}
- {{Wikimedia for portals}}
Related templates
