Difference between revisions of "Template:Box-header"

Latest revision as of 15:26, 22 March 2021

{{{title}}}

Template documentation[view] [edit] [history] [purge]

This template is used on approximately 5,500 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:

Module:Box-header

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...]] }}

edit

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.
— William Shakespeare

more...

Primary parameters

editpage – by default, the "edit" link applies to the page named Template:Box-header/. 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.

Tracking categories

Colour combinations with poor accessibility (i.e. that are not MOS:COLOR-compliant) are tracked in the following categories:

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

Template:Box-header/1

{{{1}}}

Template:Box-header/2

{{{1}}}

Template:Box-header/3

{{{1}}}

H30

Template:Box-header/4

{{{1}}}

Template:Box-header/5

{{{1}}}

Template:Box-header/6

{{{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

Template:Box-header/7

{{{1}}}

Template:Box-header/8

{{{1}}}

Template:Box-header/9

{{{1}}}

H60

Template:Box-header/10

{{{1}}}

Template:Box-header/11

{{{1}}}

Template:Box-header/12

{{{1}}}

H90

Template:Box-header/13

{{{1}}}

Template:Box-header/14

{{{1}}}

Template:Box-header/15

{{{1}}}

H120

Template:Box-header/16

{{{1}}}

Template:Box-header/17

{{{1}}}

Template:Box-header/18

{{{1}}}

H150

Template:Box-header/19

{{{1}}}

Template:Box-header/20

{{{1}}}

Template:Box-header/21

{{{1}}}

H180

Template:Box-header/22W

{{{1}}}

Template:Box-header/22

{{{1}}}

Template:Box-header/23

{{{1}}}

Template:Box-header/24

{{{1}}}

H210

Template:Box-header/25

{{{1}}}

Template:Box-header/26

{{{1}}}

Template:Box-header/27

{{{1}}}

H240

Template:Box-header/28W

{{{1}}}

Template:Box-header/28

{{{1}}}

Template:Box-header/29

{{{1}}}

Template:Box-header/30

{{{1}}}

H270

Template:Box-header/31

{{{1}}}

Template:Box-header/32

{{{1}}}

Template:Box-header/33

{{{1}}}

H300

Template:Box-header/34

{{{1}}}

Template:Box-header/35

{{{1}}}

Template:Box-header/36

{{{1}}}

H330

Template:Box-header/37

{{{1}}}

Template:Box-header/38

{{{1}}}

Template:Box-header/39

{{{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

Template:Box-header/40W

{{{1}}}

Template:Box-header/40

{{{1}}}

Template:Box-header/41

{{{1}}}

Template:Box-header/42

{{{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

<templatedata> { "params": { "border-type": { "required": false, "label": "Border-type" }, "titleborder": { "required": false, "label": "Titleborder" }, "border": { "required": false, "label": "Border" }, "border-top": { "required": false, "label": "Border-top" }, "border-width": { "required": false, "label": "Border-width" }, "titlebackground": { "required": false, "label": "Titlebackground" }, "titleforeground": { "required": false, "label": "Titleforeground" }, "padding": { "required": false, "label": "Padding" }, "padding-top": { "required": false, "label": "Padding-top" }, "padding-left": { "required": false, "label": "Padding-left" }, "padding-right": { "required": false, "label": "Padding-right" }, "padding-bottom": { "required": false, "label": "Padding-bottom" }, "title-align": { "required": false, "label": "Title-align" }, "font-family": { "required": false, "label": "Font-family" }, "titlefont-size": { "required": false, "label": "Titlefont-size" }, "EDITLINK": { "required": false, "label": "EDITLINK" }, "font-size": { "required": false, "label": "Font-size" }, "noedit": { "required": false, "label": "Noedit" }, "editpage": { "required": false, "label": "Editpage" }, "section": { "required": false, "label": "Section" }, "viewpage": { "required": false, "label": "Viewpage" }, "top": { "required": false, "label": "Top" }, "SPAN": { "required": false, "label": "SPAN" }, "title-font-family": { "required": false, "label": "Title-font-family" }, "title-font-size": { "required": false, "label": "Title-font-size" }, "title-font-weight": { "required": false, "label": "Title-font-weight" }, "extra": { "required": false, "label": "Extra" }, "title": { "required": true, "label": "Title" }, "background": { "required": false, "label": "Background" }, "background-opacity": { "required": false, "label": "Background-opacity" }, "foreground": { "required": false, "label": "Foreground" }, "text-align": { "required": false, "label": "Text-align" }, "TOC": { "required": false, "label": "TOC" }, "EDIT": { "required": false, "label": "EDIT" }, "title-border-radius": { "label": "Title's border radius", "example": "1.5em 1.5em 0 0", "type": "string" }, "border-radius": { "label": "Content's border radius", "example": "0 0 1.5em 1.5em", "type": "string" } } } </templatedata>

v t e Portal templates
Visual overview of template usage
Layout and formatting	{{Box portal skeleton}} {{Box-header}} color palettes plain round square watch {{Box-header colour}}¹ {{Box-footer}} {{Flex columns}} {{Plain navboxes}}
Content transclusion	{{Transclude lead excerpt}}² {{Transclude linked excerpt}}² {{Transclude list item excerpt}}² {{Transclude random excerpt}}² {{Transclude selected excerpt}}² {{Excerpt}} {{Transclude DYK}}⁹ {{Transclude selected current events}}³ {{Transclude selected recent additions}}⁴
Content slideshows	{{Random slideshow}}⁵ {{Transclude files as random slideshow}}⁵ {{Transclude excerpts as random slideshow}}⁶ {{Transclude linked excerpts as random slideshow}}⁶ {{Transclude list item excerpts as random slideshow}}⁶
Content randomisation	{{Random portal component}}⁷ {{Random quotation}} {{Random subpage}}
General	{{Portals}} {{Portals browsebar}} {{Portal description}} {{Portal information sidebar}} {{Portal navbar no header2}} {{Purge link portals}} {{Wikimedia for portals}}
Linking templates	{{Portal}} {{Portal bar}} {{Portal-inline}}¹¹ {{Related portals}} {{Related portals2}}
Talk pages / Maintenance	{{Portal talk}} {{Portal maintenance status}}⁸ {{Portal suggestions}} {{Portal toolbox}} {{WikiProject Portals}}⁸
Images	{{Portal dynamic image}} {{Portal image banner}}¹⁰ {{Portal pictures}}¹² {{Portal POTD}}
Modules	¹ Module:Box-header ² Module:Excerpt/portals ³ Module:Selected current events ⁴ Module:Selected recent additions ⁵ Module:Random slideshow ⁶ Module:Excerpt slideshow ⁷ Module:Random portal component ⁸ Module:Portal maintenance status ⁹ Module:Transclude DYK ¹⁰ Module:Portal image banner ¹¹ Module:Portal-inline ¹² Module:Portal pictures
Usage	Wikipedia:Portal Wikipedia:WikiProject Portals
For more information, see: Category:Template-Class Portal pages and Category:Wikipedia Portal templates

Difference between revisions of "Template:Box-header"

Latest revision as of 15:26, 22 March 2021

{{{title}}}

Usage

Syntax

Sample

The Quotes of Quotes

Primary parameters

Behaviour options

Styling options

See also

Tracking categories

Box-header color palettes

H0

{{{1}}}

{{{1}}}

{{{1}}}

H30

{{{1}}}

{{{1}}}

{{{1}}}

H60

{{{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

{{{1}}}

{{{1}}}

{{{1}}}

{{{1}}}

See also

Navigation menu

Search