Template:Div col: Difference between revisions
en>Matt Fitzpatrick (whitelist parameter class) |
(Created page with "<includeonly><templatestyles src="Div col/styles.css"/><!-- --><div class="div-col {{#ifeq:{{{small|}}}|yes|div-col-small}} {{#ifeq:{{{rules|}}}|yes|div-col-rules}} {{{class|}}}" <!-- -->{{#if:{{{colwidth|}}}{{{gap|}}}{{{style|}}}|<!-- -->style="{{#if:{{{colwidth|}}}|column-width: {{{colwidth}}};}}{{#if:{{{gap|}}}|column-gap: {{{gap}}};}}{{#if:{{{style|}}}|{{{style}}}}}"<!-- -->}}><!-- -->{{#if:{{{content|}}}|{{{content}}}</div>}}<!-- Inventory how many pages use small=y...") |
(No difference)
| |
Revision as of 16:34, 19 June 2023
Template documentation | This template is used on approximately 270,000 pages, or roughly 18845% of all pages. To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
| File:Information icon4.svg | Columns are not supported by some older browsers, most notably Internet Explorer 9 and earlier and Opera 11.0 and earlier. See Template:Reflist § Browser support for columns for more information. |
| Property | Internet Explorer |
Firefox | Safari | Chrome | Opera |
|---|---|---|---|---|---|
| column-width column-count |
≥ 10 (2012) |
≥ 1.5 (2005) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
| columns | ≥ 10 (2012) |
≥ 9 (2011) |
≥ 3 (2007) |
≥ 1 (2008) |
≥ 11.1 (2011) |
| break-before break-after break-inside |
≥ 10 (2012) |
≥ 65 (2019) |
≥ 10 (2016) |
≥ 65 (2016) |
≥ 15 (2013) |
| File:Lua-Logo.svg | This template uses Lua: |
| File:Farm-Fresh css add.svg | This template uses TemplateStyles: |
The 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
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Parameters
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). If no value is supplied, the template uses a default of 30em. The width 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. |rules=yes- Adds vertical lines ("rules") between the columns if set to
yes. |gap=- Specifies the space between the content of adjacent columns, in any valid CSS width unit, e.g.,
gap=2em. The default spacing (set by browser) is 1em. |class=- An HTML class, or multiple space-delimited classes, to apply to the columns.
|style=- CSS styling to apply to the columns.
|small=yes- Sets font size to 90%.
|content=- Content to apply to the columns. This parameter is effectively equivalent to {{columns-list}}, which is a pass-through for this template.
Examples
Colwidth
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Rules
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Gap
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Small
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Content
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Multiple parameters
<syntaxhighlight lang="wikitext">
- a
- b
- c
- d
- e
- f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- d
- e
- f
- g
- h
Text characters without list markup
<syntaxhighlight lang="wikitext">
a b c d e f g h
</syntaxhighlight> Produces
a b c d e f g h
Lorem ipsum
<syntaxhighlight lang="wikitext">
</syntaxhighlight> Produces
Limitation
Sub-lists
The underlying CSS system is unable to break sub-lists into columns. Note the uneven formatting below:
<syntaxhighlight lang="wikitext">
- a
- b
- c
- c.d
- c.e
- c.f
- g
- h
</syntaxhighlight> Produces:
- a
- b
- c
- c.d
- c.e
- c.f
- g
- h
Turning off the
 | This template is used on 24,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre> or <syntaxhighlight>...</syntaxhighlight>. See Help:Wiki markup for an explanation of what the various tags do.
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute inline=1. This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
- Template loop detected: Template:Code
However, {{code|a {{template}} call}} will still invoke the template:
- Template loop detected: Template:Code
Use <nowiki>...</nowiki> around the template name to avoid this problem:
- Template loop detected: Template:Code
When used inline with regular text, {{code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
- Template loop detected: Template:Code
is well spaced:
- foo Template loop detected: Template:Code quux.
versus:
- Template loop detected: Template:Code
which is going to be visually confusing for many:
- foo Template loop detected: Template:Code quux.
because "foo" and "Template loop detected: Template:Code" will seem more closely associated than "Template loop detected: Template:Code" and "Template loop detected: Template:Code"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
Use parameter {{{2}}} (unnamed, as |2=, or more explicitly as |lang=) to specify a language for mw:Extension:SyntaxHighlight. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though Template loop detected: Template:Code and Template loop detected: Template:Code are valid values, as are Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code, Template loop detected: Template:Code and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.
This template does not need to be substituted.
Examples
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code> as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
| Markup | Renders asScript error: No such module "For loop". |
|---|---|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
TemplateData
TemplateData for Div col
See also
- {{codett}}, wrapper for this template that removes background and border styling
- {{mono}}, monospaced font only
- {{param value}}, monospaced; friendly handling for blank space
- {{Syntaxhighlight}}
- {{kbd}}, for keyboard input
- Help:Wiki markup
Tracking categories
- Category:Pages using div col with unknown parameters (0) (for erroneous use of parameter names not documented here)
- Category:Pages using div col with small parameter (3)
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 |
| HTML class | class | Specifies any class or multiple space-delimited classes.
| String | optional |
| CSS style | style | Specifies any custom styling. | String | optional |
| Content | content | Specifies the content to divide into columns | Content | optional |
| Small font | small | Use a smaller font size (90%)
| String | optional |
Redirects
{{col div}}{{colbegin}}(but not{{col begin}}or{{col-begin}}){{cols}}{{div col start}}{{div col begin}}{{div-col}}{{palmares start}}
See also
- {{End}} (closes a table)
- Pages with template loops
- Pages with script errors
- Pages with TemplateStyles errors
- Pages with broken file links
- Lua-based templates
- Templates using TemplateStyles
- Pages using div col with small parameter
- Templates using TemplateData
- Programming typing-aid templates
- Semantic markup templates
- Wikipedia XHTML tag-replacing templates
- Multi-column templates
- Templates that add a tracking category
