Template:Navbox with columns/doc: Difference between revisions
(this explanatory text taken from wowwiki, who in turn took it from en.Wikipedia) |
No edit summary Tag: sourceedit |
||
(4 intermediate revisions by 2 users not shown) | |||
Line 19: | Line 19: | ||
Required parameters in '''bold'''. Parameters marked with a cross'''<sup>†</sup>''' are parameters in common with the sister templates {{t|Navbox}} and {{t|Navbox with collapsible groups}}. A much more complete description of those parameters is available at {{t|Navbox}}. | Required parameters in '''bold'''. Parameters marked with a cross'''<sup>†</sup>''' are parameters in common with the sister templates {{t|Navbox}} and {{t|Navbox with collapsible groups}}. A much more complete description of those parameters is available at {{t|Navbox}}. | ||
===Setup parameters=== | === Setup parameters === | ||
:;name<sup>†</sup> | :;name<sup>†</sup> | ||
::The name of the template. The name of this template, for example, is "Navbox with columns". | ::The name of the template. The name of this template, for example, is "Navbox with columns". | ||
Line 32: | Line 32: | ||
::Possible values are <code>child</code>, <code>none</code>, and the default value of blank. Set to <code>child</code> 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 {{t|Navbox}}, a columns of another {{t|Navbox with columns}}, or a section of {{t|Navbox with collapsible groups}}. See {{t|Navbox}} for more information and examples. | ::Possible values are <code>child</code>, <code>none</code>, and the default value of blank. Set to <code>child</code> 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 {{t|Navbox}}, a columns of another {{t|Navbox with columns}}, or a section of {{t|Navbox with collapsible groups}}. See {{t|Navbox}} for more information and examples. | ||
===Basic data parameters=== | === Basic data parameters === | ||
:;'''''title'''''<sup>†</sup> | :;'''''title'''''<sup>†</sup> | ||
::The title of the template, displayed centered in the titlebar at the top of the template. | ::The title of the template, displayed centered in the titlebar at the top of the template. | ||
Line 48: | Line 48: | ||
::Text or other elements to appear below the columns. | ::Text or other elements to appear below the columns. | ||
===Style parameters=== | === Style parameters === | ||
:;''bodystyle''<sup>†</sup> | :;''bodystyle''<sup>†</sup> | ||
::CSS style/s to apply to the template's body (i.e. including space not used by columns) | ::CSS style/s to apply to the template's body (i.e. including space not used by columns) | ||
Line 68: | Line 68: | ||
::CSS style/s to apply to the ''imageleft'' parameter | ::CSS style/s to apply to the ''imageleft'' parameter | ||
:;'' | :;''colstyle'' | ||
::CSS style/s to apply across all columns; if used, usually <code>background:''color''</code> per ''titlestyle'' above. | ::CSS style/s to apply across all columns; if used, usually <code>background:''color''</code> per ''titlestyle'' above. | ||
Line 87: | Line 87: | ||
::CSS style/s to apply to the n<sup>th</sup> column footer cell. | ::CSS style/s to apply to the n<sup>th</sup> column footer cell. | ||
===Columns parameters=== | === Columns parameters === | ||
:;''colwidth'' | :;''colwidth'' | ||
::Width, preferably in a proportional unit such as '[[wikipedia:Em (typography)|em]]', or as a percentage, used for each column whose width not specified by ''colNwidth'' below. Defaults to 10em. Examples: | ::Width, preferably in a proportional unit such as '[[wikipedia:Em (typography)|em]]', or as a percentage, used for each column whose width not specified by ''colNwidth'' below. Defaults to 10em. Examples: | ||
Line 118: | Line 118: | ||
::A number specifying how many columns the n<sup>th</sup> 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 <code>col1footercolspan = 3</code>, then leave <code>col2footer</code> and <code>col3footer</code> blank. | ::A number specifying how many columns the n<sup>th</sup> 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 <code>col1footercolspan = 3</code>, then leave <code>col2footer</code> and <code>col3footer</code> blank. | ||
===Additional lists=== | === Additional lists === | ||
You may wish to add a few extra lists below the columns. The following parameters are given to provide such functionality. See {{t|Navbox}} for a more complete description of how they work, and for more examples. Groups are not allowed. | You may wish to add a few extra lists below the columns. The following parameters are given to provide such functionality. See {{t|Navbox}} for a more complete description of how they work, and for more examples. Groups are not allowed. | ||
Line 134: | Line 134: | ||
== Examples == | == Examples == | ||
===Basic example=== | === Basic example === | ||
<pre style="overflow:scroll;"> | <pre style="overflow:scroll;"> | ||
{{Navbox with columns | {{Navbox with columns | ||
Line 144: | Line 144: | ||
|above = ''This is where the <nowiki>{{{above}}}</nowiki> would appear.'' | |above = ''This is where the <nowiki>{{{above}}}</nowiki> would appear.'' | ||
|col1 = AUS<br/> BRU<br/> CAM<br/> IND | |col1 = AUS<br /> BRU<br /> CAM<br /> IND | ||
|col2 = IDN<br/> JPN<br/> LAO<br/> MAS | |col2 = IDN<br /> JPN<br /> LAO<br /> MAS | ||
|col3 = MYA<br/> NZL<br/> CHN-PRC<br/> PHI | |col3 = MYA<br /> NZL<br /> CHN-PRC<br /> PHI | ||
|col4 width=17em | |col4 width=17em | ||
|col4 = SIN<br/> KOR<br/> THA<br/> VIE | |col4 = SIN<br /> KOR<br /> THA<br /> VIE | ||
|below = '''Potential future members'''TLS RUS | |below = '''Potential future members'''TLS RUS | ||
Line 162: | Line 162: | ||
|above = ''This is where the <nowiki>{{{above}}}</nowiki> parameter would appear.'' | |above = ''This is where the <nowiki>{{{above}}}</nowiki> parameter would appear.'' | ||
|col1 = AUS<br/> BRU<br/> CAM<br/> IND | |col1 = AUS<br /> BRU<br /> CAM<br /> IND | ||
|col2 = IDN<br/> JPN<br/> LAO<br/> MAS | |col2 = IDN<br /> JPN<br /> LAO<br /> MAS | ||
|col3 = MYA<br/> NZL<br/> CHN-PRC<br/> PHI | |col3 = MYA<br /> NZL<br /> CHN-PRC<br /> PHI | ||
|col4width=17em | |col4width=17em | ||
|col4 = SIN<br/> KOR<br/> THA<br/> VIE | |col4 = SIN<br /> KOR<br /> THA<br /> VIE | ||
|below = '''Potential future members'''TLS RUS | |below = '''Potential future members'''TLS RUS | ||
Line 172: | Line 172: | ||
===Example with percentage widths=== | === Example with percentage widths === | ||
<pre style="overflow:scroll;"> | <pre style="overflow:scroll;"> | ||
{{Navbox with columns | {{Navbox with columns | ||
Line 197: | Line 197: | ||
===Example with col<sub>n</sub>header and col<sub>n</sub>footer=== | === Example with col<sub>n</sub>header and col<sub>n</sub>footer === | ||
The gray background for the columns is added for illustration only. | The gray background for the columns is added for illustration only. | ||
{{Navbox with columns | {{Navbox with columns | ||
Line 223: | Line 223: | ||
}} | }} | ||
===Example to illustrate most fields=== | |||
The gray background and centered text for the columns is for illustration only. The columns default to an off-white background and left text alignment. This example shows how you can use up to six additional groups/lists after the columns. | |||
{{Navbox with columns | |||
|name = Navbox with columns/doc | |||
|state = uncollapsed | |||
|title = Example to illustrate most fields | |||
|colstyle = text-align:center;background:silver; | |||
|col1 = col1 | |||
|col2 = col2 | |||
|col3 = col3 | |||
|col4 = col4 | |||
|col5 = col5 | |||
|col1header = col1header | |||
|col2header = col2header | |||
|col3header = col3header | |||
|col4header = col4header | |||
|col5header = col5header | |||
|col1footer = col1footer | |||
|col2footer = col2footer | |||
|col3footer = col3footer | |||
|col4footer = col4footer | |||
|col5footer = col5footer | |||
|group1 = group1 | |||
|group2 = group2 | |||
|group3 = group3 | |||
|group4 = group4 | |||
|group5 = group5 | |||
|group6 = group6 | |||
|list1 = list1 | |||
|list2 = list2 | |||
|list3 = list3 | |||
|list4 = list4 | |||
|list5 = list5 | |||
|list6 = list6 | |||
|above = above | |||
|below = below | |||
}} | |||
==Using child navboxes== | == Using child navboxes == | ||
All three types of navbox templates, namely {{t|Navbox}}, {{t|Navbox with columns}}, and {{t|Navbox with collapsible groups}}, can be nested inside of one another using the <code>border</code> parameter (which is common to all three). For complex templates, it may be necessary to use nesting to achieve a desired look. | All three types of navbox templates, namely {{t|Navbox}}, {{t|Navbox with columns}}, and {{t|Navbox with collapsible groups}}, can be nested inside of one another using the <code>border</code> parameter (which is common to all three). For complex templates, it may be necessary to use nesting to achieve a desired look. | ||
===Nesting Navbox with columns in itself=== | === Nesting Navbox with columns in itself === | ||
This example shows how one can nest multiple {{t|Navbox with columns}} templates to get the right look. Edit this section to view the code. There is a main {{t|Navbox with columns}} and two additional {{t|Navbox with columns}} templates, with the "child" option set (see code). | This example shows how one can nest multiple {{t|Navbox with columns}} templates to get the right look. Edit this section to view the code. There is a main {{t|Navbox with columns}} and two additional {{t|Navbox with columns}} templates, with the "child" option set (see code). | ||
{{Navbox with columns | {{Navbox with columns | ||
Line 275: | Line 318: | ||
}} | }} | ||
===Nesting other Navbox forms=== | === Nesting other Navbox forms === | ||
This example shows {{t|Navbox}}, {{t|Navbox with collapsible groups}} and {{t|Navbox with columns}} 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 <code>child</code> | This example shows {{t|Navbox}}, {{t|Navbox with collapsible groups}} and {{t|Navbox with columns}} 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 <code>child</code> | ||
{{Navbox with collapsible groups | {{Navbox with collapsible groups | ||
Line 361: | Line 404: | ||
== See also == | == See also == | ||
* {{t|Navbox}} | * {{t|Navbox}} – Allows groups/lists instead of columns | ||
* {{t|Navbox with collapsible groups}} | * {{t|Navbox with collapsible groups}} – Another variation. | ||
<includeonly> | <includeonly> | ||
<!--Categories--> | <!--Categories--> | ||
</includeonly> | </includeonly> | ||
<noinclude>[[category:template documentation|{{PAGENAME}}]]</noinclude> |
Latest revision as of 07:05, 23 December 2015
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
- colstyle
- 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.
|
Example to illustrate most fields
The gray background and centered text for the columns is for illustration only. The columns default to an off-white background and left text alignment. This example shows how you can use up to six additional groups/lists after the columns.
|
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.