Template:Box-header/doc

From finiki, the Canadian financial wiki

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  -->
| 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= Template:529 Plan box
| titleforeground= white
| titlebackground= red
| background= white
}}

{{Box-header/sample}}

{{Box-footer| [[Template:Credit card box|more...]] }}

The Quotes of Quotes

is a fact of life for most adult Canadians. Credit cards can be useful for purchasing, however they should be used wisely. When you apply for a credit card, you agree to charges such as annual fees, and terms and conditions such as credit limits, interest rates, and grace periods. You should know the Terms and Conditions of the credit cards you are using. Credit card issuing companies are also subject to rules on what they can and cannot do, and what must appear on your monthly statement.

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

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.

Box-header color palettes

See Template:Box-header on Wikipedia for a comprehensive selection of color palettes.

Template:Box-header/25 is based on the H210 palette.

See also