Difference between revisions of "Template:Col-begin/doc"

From blackwiki
Jump to navigation Jump to search
imported>Impro
imported>Thumperward
(splitting main column documentation to its own page and transcluding it, per talk:col-3)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
{{#switch:{{lc:{{PAGENAME}}}}
 
| col-2 = The [[Template:Col-2]] sets column width for each of 2 columns, with align=left, valign=top. The width, align or valign can be changed: <nowiki>{{col-2 |width=40%|align=right|valign=center}}</nowiki>.<br><br>
 
| col-3 = The [[Template:Col-3]] sets column width for each of 3 columns, with align=left, valign=top. The width, align or valign can be changed: <nowiki>{{col-3 |width=25%|align=right|valign=center}}</nowiki>.<br><br>
 
| col-4 = The [[Template:Col-4]] sets column width for each of 4 columns.<br><br>
 
| col-5 = The [[Template:Col-5]] sets column width for each of 5 columns.<br><br>
 
| col-6 = The [[Template:Col-6]] sets column width for each of 6 columns, with align=left, valign=top. The width, align or valign can be changed: <nowiki>{{col-6 |width=20%|align=right|valign=center}}</nowiki>.<br><br>
 
| col-start=The [[Template:Col-start]] begins a wikitable (same as <nowiki>{{col-begin}}</nowiki>).<br><br>
 
}}
 
The {{tl|col-begin}}, {{tl|col-break}} and {{tl|col-end}} templates control columns of text on a page:
 
:*<nowiki>{{col-begin}}</nowiki> - starts a table (followed by <nowiki>{{col-break}}</nowiki> for 1st column)
 
:*<nowiki>{{col-break}}</nowiki> - triggers the start of each column
 
:*<nowiki>{{col-end}}</nowiki> - ends the multi-column table.
 
The widths of columns can be specified by using various additional codes. See below for examples.
 
  
===Usage===
+
{{column templates}}
:: <nowiki>{{col-begin|width=70%}}</nowiki> - start table with width.
 
:: <nowiki>{{col-break|width=66%}}</nowiki> - start column-1 as 66% wide.
 
:: This is text in col-1.
 
:: <nowiki>{{col-break|width=33%}}</nowiki> - start column-2 as 33% wide.
 
:: Text column-2.
 
:: <nowiki>{{col-end}}</nowiki>
 
The table will have 2 columns, with column 1 twice (2x) 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:
 
 
 
{|
 
|
 
<pre>
 
{{col-begin|width=95%}}
 
|-
 
|
 
Left column
 
|
 
Right column
 
|}
 
</pre>
 
|}
 
 
 
{{col-begin}}
 
 
 
{{col-1-of-4}}
 
 
 
{{tl|Col-begin}}
 
{{tl|Col-2}}
 
Column 1 here
 
{{tl|Col-2}}
 
Column 2 here
 
{{tl|Col-end}}
 
 
 
{{col-2-of-4}}
 
 
 
{{tl|Col-begin}}
 
{{tl|Col-3}}
 
Column 1 here
 
{{tl|Col-3}}
 
Column 2 here
 
{{tl|Col-3}}
 
Column 3 here
 
{{tl|Col-end}}
 
 
 
{{col-3-of-4}}
 
 
 
{{tl|Col-begin}}
 
{{tl|Col-4}}
 
Column 1 here
 
{{tl|Col-4}}
 
Column 2 here
 
{{tl|Col-4}}
 
Column 3 here
 
{{tl|Col-4}}
 
Column 4 here
 
{{tl|Col-end}}
 
 
 
{{col-4-of-4}}
 
 
 
and so on, up to {{tl|Col-5}}
 
 
 
{{col-end}}
 
 
 
{{col-begin}}
 
 
 
{{col-1-of-4}}
 
 
 
&#123;{[[Template:Col-begin|Col-begin]]|class=references-small}}
 
{{tl|Col-break}}
 
Column 1 here
 
{{tl|Col-break}}
 
Column 2 here
 
{{tl|Col-break}}
 
Column 3 here
 
{{tl|Col-break}}
 
Column 4 here
 
{{tl|Col-break}}
 
Column 5 here
 
{{tl|Col-break}}
 
Column 6 here
 
{{tl|Col-end}}
 
 
 
{{col-2-of-4}}
 
 
 
{{tl|Top}}
 
Column 1 here
 
{{tl|Mid}}
 
Column 2 here
 
{{tl|Bottom}}
 
 
 
{{col-3-of-4}}
 
 
 
&#123;{[[Template:Columns-start|Columns-start]]|num=3}}
 
Column 1 here
 
{{tl|Column}}
 
Column 2 here
 
{{tl|Column}}
 
Column 3 here
 
{{tl|Columns-end}}
 
 
 
{{col-4-of-4}}
 
 
 
{{tl|Multicol}}
 
Column 1 here
 
{{tl|Multicol-break}}
 
Column 2 here
 
{{tl|Multicol-break}}
 
Column 3 here
 
{{tl|Multicol-break}}
 
Column 4 here
 
{{tl|Multicol-end}}
 
 
 
{{col-end}}
 
 
 
===Examples===
 
: See: [[Template:Col-break/examples|Col-break/examples]].
 
 
 
===See also===
 
* {{tl|Col-begin}} ({{tl|Col-start}}), {{tl|Col-begin-small}} {{lts/|Col-begin}}
 
** {{tl|Col-break}}
 
** {{tl|Col-2}} <small>({{tl|Col-1-of-2}}, {{tl|Col-2-of-2}})</small>
 
** {{tl|Col-3}} <small>({{tl|Col-1-of-3}}, {{tl|Col-2-of-3}}, {{tl|Col-3-of-3}})</small>
 
** {{tl|Col-4}} <small>({{tl|Col-1-of-4}}, {{tl|Col-2-of-4}}, {{tl|Col-3-of-4}}, {{tl|Col-4-of-4}})</small>
 
** {{tl|Col-5}} <small>({{tl|Col-1-of-5}}, {{tl|Col-2-of-5}}, {{tl|Col-3-of-5}}, {{tl|Col-4-of-5}}, {{tl|Col-5-of-5}})</small>
 
<!-- ----------------- Hide deprecated templates (rarely used)
 
** {{tl|Col-6}} <small>(<nowiki>{{Col-1-of-6}}, {{Col-2-of-6}}, {{Col-3-of-6}}, {{Col-4-of-6}}, {{Col-5-of-6}}, {{Col-6-of-6}}</nowiki>)</small> -->
 
** For 6, use: <nowiki>{{Col-break|width=16.6%}}</nowiki>&nbsp; where the width 16.6% is roughly 100/6.
 
** For 7, use: <nowiki>{{Col-break|width=14.2%}}</nowiki>&nbsp; or for 8, use: <nowiki>{{Col-break|width=12.4%}}</nowiki>, etc.
 
* {{tl|Col-end}} ({{tl|End}})
 
* {{tl|Top}}, {{tl|Mid}}, {{tl|Bottom}}
 
* {{tl|Columns-start}}, {{tl|Column}}, {{tl|Columns-end}} {{lts/|Columns-start}}
 
* {{tl|Multicol}}, {{tl|Multicol-break}}, {{tl|Multicol-end}} {{lts/|Multicol}}
 
* {{tl|Div col}}, {{tl|Div col end}} {{lts/|Div col}}
 
 
 
===External links===
 
* [http://www.htmlcodetutorial.com/_MULTICOL.html MULTICOL HTML tag]
 
* [https://developer.mozilla.org/en/docs/CSS3_Columns CSS3 Columns], -moz-column-count
 
 
 
{{Selfref|This [[Wikipedia:Template|template]] is a [[Wikipedia:Avoid self-references|self-reference]] and so is part of the Wikipedia project rather than the encyclopedic content.}}
 
  
 
<includeonly>
 
<includeonly>

Revision as of 08:50, 20 August 2010

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 specific width.
{{col-break|width=66%}}: start column-1 as 66% wide.
This is text in column-1.
{{col-break|width=33%}}: start column-2 as 33% wide.
This is text in 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, 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!

Example 1, using col-break
{{col-begin}}
{{col-break}}
{| class="wikitable" style="width:18em"
|+ Production by year
|-
! 1980
| 50,000
|-
! 1990
| 75,000
|-
! 2000
| 90,000
|}
{{col-break}}
{| class="wikitable" style="width:18em"
|+ Profit by year
|-
! 1980
| $6,000
|-
! 1990
| $7,500
|-
! 2000
| $8,200
|}
{{col-end}}

gives:

Example 2, using col-2
{{col-begin}}
{{col-2}}
{| class="wikitable" style="width:18em"
|+ Production by year
|-
! 1980
| 50,000
|-
! 1990
| 75,000
|-
! 2000
| 90,000
|}
{{col-2}}
{| class="wikitable" style="width:18em"
|+ Profit by year
|-
! 1980
| $6,000
|-
! 1990
| $7,500
|-
! 2000
| $8,200
|}
{{col-end}}

gives:

Example 3, use col-break with specified widths
{{col-begin}}
{{col-break|width=80%}}
{| class="wikitable" style="width:18em"
|+ Production by year
|-
! 1980
| 50,000
|-
! 1990
| 75,000
|-
! 2000
| 90,000
|}
{{col-break|width=20%}}
{| class="wikitable" style="width:18em"
|+ Profit by year
|-
! 1980
| $6,000
|-
! 1990
| $7,500
|-
! 2000
| $8,200
|}
{{col-end}}

gives:

Example 4, use col-break with auto outer width
{{col-begin|width=auto}}
{{col-break}}
{| class="wikitable" style="width:18em"
|+ Production by year
|-
! 1980
| 50,000
|-
! 1990
| 75,000
|-
! 2000
| 90,000
|}
{{col-break|gap=2em}}
{| class="wikitable" style="width:18em"
|+ Profit by year
|-
! 1980
| $6,000
|-
! 1990
| $7,500
|-
! 2000
| $8,200
|}
{{col-end}}
Example 5, Lots of columns, using col-break

See also

Column-generating template families

<section begin="table" />

Family Type
Handles wiki
 table code?Script error: No such module "If empty".
Responsive/
Mobile suited
Start template Column divider End template
"Col" Table Yes Yes {{Col-begin}},
{{Col-begin-fixed}} or
{{Col-begin-small}}
{{Col-break}} or
{{Col-2}} .. {{Col-5}}
{{Col-end}}
"Col-float" CSS float Yes Yes {{Col-float}} {{Col-float-break}} {{Col-float-end}}
"Columns" Table No Yes {{Columns}}
"Columns-list" CSS columns Yes Yes {{Columns-list}} (wrapper)
"Columns-start" CSS float Yes Yes {{Columns-start}} {{Column}} {{Columns-end}}
"Flex columns" CSS flexbox Yes Yes {{Flex columns}}
"Div col" CSS columns Yes Yes {{Div col}} {{Div col end}}

Script error: No such module "If empty". I.e., can the columns handle the wiki markup {| | || |- |} used to create tables? If not, templates that produce these elements (such as {{(!}}, {{!}}, {{!!}}, {{!-}}, {{!)}}) or HTML tags (<table>...</table>, <tr>...</tr>, etc.) will need to be used instead.<section end="table" />