Template:Multicol/doc
This is a documentation subpage for Template:Multicol. It contains usage information, categories, interlanguage links and other content that is not part of the original template page. |
Usage
{{Multicol}} is used to start a multi-column section of a page. Between each block of column text insert {{Multicol-break}} and close the last column with {{Multicol-end}}. For example:
{{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}}
Provides this format:
This text appears in the first column. |
This text appears in the second column. |
This text appears in the third column. |
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.
Parameters
This template has two optional parameters: the overall width of the set of columns and the width of the gutter. The overall width of the set of columns can be an absolute value (e.g., 40em) or a percentage of the available page width (e.g., 50%). This parameter defaults to 100%. The second parameter is the "gutter" for the whole column set, which defaults to 20px.
The {{Multicol-break}} also takes an optional parameter for the gutter to its right, also defaulting to 20px.
For example, to create a 3-column section that is only 50% the width of the page, with 2-pixel right margins:
{{Multicol|50%|2px}} This text appears in the first column. {{Multicol-break|2px}} This text appears in the second column. {{Multicol-break}2px}} This text appears in the third column. {{Multicol-end}}
This results in:
This text appears in the first column. |
This text appears in the second column. |
This text appears in the third column. |
The multi-column region is always positioned on the left side of the containing block. To change this, place the above Wikitext in a <DIV> block that has the CSS attribute text-align set to either center or right, like this:
<div style="text-align:center;">{{center| {{Multicol|50%|2px}} ... {{Multicol-end}} }}</div>
See also
- {{Multicol-break}}
- {{Multicol-end}}