Template:Div col/doc

This is the Documentation subpage of Template:Div col This page's sole purpose is to explain how the Template should be used. Do not use it for other purposes.

Div col formats a list into columns that wrap properly and compatibly with portable computer devices, especially PAD operating systems and small screens.

Purpose

It automatically breaks the available screen space into equal parts, meaning, for instance, that it is not necessary to guess how many columns to use and then figure out the dividing point(s), e.g., the halfway point to divide the list into two columns, or the one-third and two-thirds points to divide the list into three columns.

• The list content is either provided by the |content= parameter (which can be restrictive of what content is allowed; e.g., wiki markup such as the | character must somehow be escaped), or terminated with div col end. The columns-list wrapper uses the parameter method for providing content (including its limitations).
• The template system (family) also offers parameter options to set a smaller (90%) font-size parameter (|small=yes), place vertical lines parameter ("rules") between the columns (|rules=) and to add other custom styling (|style=).

Div col can create multiple columns in web browsers which support the following CSS properties:

• column-width (for CSS3-compliant browsers; see CSS3 module: Multi-column layout)

By default, the template creates columns that are 30em wide.

This template's parameters

Descriptions

There are six parameters for this template:

|colwidth=

Specifies the minimum width of the columns so that the number of columns is automatically based on screen width (that is, more columns will be shown on wider displays). Can be specified in any CSS unit of measure, for instance, the em (about the width of the capital "M" of the displayed typeface), e.g., colwidth=20em. If no value is supplied, the template uses a default of 30em.

|rules=

Adds vertical lines ("rules") between the columns if set to yes or some CSS styling (e.g. 1px dashed blue;).

|gap=

Specifies the space between the content of adjacent columns. Specified in any CSS unit, e.g, gap=2em. The default spacing (set by browser) is 1em.

|style=

CSS styling to apply to the columns.

|small=yes

sets font size to 90%.

|content=

content to apply to the columns.

Example of "colwidth" parameter

Example with column width of 10em

{{div col|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example of "rules" parameter

Example

{{Div col|colwidth=10em|rules=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example of "gap" parameter

Example

{{Div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example of "small" parameter

Example showing how setting "small" parameter to "yes" produces smaller font size (90% of the size that would otherwise be displayed)

{{Div col|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example of "content" parameter

Example showing how to provide "content" parameter without using {{Div col end}}

{{Div col|colwidth=10em|content=
* a
* b
* c
* d
* e
* f
* g
* h
}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Usage with multiple parameters

Parameters can be used in any order. Example:

{{Div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

or

{{Div col|rules=yes|gap=2em|small=yes|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

and exactly the same result below

• a
• b
• c
• d
• e
• f
• g
• h

Example with column width of 20em

{{div col|colwidth=20em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example with column width of 30em

{{div col|colwidth=30em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

produces

• a
• b
• c
• d
• e
• f
• g
• h

Example of how this template behaves if no bullets (generated by asterisk mark) are used.

{{div col|colwidth=10em}}
a
b
c
d
e
f
g
h
{{div col end}}

produces

a b c d e f g h