Template:Col-begin/doc

From RobotX
Jump to navigation Jump to search
Caution! Caution: This template creates a table rather than actual columns. This means that it displays poorly on mobile devices or narrow screens and is sub-optimal in terms of accessibility. Approximately half of the readers of English Wikipedia articles are using mobile devices and may have trouble reading the content that is wrapped in this template. Please consider using one of the CSS-based column templates (listed at the end of this page) instead, or not using columns at all.

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
|}

Examples

Here are some example codes that you can use to make columns of text in your wikipedia article. You can change the width of your columns by changing the code words that go between the text of your columns. Good luck!

See also

Column-generating template families

Caution! Caution: 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.

<section begin="table" />

Family Type
Handles wiki
 table code?dagger
Start template Column divider End template
"Col" Table Yes {{Col-begin}},
{{Col-begin-fixed}} or
{{Col-begin-small}}
{{Col-break}} or
{{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}}

dagger 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.<section end="table" />



TemplateData

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Col-begin

This template starts a multi-column table.

Template parameters

ParameterDescriptionTypeStatus
Table widthwidth

The width of the complete table, defined as a percent (i.e. 50%), typically no more than 95%

Stringoptional