Difference between revisions of "Template:Div col/doc"
en>Paine Ellsworth m (update /doc) |
(No difference)
|
Revision as of 16:24, 22 December 2018
This is a documentation subpage for Template:Div col. It contains usage information, categories and other content that is not part of the original template page. |
This template is used on approximately 230,000 pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
Columns are not supported by some older browsers, most notably Internet Explorer 9 and below and Opera 11.0 and below. See this page for more information. |
Property | Internet Explorer |
Firefox | Safari | Chrome | Opera |
---|---|---|---|---|---|
column-width column-count |
≥ 10 (2012) |
≥ 1.5 (2005) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
columns | ≥ 10 (2012) |
≥ 9 (2011) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
break-before break-after break-inside |
≥ 10 (2012) |
No | No | No | ≥ 11.1 (2011) |
{{Div col}} can be used to make a list into columns that wrap properly and compatibly with portable computer devices, esp. PAD operating systems and small screens. It automatically breaks the available space into equal spaces, meaning, for instance, that it is not necessary to work out the halfway point, or the one-third and two-thirds points between two columns.
- The list content is either provided by the
|content=
parameter (which can be restrictive of what content is allowed; e.g., wiki markup like | must somehow be escaped), or terminated with {{div col end}}. The {{columns-list}} wrapper uses the parameter method for providing content (including its limitations). - The template system (family) also offers parameter options to set a smaller (90%) font-size parameter (
|small=yes
), place vertical lines parameter ("rules") between the columns (|rules=
) and to add other custom styling (|style=
).
{{Div col}} can create multiple columns in web browsers which support the following CSS properties:
- column-width (for CSS3-compliant browsers; see CSS3 module: Multi-column layout)
By default, the template creates columns that are 30em wide.
Usage
There are six parameters for this template; their usage is described below.
|colwidth=
- Specifies the minimum width of the columns and determines automatically the number of columns based on screen width (i.e. more columns will be shown on wider displays). Can be specified in any CSS unit, for instance in em, about the width of a capital "M", e.g.,
colwidth=20em
. If no value is supplied, the template uses a default of 30em. |rules=
- Adds vertical lines ("rules") between the columns if set to
yes
or some CSS styling (e.g.1px dashed blue;
). |gap=
- Specifies the space between the content of adjacent columns. Specified in any CSS unit, e.g,
gap=2em
. The default spacing (set by browser) is 1em. |style=
- CSS styling to apply to the columns.
|small=yes
- sets font size to 90%.
|content=
- content to apply to the columns.
Examples
Usage of "colwidth" parameter
- Example with column width of 10em
{{div col|colwidth=10em}} * a * b * c * d * e * f * g * h {{div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
Usage of "rules" parameter
- Example
{{Div col|rules=yes}} * a * b * c * d * e * f * g * h {{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
Usage of "gap" parameter
- Example
{{Div col|colwidth=10em|rules=yes|gap=2em}} * a * b * c * d * e * f * g * h {{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
Usage of "small" parameter
- Example showing how setting "small" parameter to "yes" produces smaller font size
{{Div col|small=yes}} * a * b * c * d * e * f * g * h {{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
Usage of "content" parameter
- Example showing how to provide "content" parameter without using
{{Div col end}}
{{Div col|colwidth=10em|content= * a * b * c * d * e * f * g * h }}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
Usage with multiple parameters
Parameters can be used in any order. Example:
{{Div col|colwidth=10em|rules=yes|gap=2em|small=yes}} * a * b * c * d * e * f * g * h {{Div col end}}
or
{{Div col|rules=yes|gap=2em|small=yes|colwidth=10em}} * a * b * c * d * e * f * g * h {{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
and exactly the same result below
- a
- b
- c
- d
- e
- f
- g
- h
- Example with column width of 20em
{{div col|colwidth=20em}} * a * b * c * d * e * f * g * h {{div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
- Example with column width of 30em
{{div col|colwidth=30em}} * a * b * c * d * e * f * g * h {{div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
- Example of how this template behaves if no bullets (generated by asterisk mark) are used.
{{div col|colwidth=10em}} a b c d e f g h {{div col end}}
- produces
a b c d e f g h
Tracking categories
- Category:Pages using div col with unknown parameters (0) (for erroneous use of parameter names not documented here)
TemplateData
TemplateData for Div col
Breaks a list into columns. It automatically breaks each column to an equal space, so you do not manually have to find the half way point on two columns. The list is provided by |content= or closed with {{div col end}}.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Column width | colwidth | Specifies the width of columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.
| String | optional |
Rules | rules | Produces vertical rules between the columns if set to yes.
| String | optional |
Gap size | gap | Specifies the space between the content of adjacent columns.
| String | optional |
CSS style | style | Specifies any custom styling. | String | optional |
Content | content | Specifies the content to divide into columns | String | optional |
Small font | small | Use a smaller font size (90%)
| String | optional |
Redirects
{{Col div}}
{{Colbegin}}
(but not{{Col begin}}
or{{Col-begin}}
){{Cols}}
{{Div col start}}
{{Div col begin}}
{{Div-col}}
{{Palmares start}}
See also
Column-generating template families
The templates listed here are not interchangeable. For example, using {{col-float}} with {{col-end}} instead of {{col-float-end}} would leave a HTML "div" (division) open, potentially harming any subsequent formatting. |
Family | Type | Handles wiki
table code? |
Start template | Column divider | End template |
---|---|---|---|---|---|
"Col" | Table | Yes | {{Col-begin}} or {{Col-begin-small}} |
{{Col-break}} {{Col-2}} .. {{Col-5}} |
{{Col-end}} |
"Col-float" | CSS float | Yes | {{Col-float}} | {{Col-float-break}} | {{Col-float-end}} |
"Columns" | Table | No | {{Columns}} | – | – |
"Columns-list" | CSS columns | Yes | {{Columns-list}} (wrapper) | – | – |
"Columns-start" | CSS float | Yes | {{Columns-start}} | {{Column}} | {{Columns-end}} |
"Div col" | CSS columns | Yes | {{Div col}} | – | {{Div col end}} |
I.e., can the columns handle the wiki markup {| | || |- |} used to create tables? If not, templates that produce these elements (such as {{(!}}, {{!}}, {{!!}}, {{!-}}, {{!)}}) and/or HTML tags (<table>...</table>
, <tr>...</tr>
, etc.) will need to be used instead.