Template:Col-break/doc
| 40px | This is a documentation subpage for Template:Col-break. It contains usage information, categories and other content that is not part of the original template page. |
| 40px | This template is used on 200,000+ pages To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
The {{col-begin}}, {{col-break}} and {{col-end}} templates control columns of text on a page:
- {{col-begin}}: starts a table (followed by {{col-break}} for 1st column)
- {{col-break}}: triggers the start of each column
- {{col-end}}: ends the multi-column table.
The widths of columns can be specified by using various additional codes. See below for examples.
Usage
- {{col-begin|width=70%}}: start table with width.
- {{col-break|width=66%}}: start column-1 as 66% wide.
- This is text in col-1.
- {{col-break|width=33%}}: start column-2 as 33% wide.
- Text column-2.
- {{col-end}}
The table will have two columns, with column 1 twice (2×) the width of column 2.
A border of 2px (1px width on each side) corresponds to a 5%. Therefore, with a 2px border—for example, as in Wikipedia:Tutorial/Wrap-up and more info—the width needs to be 95% for the table to fit within the screen. Since it's possible that some tables might not have a border, correction on the individual page could be made after substitution. Another way to create a two column table is like this:
{{col-begin|width=95%}}
|-
|
Left column
|
Right column
|}
|
{{Col-begin}}
{{Col-2}}
Column 1 here
{{Col-2}}
Column 2 here
{{Col-end}}
|
{{Col-begin}}
{{Col-3}}
Column 1 here
{{Col-3}}
Column 2 here
{{Col-3}}
Column 3 here
{{Col-end}}
|
and so on, up to {{Col-5}} |
{{Col-begin}}
{{Col-break}}
Column 1 here
{{Col-break}}
Column 2 here
{{Col-break}}
Column 3 here
{{Col-break}}
Column 4 here
{{Col-break}}
Column 5 here
{{Col-break}}
Column 6 here
{{Col-end}}
|
{{Columns-start|num=3}}
Column 1 here
{{Column}}
Column 2 here
{{Column}}
Column 3 here
{{Columns-end}}
|
{{Multicol}}
Column 1 here
{{Multicol-break}}
Column 2 here
{{Multicol-break}}
Column 3 here
{{Multicol-break}}
Column 4 here
{{Multicol-end}}
|
Examples
See also
Column-generating template families
| Caution | The templates listed here are not interchangeable. For example, using {{Multicol}} with {{col-end}} instead of {{Multicol-end}} would leave a HTML "div" (division) open, potentially harming any subsequent formatting. |
| Family | Type | Handles wiki
table code?File:Dagger-14-plain.png |
Start template | Column divider | End template |
|---|---|---|---|---|---|
| "Col" | Table | Yes | {{Col-begin}} or {{Col-begin-small}} |
{{Col-break}} {{Col-2}} .. {{Col-5}} |
{{Col-end}} |
| "Columns" | Table | No | {{Columns}} | – | – |
| "Multicol" | Table | Yes | {{Multicol}} | {{Multicol-break}} | {{Multicol-end}} |
| "Col-float" | CSS float | Yes | {{Col-float}} | {{Col-float-break}} | {{Col-float-end}} |
| "Columns-start" | CSS float | Yes | {{Columns-start}} | {{Column}} | {{Columns-end}} |
| "Div col" | CSS columns | Yes | {{Div col}} – {{Columns-list}} (wrapper) |
{{No col break}} | {{Div col end}} |
File:Dagger-14-plain.png 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.
External links
Template data
TemplateData for Col-break
<templatedata> { "description": "This template triggers the start of each column in a multi-column table.", "params": { "width": { "label": "Column width", "type": "string", "description": "Width of the column, defined as a percent (ie 50%)" } } } </templatedata>