Difference between revisions of "Template:Navbox with columns/doc"
[unchecked revision] | [unchecked revision] |
(→Parameters: doc update) |
(→Example with colnheader and colnfooter: adding colspan example) |
||
(12 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | <includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude> | ||
− | + | {{Navbox suite}} | |
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. | 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. | ||
Line 19: | Line 19: | ||
== Parameters == | == Parameters == | ||
− | Required parameters in '''bold'''. Parameters marked with a cross'''<sup>†</sup>''' are parameters in common with the sister | + | Required parameters in '''bold'''. Parameters marked with a cross'''<sup>†</sup>''' are parameters in common with the sister templates {{t1|Navbox}} and {{t1|Navbox with collapsible groups}}. A much more complete description of those parameters is available at {{t1|Navbox}}. |
===Setup parameters=== | ===Setup parameters=== | ||
:;name<sup>†</sup> | :;name<sup>†</sup> | ||
− | ::The name of the template. The name of this template, for example, is " | + | ::The name of the template. The name of this template, for example, is "Navbox with columns". |
:;state<sup>†</sup> | :;state<sup>†</sup> | ||
Line 32: | Line 32: | ||
:;''border''<sup>†</sup> | :;''border''<sup>†</sup> | ||
− | ::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 {{t1|Navbox}}, a columns of another {{t1|Navbox with columns}}, or a section of {{t1|Navbox with collapsible | + | ::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 {{t1|Navbox}}, a columns of another {{t1|Navbox with columns}}, or a section of {{t1|Navbox with collapsible groups}}. See {{t1|Navbox}} for more information and examples. |
===Basic data parameters=== | ===Basic data parameters=== | ||
Line 70: | Line 70: | ||
::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 94: | Line 94: | ||
:::<code>colwidth = 15em</code> | :::<code>colwidth = 15em</code> | ||
:::<code>colwidth = 25%</code> | :::<code>colwidth = 25%</code> | ||
+ | |||
+ | :;''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: | ||
+ | :::<code>fullwidth = true</code> | ||
:;''padding'' | :;''padding'' | ||
Line 102: | Line 106: | ||
:;'''''col<sub>n</sub>''''' | :;'''''col<sub>n</sub>''''' | ||
− | ::The content of the n<sup>th</sup> column. <code>col1</code> is required. There can be a maximum of 20 columns. | + | ::The content of the n<sup>th</sup> column. If any columns are used, then <code>col1</code> is required. There can be a maximum of 20 columns. |
:;''col<sub>n</sub>header'' | :;''col<sub>n</sub>header'' | ||
Line 119: | Line 123: | ||
You may wish to add a few extra lists below the columns. The following parameters are given to provide such functionality. See {{t1|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 {{t1|Navbox}} for a more complete description of how they work, and for more examples. Groups are not allowed. | ||
− | :;''list<sub>n</sub>'' | + | :;''list<sub>n</sub>''<sup>†</sup> |
::Allows up to 6 additional lists below the columns. | ::Allows up to 6 additional lists below the columns. | ||
− | :;''liststyle'' | + | :;''liststyle''<sup>†</sup> |
::The general CSS style/s for the lists. | ::The general CSS style/s for the lists. | ||
− | :;''list<sub>n</sub>style'' | + | :;''list<sub>n</sub>style''<sup>†</sup> |
::CSS style/s for the n<sup>th</sup> list parameter. | ::CSS style/s for the n<sup>th</sup> list parameter. | ||
+ | |||
+ | :;''listpadding''<sup>†</sup> | ||
+ | ::Amount of padding to have in each list cell. | ||
== Examples == | == Examples == | ||
Line 219: | Line 226: | ||
}} | }} | ||
+ | ===Example with col<sub>n</sub>header using col<sub>n</sub>headercolspan=== | ||
+ | The gray background for the columns is added for illustration only. | ||
+ | {{Navbox with columns | ||
+ | |name = Navbox with columns/doc | ||
+ | |state = uncollapsed | ||
+ | |title = col<sub>n</sub>header with col<sub>n</sub>colspan example | ||
+ | |||
+ | |colstyle = text-align:center;background:silver; | ||
+ | |||
+ | |col1header = col1header | ||
+ | |col2header = col2header (colspan=2) | ||
+ | |col4header = col4header | ||
+ | |col5header = col5header (colspan=3) | ||
+ | |||
+ | |col2headercolspan = 2 | ||
+ | |col5headercolspan = 3 | ||
+ | |||
+ | |col1 = col1 | ||
+ | |col2 = col2 | ||
+ | |col3 = col3 | ||
+ | |col4 = col4 | ||
+ | |col5 = col5 | ||
+ | |col6 = col6 | ||
+ | |col7 = col7 | ||
+ | }} | ||
==Using child navboxes== | ==Using child navboxes== | ||
− | All three types of navbox templates, namely {{t1|Navbox}}, {{t1|Navbox with columns}}, and {{t1|Navbox with collapsible | + | All three types of navbox templates, namely {{t1|Navbox}}, {{t1|Navbox with columns}}, and {{t1|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=== | ||
Line 271: | Line 303: | ||
===Nesting other Navbox forms=== | ===Nesting other Navbox forms=== | ||
− | This example shows {{t1|Navbox}}, {{t1|Navbox with collapsible | + | This example shows {{t1|Navbox}}, {{t1|Navbox with collapsible groups}} and {{t1|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 |
− | |name = Navbox with collapsible | + | |name = Navbox with collapsible groups |
− | |title = Navbox, Navbox with columns, and Navbox with collapsible | + | |title = Navbox, Navbox with columns, and Navbox with collapsible groups together |
|selected = {{{1|}}} | |selected = {{{1|}}} | ||
− | | | + | |group1 = [[:Category:Scouting|The Scouting Movement]] |
− | | | + | |abbr1 = movement |
− | | | + | |list1 = [[Scouting]]{{·}}''[[Scouting for Boys]]''{{·}}[[Scout method]]{{·}}[[Scout Law]]{{·}}[[Scout Promise]]{{·}}[[Scout Motto]]{{·}}[[Wood Badge]]{{·}}[[Age groups in Scouting and Guiding]]{{·}}[[Cub Scout]]{{·}}[[Boy Scout]]{{·}}[[Rover Scout]]{{·}}[[Brownie (Girl Guides)|Brownie]]{{·}}[[Girl Guiding and Girl Scouting]]{{·}}[[Ranger (Girl Guide)]]{{·}}[[Jamboree (Scouting)|Jamboree]]{{·}}[[Scout Leader]]{{·}}[[World Organization of the Scout Movement|WOSM]]{{·}}[[World Association of Girl Guides and Girl Scouts|WAGGGS]]{{·}}[[Non-aligned Scouting and Scout-like organisations|Non-aligned organisations]]{{·}}[[Scouting controversy and conflict]]{{·}}[[Scouting in popular culture]]{{·}}[[List of Scouts]]{{·}}[[List of highest awards in Scouting]] |
− | | | + | |list2 = {{Navbox|child |
|title = [[French colonial empires|Former French colonies]] in [[Africa]] and the [[Indian Ocean]] | |title = [[French colonial empires|Former French colonies]] in [[Africa]] and the [[Indian Ocean]] | ||
|titlestyle = background# | |titlestyle = background# | ||
Line 306: | Line 338: | ||
}} | }} | ||
− | | | + | |group3 = [[:Category:Scouting in the United Kingdom|Scouting in the United Kingdom]] |
− | | | + | |abbr3 = Scouting |
− | | | + | |list3 = [[The Scout Association]]{{·}}[[Girlguiding UK]]{{·}}[[Beaver Scouts]]{{·}}[[Cub Section (UK)]]{{·}}[[Venture Scout]]{{·}}[[Explorer Scouts]]{{·}}[[Brownie (Girl Guides)]]{{·}}[[Ranger (Girl Guide)]]{{·}}[[Rainbow (Girl Guides)]]{{·}}[[Scout Network]]{{·}}[[Chief Scout (United Kingdom)]]{{·}}[[Scout Counties]]{{·}}[[Scout District]]{{·}}[[Scout Section (UK)]]{{·}}[[Scout Activity Centre]]{{·}}[[Young Leaders (The Scout Association)|Young Leaders]] |
− | | | + | |list4 = {{Navbox with columns|child |
|title = Navbox with columns nested in itself | |title = Navbox with columns nested in itself | ||
|colstyle = text-align:center; | |colstyle = text-align:center; | ||
Line 357: | Line 389: | ||
== See also == | == See also == | ||
* {{t1|Navbox}} – Allows groups/lists instead of columns | * {{t1|Navbox}} – Allows groups/lists instead of columns | ||
− | * {{t1|Navbox with collapsible | + | * {{t1|Navbox with collapsible groups}} – Another variation. |
{{Navigational templates}} | {{Navigational templates}} | ||
Line 367: | Line 399: | ||
<!--Other languages--> | <!--Other languages--> | ||
+ | [[fr:Modèle:Méta palette de navigation avec colonnes]] | ||
[[ja:Template:Navbox with columns]] | [[ja:Template:Navbox with columns]] | ||
[[mk:Шаблон:Navbox with columns]] | [[mk:Шаблон:Navbox with columns]] | ||
+ | [[pl:Szablon:Navbox z kolumnami]] | ||
[[sl:Predloga:Navigacija s stolpci]] | [[sl:Predloga:Navigacija s stolpci]] | ||
+ | [[uk:Шаблон:Navbox with columns]] | ||
</includeonly> | </includeonly> |
Latest revision as of 22:29, 13 July 2008
Template:Template doc page viewed directly
|
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[edit]
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[edit]
Required parameters in bold. Parameters marked with a cross† are parameters in common with the sister templates {{Navbox}} and {{Navbox with collapsible groups}}. A much more complete description of those parameters is available at {{Navbox}}.
Setup parameters[edit]
- 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 {{Navbox}} for more information.
- navbar†
- Possible values are
plain
,off
, and the default value of blank. See {{Navbox}} 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 {{Navbox}}, a columns of another {{Navbox with columns}}, or a section of {{Navbox with collapsible groups}}. See {{Navbox}} for more information and examples.
Basic data parameters[edit]
- 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[edit]
- 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[edit]
- 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. If any columns are used, then
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[edit]
You may wish to add a few extra lists below the columns. The following parameters are given to provide such functionality. See {{Navbox}} 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[edit]
Basic example[edit]
{{Navbox with columns |name = East Asia Summit (EAS) |title = Member states of the [[East Asia Summit|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}} |col4width=17em |col4 = {{SIN}}<br/> {{KOR}}<br/> {{THA}}<br/> {{VIE}} |below = '''Potential future members'''{{spaces|6}}{{TLS}}{{spaces|3}}{{RUS}} }}
|
Example with percentage widths[edit]
{{Navbox with columns | name = Plastics | title = [[Plastic]]s | 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 /> [[Acrylic glass|Polymethyl methacrylate]] (PMMA)<br /> [[Polyoxymethylene]] (POM) }}
|
[edit]
The gray background for the columns is added for illustration only.
|
Example with colnheader using colnheadercolspan[edit]
The gray background for the columns is added for illustration only.
|
[edit]
All three types of navbox templates, namely {{Navbox}}, {{Navbox with columns}}, and {{Navbox with collapsible groups}}, 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.
[edit]
This example shows how one can nest multiple {{Navbox with columns}} templates to get the right look. Edit this section to view the code. There is a main {{Navbox with columns}} and two additional {{Navbox with columns}} templates, with the "child" option set (see code).
|
[edit]
This example shows {{Navbox}}, {{Navbox with collapsible groups}} and {{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 child
See also[edit]
- {{Navbox}} – Allows groups/lists instead of columns
- {{Navbox with collapsible groups}} – Another variation.
Template:Navigational templates