Template:Navbox with columns/doc: Difference between revisions
m (Bot: Adding <noinclude>{{PAGENAME}}</noinclude>) |
m (Protected "Template:Navbox with columns/doc": Robot: Protecting all pages from category templates ([edit=sysop] (indefinite) [move=sysop] (indefinite))) |
(No difference)
|
Revision as of 02:05, 13 May 2013
A navigation box that presents its content in columns. Originally intended to provide a relatively straightforward means to align links prefixed by flag icons, e.g. in templates offering links to country articles.
Basic syntax
Only required parameters and colwidth included.
{{Navbox with columns |name = {{subst:PAGENAME}} |title = |colwidth = <!--(to set a default width for each column, preferably in a proportional unit such as 'em'*)--> |col1 = |col2 = }}
Parameters
Required parameters in bold. Parameters marked with a cross† are parameters in common with the sister templates Template:T and Template:T. A much more complete description of those parameters is available at Template:T.
Setup parameters
- name†
- The name of the template. The name of this template, for example, is "Navbox with columns".
- state†
- Possible values are
collapsed
,uncollapsed
,plain
,off
, and the defaultautocollapse
. See Template:T for more information.
- navbar†
- Possible values are
plain
,off
, and the default value of blank. See Template:T for more information.
- border†
- Possible values are
child
,none
, and the default value of blank. Set tochild
if you wish to use the navbox inside of another navbox; with this option, the child navbox is borderless and fits snuggly inside of its parent navbox. The parent navbox may be the list area of Template:T, a columns of another Template:T, or a section of Template:T. See Template:T for more information and examples.
Basic data parameters
- title†
- The title of the template, displayed centered in the titlebar at the top of the template.
- above†
- Text or other elements to appear above the columns.
- image†
- Image to the right of all of the columns.
- imageleft†
- Image to the left of all of the columns.
- below†
- Text or other elements to appear below the columns.
Style parameters
- bodystyle†
- CSS style/s to apply to the template's body (i.e. including space not used by columns)
- abovestyle†
- belowstyle†
- CSS style/s to apply to the above and below parameters, respectively.
- basestyle†
- CSS style/s to apply to the title, above, and below, parameters, all at the same time.
- imagestyle†
- CSS style/s to apply to the image parameter.
- imageleftstyle†
- CSS style/s to apply to the imageleft parameter
- colsstyle
- CSS style/s to apply across all columns; if used, usually
background:color
per titlestyle above.
- oddcolstyle
- evencolstyle
- CSS style/s to apply to all odd/even-numbered columns, respectively.
- colnstyle
- CSS style/s to apply to the nth column only.
- colheaderstyle
- CSS style/s to apply to all column headers.
- colnheaderstyle
- CSS style/s to apply to the nth column header.
- colnfooterstyle
- CSS style/s to apply to the nth column footer cell.
Columns parameters
- colwidth
- Width, preferably in a proportional unit such as 'em', or as a percentage, used for each column whose width not specified by colNwidth below. Defaults to 10em. Examples:
colwidth = 15em
colwidth = 25%
- fullwidth
- If set to anything, then the total width of the columns are scaled linearly to make the sum of the widths 100%. A rather advanced parameter, this usually need not be used and should be left blank. If a colheader or colfooter is used, then fullwidth is used automatically. Example:
fullwidth = true
- padding
- Padding before first column, preferably in a proportional unit. Defaults to 5em. Padding is disabled by setting it to 0 (or 0em, or 0%).
- colnwidth
- The nth column's width (overrides colwidth above).
- coln
- The content of the nth column.
col1
is required. There can be a maximum of 20 columns.
- colnheader
- A header cell for the nth column that appears above the column. See below for examples.
- colnfooter
- A footer cell that appears below the nth column.
- colnheadercolspan
- A number specifying how many columns the nth column header should span. It defaults to 1. If it is greater than one, then do not specify column headers that it covers. For example, if
col1headercolspan = 3
, then leavecol2header
andcol3header
blank.
- colnfootercolspan
- A number specifying how many columns the nth column footer should span. It defaults to 1. If it is greater than one, then do not specify column footers that it covers. For example, if
col1footercolspan = 3
, then leavecol2footer
andcol3footer
blank.
Additional lists
You may wish to add a few extra lists below the columns. The following parameters are given to provide such functionality. See Template:T for a more complete description of how they work, and for more examples. Groups are not allowed.
- listn†
- Allows up to 6 additional lists below the columns.
- liststyle†
- The general CSS style/s for the lists.
- listnstyle†
- CSS style/s for the nth list parameter.
- listpadding†
- Amount of padding to have in each list cell.
Examples
Basic example
{{Navbox with columns |name = East Asia Summit (EAS) |title = Member states of the East Asia Summit (EAS) |width = 18.25em |padding = 10em |above = ''This is where the {{{above}}} would appear.'' |col1 = AUS<br /> BRU<br /> CAM<br /> IND |col2 = IDN<br /> JPN<br /> LAO<br /> MAS |col3 = MYA<br /> NZL<br /> CHN-PRC<br /> PHI |col4 width=17em |col4 = SIN<br /> KOR<br /> THA<br /> VIE |below = '''Potential future members'''TLS RUS }}
|
Example with percentage widths
{{Navbox with columns | name = Plastics | title = Plastics | colwidth = 33% | colstyle = text-align: center | col1 = Polyethylene (PE)<br />Polyethylene terephthalate (PET or PETE)<br />Polyvinyl chloride (PVC)<br />Polyvinylidene chloride (PVDC)<br />Polylactic acid (PLA) | col2 = Polypropylene (PP)<br />Polyamide (PA)<br />Polycarbonate (PC)<br />Polytetrafluoroethylene (PTFE)<br />Polyurethane (PU) | col3 = Polystyrene (PS)<br /> Polyester<br /> Acrylonitrile butadiene styrene (ABS)<br /> Polymethyl methacrylate (PMMA)<br /> Polyoxymethylene (POM) }}
|
The gray background for the columns is added for illustration only.
|
All three types of navbox templates, namely Template:T, Template:T, and Template:T, can be nested inside of one another using the border
parameter (which is common to all three). For complex templates, it may be necessary to use nesting to achieve a desired look.
This example shows how one can nest multiple Template:T templates to get the right look. Edit this section to view the code. There is a main Template:T and two additional Template:T templates, with the "child" option set (see code).
|
This example shows Template:T, Template:T and Template:T all working together. Press the edit button for the section to view the code. Note that each of the child navboxes has the first parameter set to child
|
See also
- Template:T – Allows groups/lists instead of columns
- Template:T – Another variation.