Template:Box-header/doc

< Template:Box-header
Revision as of 04:23, 21 April 2022 by Santh (talk | contribs) (1 revision imported)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Template:Box-header/sample

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

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 Template:Box-header/1

Template:Box-header/2 Template:Box-header/2

Template:Box-header/3 Template:Box-header/3

H30

Template:Box-header/4 Template:Box-header/4

Template:Box-header/5 Template:Box-header/5

Template:Box-header/6 Template:Box-header/6

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 Template:Box-header/7

Template:Box-header/8 Template:Box-header/8

Template:Box-header/9 Template:Box-header/9

H60

Template:Box-header/10 Template:Box-header/10

Template:Box-header/11 Template:Box-header/11

Template:Box-header/12 Template:Box-header/12

H90

Template:Box-header/13 Template:Box-header/13

Template:Box-header/14 Template:Box-header/14

Template:Box-header/15 Template:Box-header/15

H120

Template:Box-header/16 Template:Box-header/16

Template:Box-header/17 Template:Box-header/17

Template:Box-header/18 Template:Box-header/18

H150

Template:Box-header/19 Template:Box-header/19

Template:Box-header/20 Template:Box-header/20

Template:Box-header/21 Template:Box-header/21

H180

Template:Box-header/22W Template:Box-header/22W

Template:Box-header/22 Template:Box-header/22

Template:Box-header/23 Template:Box-header/23

Template:Box-header/24 Template:Box-header/24

H210

Template:Box-header/25 Template:Box-header/25

Template:Box-header/26 Template:Box-header/26

Template:Box-header/27 Template:Box-header/27

H240

Template:Box-header/28W Template:Box-header/28W

Template:Box-header/28 Template:Box-header/28

Template:Box-header/29 Template:Box-header/29

Template:Box-header/30 Template:Box-header/30

H270

Template:Box-header/31 Template:Box-header/31

Template:Box-header/32 Template:Box-header/32

Template:Box-header/33 Template:Box-header/33

H300

Template:Box-header/34 Template:Box-header/34

Template:Box-header/35 Template:Box-header/35

Template:Box-header/36 Template:Box-header/36

H330

Template:Box-header/37 Template:Box-header/37

Template:Box-header/38 Template:Box-header/38

Template:Box-header/39 Template:Box-header/39

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 Template:Box-header/40W

Template:Box-header/40 Template:Box-header/40

Template:Box-header/41 Template:Box-header/41

Template:Box-header/42 Template:Box-header/42

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

TemplateData for Box-header

No description.

Template parameters

ParameterDescriptionTypeStatus
Border-typeborder-type

no description

Unknownoptional
Titlebordertitleborder

no description

Unknownoptional
Borderborder

no description

Unknownoptional
Border-topborder-top

no description

Unknownoptional
Border-widthborder-width

no description

Unknownoptional
Titlebackgroundtitlebackground

no description

Unknownoptional
Titleforegroundtitleforeground

no description

Unknownoptional
Paddingpadding

no description

Unknownoptional
Padding-toppadding-top

no description

Unknownoptional
Padding-leftpadding-left

no description

Unknownoptional
Padding-rightpadding-right

no description

Unknownoptional
Padding-bottompadding-bottom

no description

Unknownoptional
Title-aligntitle-align

no description

Unknownoptional
Font-familyfont-family

no description

Unknownoptional
Titlefont-sizetitlefont-size

no description

Unknownoptional
EDITLINKEDITLINK

no description

Unknownoptional
Font-sizefont-size

no description

Unknownoptional
Noeditnoedit

no description

Unknownoptional
Editpageeditpage

no description

Unknownoptional
Sectionsection

no description

Unknownoptional
Viewpageviewpage

no description

Unknownoptional
Toptop

no description

Unknownoptional
SPANSPAN

no description

Unknownoptional
Title-font-familytitle-font-family

no description

Unknownoptional
Title-font-sizetitle-font-size

no description

Unknownoptional
Title-font-weighttitle-font-weight

no description

Unknownoptional
Extraextra

no description

Unknownoptional
Titletitle

no description

Unknownrequired
Backgroundbackground

no description

Unknownoptional
Background-opacitybackground-opacity

no description

Unknownoptional
Foregroundforeground

no description

Unknownoptional
Text-aligntext-align

no description

Unknownoptional
TOCTOC

no description

Unknownoptional
EDITEDIT

no description

Unknownoptional
Title's border radiustitle-border-radius

no description

Example
1.5em 1.5em 0 0
Stringoptional
Content's border radiusborder-radius

no description

Example
0 0 1.5em 1.5em
Stringoptional

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

Templates that configure links

Selected page templates, used on subpages of older portals

Related templates