View source for Template:Div col/doc

{{Documentation subpage}}
{{Lua|Module:Check for unknown parameters}}
{{Uses TemplateStyles|Template:Div col/styles.css}}
__NOTOC__

The {{tl|Div col}} (short for division columns) formats a list into columns that wrap at multiple screen resolutions responsively. 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.

== Usage ==
=== Basic Usage ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}{{))}}<nowiki><!-- default width is 30em --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{((}}{{fcb|#4169e1|div col end}}{{))}}
}}
Produces:
{{div col}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

== Parameters ==
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). If no value is supplied, the template uses a default of 30em. The width can be specified in any [[wikipedia:CSS#Length units|CSS unit of measure]], for instance, the [[wikipedia:Em (typography)|em]] (about the width of the capital "M" of the displayed typeface), e.g., <code>colwidth=20em</code>. 
; {{para|rules|yes}} : Adds vertical lines ("rules") between the columns if set to <code>yes</code>. 
; {{para|gap}} : Specifies the space between the content of adjacent columns, in any valid CSS width unit, e.g., <code>gap=2em</code>. The default spacing (set by browser) is 1em.
; {{para|class}} : An HTML class, or multiple space-delimited classes, to apply to the columns.
; {{para|style}} : [[wikipedia:CSS|CSS styling]] to apply to the columns.
; {{para|small|yes}} : Sets font size to 90%.
; {{para|content}} : Content to apply to the columns. This parameter is effectively equivalent to {{tl|columns-list}}, which is a pass-through for this template.

== Examples ==
=== Colwidth ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}|{{fcb|#2e8b57|colwidth}}{{=}}{{font color|#933|10em}}{{))}} <nowiki><!-- column width of 10em --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{((}}{{fcb|#4169e1|div col end}}{{))}}
}}
Produces:
{{div col|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

=== Rules ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}|{{fcb|#2e8b57|colwidth}}{{=}}{{font color|#933|10em}}|{{fcb|#2e8b57|rules}}{{=}}{{font color|#933|yes}}{{))}} <nowiki><!-- column width of 10em with rules --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{((}}{{fcb|#4169e1|div col end}}{{))}}
}}
Produces:
{{div col|colwidth=10em|rules=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

=== Gap ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}|{{fcb|#2e8b57|colwidth}}{{=}}{{font color|#933|10em}}|{{fcb|#2e8b57|rules}}{{=}}{{font color|#933|yes}}|{{fcb|#2e8b57|gap}}{{=}}{{font color|#933|2em}}{{))}} <nowiki><!-- column width of 10em with rules and a gap of 2em --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{((}}{{fcb|#4169e1|div col end}}{{))}}
}}
Produces:
{{div col|colwidth=10em|rules=yes|gap=2em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

=== Small ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}|{{fcb|#2e8b57|small}}{{=}}{{font color|#933|yes}}{{))}} <nowiki><!-- Small = yes --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{((}}{{fcb|#4169e1|div col end}}{{))}}
}}
Produces:
{{div col|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

=== Content ===
{{Pre|
{{((}}{{fcb|#4169e1|div col}}|{{fcb|#2e8b57|content}}{{=}} <nowiki><!-- content parameter doesn't need {{div col end}} --></nowiki>
* a
* b
* c
* d
* e
* f
* g
* h
{{))}}}}
Produces:
{{div col|colwidth=10em|content=
* a
* b
* c
* d
* e
* f
* g
* h
}}

=== Multiple Parameters ===
<pre>
{{div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}
</pre>
Produces:
{{div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

=== Text characters without list markup ===
<pre>
{{div col|colwidth=10em}} <!--Text characters without list markup -->
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}}

== Limitation ==
=== Sub-lists ===
The underlying CSS system is unable to break sub-lists into columns. Note the uneven formatting below:

<pre>
{{div col|colwidth=10em|rules=yes|gap=2em|style=column-count:3|content=
* a
* b
* c
** c.d
** c.e
** c.f
* g
* h
}}
</pre>
Produces:
{{div col|colwidth=10em|rules=yes|gap=2em|style=column-count:3|content=
* a
* b
* c
** c.d
** c.e
** c.f
* g
* h
}}

Turning off the {{code|break-inside: avoid-column;}} rule appears to help.<!-- A full page refersh is needed; just F12-ing doesn't work. -->

==Tracking categories==
* {{Cat|Pages using div col with unknown parameters}} (for erroneous use of parameter names not documented here)
* {{Cat|Pages using div col with small parameter}}

==TemplateData==
{{#switch: {{BASEPAGENAME}}
|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"
		},
		"gap": {
			"label": "Gap size",
			"description": "Specifies the space between the content of adjacent columns.",
			"type": "string",
			"example": "2em"
		},
		"class": {
			"label": "HTML class",
			"description": "Specifies any class or multiple space-delimited classes.",
			"type": "string",
			"example": "plainlist nowrap"
		},
		"style": {
			"label": "CSS style",
			"description": "Specifies any custom styling.",
			"type": "string"
		},
		"content": {
			"label": "Content",
			"description": "Specifies the content to divide into columns",
			"type": "content"
		},
		"small": {
			"label": "Small font",
			"description": "Use a smaller font size (90%)",
			"example": "yes",
			"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||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Utility templates]]
[[Category:Templates that add a tracking category]]
}}}}</includeonly>