View source for Template:Div col/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{Lua|Module:Check for unknown parameters}}
{{Uses TemplateStyles|Template:Div col/styles.css}}

{{tl|Div col}} formats a list into columns that wrap properly and compatibly with portable computer devices, especially PAD operating systems and small screens. It is not supported by Internet Explorer 9.

== 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 {{para|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 {{tl|div col end}}. The {{tl|columns-list}} wrapper uses the parameter method for providing content (including its limitations).
* The template system (family) also offers parameter options to place vertical lines parameter ("rules") between the columns ({{para|rules}}) and to add other custom styling ({{para|style}}).

{{tl|Div col}} can create multiple columns in [[:en:Web browser|web browsers]] which support the following [[:en:CSS|CSS]] properties:
* ''column-width'' (for [[:en:Cascading Style Sheets#CSS3|CSS3]]-compliant browsers; see [http://www.w3.org/TR/css3-multicol/ CSS3 module: Multi-column layout])

By default, the template creates columns that are [[:en:Em (typography)|30em]] wide.

== This template's parameters ==
=== Descriptions ===
There are six parameters for this template: 
; {{para|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#Length units|CSS unit of measure]], for instance, the [[:en:Em (typography)|em]] (about the width of the capital "M" of the displayed typeface), e.g., <code>colwidth=20em</code>. If no value is supplied, the template uses a default of 30em.
; {{para|rules}} : Adds vertical lines ("rules") between the columns if set to <code>yes</code> or some CSS styling (e.g. <code>1px dashed blue;</code>). 
; {{para|gap}} : Specifies the space between the content of adjacent columns. Specified in any CSS unit, e.g, <code>gap=2em</code>. The default spacing (set by browser) is 1em.
; {{para|style}} :[[:en:Cascading Style Sheets|CSS styling]] to apply to the columns.
; {{para|content}} : content to apply to the columns.

=== Example of "colwidth" parameter ===
; Example with column width of 10em
<pre>
{{div col|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}
</pre>
; produces:
{{Div col|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

=== Example of "rules" parameter ===
; Example:
<pre>
{{Div col|rules=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
</pre>
; produces:
{{Div col|rules=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

=== Example of "gap" parameter ===
; Example:
<pre>
{{Div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
</pre>
; produces:
{{Div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

=== Example of "content" parameter ===
; Example showing how to provide "content" parameter without using {{tlx|Div col end}}
<pre>
{{Div col|colwidth=10em|content=
* a
* b
* c
* d
* e
* f
* g
* h
}}
</pre>
; produces:
{{Div col|colwidth=10em|content=
* a
* b
* c
* d
* e
* f
* g
* h
}}

=== Usage with multiple parameters ===
Parameters can be used in any order. 
'''Example: '''
<pre>
{{Div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
</pre>
or 
<pre>
{{Div col|rules=yes|gap=2em|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
</pre>
; produces:
{{Div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
and exactly the same result below
{{Div col|rules=yes|gap=2em|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

; Example with column width of 20em
<pre>
{{div col|colwidth=20em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}
</pre>
; produces:
{{Div col|colwidth=20em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

; Example with column width of 30em
<pre>
{{div col|colwidth=30em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}
</pre>
; produces:
{{Div col|colwidth=30em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}

; Example of how this template behaves if no [[:en:•|bullets]] (generated by asterisk mark) are used.
<pre>
{{div col|colwidth=10em}}
a
b
c
d
e
f
g
h
{{div col end}}
</pre>
; produces:
{{Div col|colwidth=10em}}
a
b
c
d
e
f
g
h
{{Div col end}}

== Tracking categories ==
* [[:Category:Pages using div col with unknown parameters|Pages using div col with unknown parameters]] (for erroneous use of parameter names not documented here)

== TemplateData ==
{{TemplateData header}}
{{#switch: {{ROOTPAGENAME}}
|Div col=<templatedata>
{
	"description": "Breaks a list into columns. It automatically breaks each column to an equal space, so you do not manually have to find the half way point on two columns. The list is provided by |content= or closed with {{div col end}}.",
	"params": {
		"colwidth": {
			"label": "Column width",
			"description": "Specifies the width of columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.",
			"type": "string",
			"example": "30em"
		},
		"rules": {
			"label": "Rules",
			"description": "Produces vertical rules between the columns if set to yes.",
			"type": "string",
			"example": "'yes' or '1px dashed blue'"
		},
		"gap": {
			"label": "Gap size",
			"description": "Specifies the space between the content of adjacent columns.",
			"type": "string",
			"example": "2em"
		},
		"style": {
			"label": "CSS style",
			"description": "Specifies any custom styling.",
			"type": "string"
		},
		"content": {
			"label": "Content",
			"description": "Specifies the content to divide into columns",
			"type": "string"
		}
	}
}
</templatedata>
|Div col end=<templatedata>
{
    "description": "Ends a multi-column list started by {{div col}}. It takes no parameters.",
    "params": {
    }
}
</templatedata>
}}
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Multi-column templates{{#translation:}}]]
}}</includeonly>