View source for Template:Multicol/doc

{{Documentation subpage}}
<!--
    PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE
    YOU CAN EDIT THE TEMPLATE DOCUMENTATION BELOW THIS COMMENT
-->
== Usage ==
{{tl|Multicol}} is used to start a multi-column section of a page. Between each block of column text insert <tt>{{tl|Multicol-break}}</tt>, between each section (which will keep the same colum spacing) add <tt>{{tl|Multicol-section}}</tt> and close the last column with <tt>{{tl|Multicol-end}}</tt>. For example:

<pre>
 {{Multicol}}
 This text appears in the first column.
 {{Multicol-break}}
 This text appears in the second column.
 {{Multicol-break}}
 This text appears in the third column.
 {{Multicol-end}}
</pre>

You can have any number of columns. Each column will be the same width, equally dividing the available horizontal space. Each column has a small right margin (20 pixels), creating a "gutter" that prevents text in one column from touching text in the column to its right. See [[w:User:Franl|franl]]'s user page for examples of how this template can be used.

== Parameters ==
This template has four optional parameters
* {{parameter|width}}, {{parameter|1}}: The overall width of the set of columns (use <tt>auto</tt> to shrink to content)
* {{parameter|align}}: Alignment of the overall set of columns
* {{parameter|line}}: Interstitial line format. 
* {{parameter|gap|}}, {{parameter|2}}: The width of the gutter


===Overall width===
The overall width of the set of columns is set in {{tl|multicol}} as the first parmeter. It can be an absolute value (e.g., <tt>40em</tt>) or a percentage of the available page width (e.g., <tt>50%</tt>). This parameter defaults to <tt>100%</tt>. For example, to create a multi-column section that is only 50% the width of the page:

<pre>
{{Multicol|50%}}
This text appears in the first column.
{{Multicol-break}}
This text appears in the second column.
{{Multicol-break}}
This text appears in the third column.
{{Multicol-section}}
This text appears in the next row, first column.
{{Multicol-break}}
This text appears in the next row, second column.
{{Multicol-end}}
</pre>

{{Multicol|50%}}
{{lorem ipsum}}
{{Multicol-break}}
{{lorem ipsum}}
{{Multicol-break}}
{{lorem ipsum}}
{{Multicol-section}}
{{lorem ipsum}}
{{Multicol-break}}
{{lorem ipsum}}
{{Multicol-end}}

===Alignment===

The multi-column region is positioned on the left side of the containing block by default. To change this, adjust the "align" parameter in {{tl|multicol}} to "center" or "right"

<pre>
 {{Multicol|50%|align=center}}
 ...
 {{Multicol-end}}
</pre>

{{Multicol|50%|align=center}}
{{lorem ipsum}}
{{Multicol-break}}
{{lorem ipsum}}
{{Multicol-end}}

=== Margins === 

The margins can easily be changed by adjusting the second parameter in {{tl|multicol}} or the first in {{tl|multicol-break}}. You do not specify it in {{tl|multicol-end}}. The margins occur on the left and right of the block, so you should specify half the actual separation you want.

<pre>
{{Multicol||40px}}
This text appears in the first column.
{{Multicol-break|40px}}
This text appears in the second column.
{{Multicol-end}}
</pre>
{{Multicol||40px}}
{{lorem ipsum}}
{{Multicol-break|40px}}
{{lorem ipsum}}
{{Multicol-end}}

===Line format===
The third parameter controls a line between the blocks. This parameter is named "line" and cannot be accessed using positional arguments. It must be specified in {{tl|multicol}} and {{tl|multicol-break}}. The line format is given in the CSS way, eg "1px solid black", "2px dashed red", etc.

<pre>
{{Multicol|line=1px solid black}}
This text appears in the first column.
{{Multicol-break|line=1px solid black}}
This text appears in the second column.
{{Multicol-end}}
</pre>
{{Multicol|line=1px solid black}}
{{lorem ipsum}}
{{Multicol-break|line=1px solid black}}
{{lorem ipsum}}
{{Multicol-end}}

=== Other style ===
the |style= parameter may be used to define other styles not covered above.

== Technical notes==

This template uses a table to achieve the columns. Consider using a table if it is clearer in context than using this template.

== See also ==
{{#lst:Help:Templates|column formatting}}

<includeonly>

<!-- PLEASE ADD CATEGORIES BELOW THIS LINE, THANKS. -->
[[Category:Column formatting templates|Multicol]]

<!-- PLEASE ADD INTERWIKIS BELOW THIS LINE, THANKS. -->
[[ca:Plantilla:Columnes]]
[[id:Templat:Multicol]]
</includeonly>