Plantilya:Box-header/doc

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= #36c
| background= white
}}

{{Box-header/sample}}

{{Box-footer| [[William Shakespeare|more...]] }}

The Quotes of Quotes

Primary parameters

• editpage – by default, the "edit" link applies to the page named Plantilya: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 (i.e. that are not -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

H60

Border: H60/S15/V75 • Background: H60/S4/V100 • Header 1: H60/S40/V100 • Header 2: H60/S15/V100 • Header 3: H60/S10/V100

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

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly error report for this template.

TemplateData for Box-header

No description.

Template parameters

Parameter		Description	Type	Status
Border-type	border-type	no description	Unknown	optional
Titleborder	titleborder	no description	Unknown	optional
Border	border	no description	Unknown	optional
Border-top	border-top	no description	Unknown	optional
Border-width	border-width	no description	Unknown	optional
Titlebackground	titlebackground	no description	Unknown	optional
Titleforeground	titleforeground	no description	Unknown	optional
Padding	padding	no description	Unknown	optional
Padding-top	padding-top	no description	Unknown	optional
Padding-left	padding-left	no description	Unknown	optional
Padding-right	padding-right	no description	Unknown	optional
Padding-bottom	padding-bottom	no description	Unknown	optional
Title-align	title-align	no description	Unknown	optional
Font-family	font-family	no description	Unknown	optional
Titlefont-size	titlefont-size	no description	Unknown	optional
EDITLINK	EDITLINK	no description	Unknown	optional
Font-size	font-size	no description	Unknown	optional
Noedit	noedit	no description	Unknown	optional
Editpage	editpage	no description	Unknown	optional
Section	section	no description	Unknown	optional
Viewpage	viewpage	no description	Unknown	optional
Top	top	no description	Unknown	optional
SPAN	SPAN	no description	Unknown	optional
Title-font-family	title-font-family	no description	Unknown	optional
Title-font-size	title-font-size	no description	Unknown	optional
Title-font-weight	title-font-weight	no description	Unknown	optional
Extra	extra	no description	Unknown	optional
Title	title	no description	Unknown	required
Background	background	no description	Unknown	optional
Background-opacity	background-opacity	no description	Unknown	optional
Foreground	foreground	no description	Unknown	optional
Text-align	text-align	no description	Unknown	optional
TOC	TOC	no description	Unknown	optional
EDIT	EDIT	no description	Unknown	optional
Title's border radius	title-border-radius	no description Example 1.5em 1.5em 0 0	String	optional
Content's border radius	border-radius	no description Example 0 0 1.5em 1.5em	String	optional