Template:Div col/doc: Difference between revisions
Replication_Ops>Jkudlick →Colwidth: adding variable width example |
m 1 revision imported |
||
Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata --> | |||
<!-- | |||
{{Lua|Module:Check for unknown parameters}} | {{Lua|Module:Check for unknown parameters}} | ||
{{Uses TemplateStyles|Template:Div col/styles.css}} | {{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 | * a | ||
* b | * b | ||
Line 24: | Line 38: | ||
* h | * h | ||
{{div col end}} | {{div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=10em}} | ||
* a | * a | ||
* b | * b | ||
Line 35: | Line 49: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
=== | === Example of "rules" parameter === | ||
; Example: | |||
<pre> | |||
{{Div col|rules=yes}} | |||
; | |||
< | |||
{{ | |||
* a | * a | ||
* b | * b | ||
Line 67: | Line 63: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|rules=yes}} | ||
* a | * a | ||
* b | * b | ||
Line 79: | Line 75: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
=== Example of "gap" parameter === | |||
{{ | ; Example: | ||
<pre> | |||
{{Div col|colwidth=10em|rules=yes|gap=2em}} | |||
* a | * a | ||
* b | * b | ||
Line 91: | Line 89: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=10em|rules=yes|gap=2em}} | ||
* a | * a | ||
* b | * b | ||
Line 103: | Line 101: | ||
* g | * g | ||
* h | * 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 | * a | ||
* b | * b | ||
Line 116: | Line 115: | ||
* g | * g | ||
* h | * h | ||
}} | |||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=10em|content= | ||
* a | * a | ||
* b | * b | ||
Line 128: | Line 127: | ||
* g | * g | ||
* h | * h | ||
}} | |||
=== | === Usage with multiple parameters === | ||
< | Parameters can be used in any order. | ||
{{ | '''Example: ''' | ||
<pre> | |||
{{Div col|colwidth=10em|rules=yes|gap=2em}} | |||
* a | * a | ||
* b | * b | ||
Line 141: | Line 142: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
</ | </pre> | ||
or | |||
{{ | <pre> | ||
{{Div col|rules=yes|gap=2em|colwidth=10em}} | |||
* a | * a | ||
* b | * b | ||
Line 153: | Line 155: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
</pre> | |||
; produces: | |||
< | {{Div col|colwidth=10em|rules=yes|gap=2em}} | ||
{{ | |||
* a | * a | ||
* b | * b | ||
Line 166: | Line 167: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
and exactly the same result below | |||
{{Div col|rules=yes|gap=2em|colwidth=10em}} | |||
{{ | |||
* a | * a | ||
* b | * b | ||
Line 178: | Line 178: | ||
* g | * g | ||
* h | * h | ||
{{ | {{Div col end}} | ||
; Example with column width of 20em | |||
< | <pre> | ||
{{div col|colwidth= | {{div col|colwidth=20em}} | ||
* a | * a | ||
* b | * b | ||
Line 191: | Line 191: | ||
* g | * g | ||
* h | * h | ||
}} | {{div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=20em}} | ||
* a | * a | ||
* b | * b | ||
Line 203: | Line 203: | ||
* g | * g | ||
* h | * h | ||
}} | {{Div col end}} | ||
; Example with column width of 30em | |||
< | <pre> | ||
{{div col|colwidth= | {{div col|colwidth=30em}} | ||
* a | * a | ||
* b | * b | ||
Line 217: | Line 217: | ||
* h | * h | ||
{{div col end}} | {{div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=30em}} | ||
* a | * a | ||
* b | * b | ||
Line 228: | Line 228: | ||
* g | * g | ||
* h | * 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}} | {{div col|colwidth=10em}} | ||
a | a | ||
b | b | ||
Line 242: | Line 242: | ||
h | h | ||
{{div col end}} | {{div col end}} | ||
</ | </pre> | ||
; produces: | |||
{{ | {{Div col|colwidth=10em}} | ||
a | a | ||
b | b | ||
Line 253: | Line 253: | ||
g | g | ||
h | h | ||
{{ | {{Div col end}} | ||
==Tracking categories== | == 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 == | ||
{{TemplateData header}} | {{TemplateData header}} | ||
{{#switch: {{ | {{#switch: {{ROOTPAGENAME}} | ||
|Div col=<templatedata> | |Div col=<templatedata> | ||
{ | { | ||
Line 314: | Line 269: | ||
"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.", | "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", | "type": "string", | ||
"example | "example": "30em" | ||
}, | }, | ||
"rules": { | "rules": { | ||
Line 321: | Line 275: | ||
"description": "Produces vertical rules between the columns if set to yes.", | "description": "Produces vertical rules between the columns if set to yes.", | ||
"type": "string", | "type": "string", | ||
"example": "yes" | "example": "'yes' or '1px dashed blue'" | ||
}, | }, | ||
"gap": { | "gap": { | ||
Line 328: | Line 282: | ||
"type": "string", | "type": "string", | ||
"example": "2em" | "example": "2em" | ||
}, | }, | ||
"style": { | "style": { | ||
Line 343: | Line 291: | ||
"label": "Content", | "label": "Content", | ||
"description": "Specifies the content to divide into columns", | "description": "Specifies the content to divide into columns", | ||
"type": "string" | "type": "string" | ||
} | } | ||
Line 362: | Line 304: | ||
</templatedata> | </templatedata> | ||
}} | }} | ||
<includeonly>{{Sandbox other|| | |||
<!-- Categories below this line; interwikis at Wikidata --> | |||
[[Category:Multi-column templates{{#translation:}}]] | |||
<includeonly>{{Sandbox other| | |||
[[Category:Multi-column templates | |||
}}</includeonly> | }}</includeonly> |
Revision as of 04:20, 6 December 2024
This is a documentation subpage for Template:Div col. It may contain usage information, categories and other content that is not part of the original template page. |
This template uses Lua: |
This template uses TemplateStyles: |
{{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
|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 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.
|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|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 "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}} * a * b * c * d * e * f * g * h {{Div col end}}
or
{{Div col|rules=yes|gap=2em|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
Tracking categories
- Pages using div col with unknown parameters (for erroneous use of parameter names not documented here)
TemplateData
TemplateData for Div col
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}}.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Column width | colwidth | Specifies the width of columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.
| String | optional |
Rules | rules | Produces vertical rules between the columns if set to yes.
| String | optional |
Gap size | gap | Specifies the space between the content of adjacent columns.
| String | optional |
CSS style | style | Specifies any custom styling. | String | optional |
Content | content | Specifies the content to divide into columns | String | optional |