Template:Div col/doc: Difference between revisions

From HIBIKIFORUM
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{template rating|p}}
{{Lua|Module:Check for unknown parameters}}
<!-----------------------------------------------------------------------------
{{Uses TemplateStyles|Template:Div col/styles.css}}
  PLEASE ADD CATEGORIES WHERE INDICATED AT THE BOTTOM OF THIS PAGE
__NOTOC__
------------------------------------------------------------------------------>
{{tl|Div col}} formats a list into columns that wrap properly and compatibly with portable computer devices, especially PAD operating systems and small screens.


==Purpose==
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.
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 <code>content</code> 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 set a smaller (90%) font-size parameter (<code>small|yes</code>), place vertical lines parameter ("rules") between the columns (<code>rules</code>) and to add other custom styling (<code>style</code>).


{{tl|Div col}} can create multiple columns in [[Wikipedia:web browser|web browser]]s which support the following [[Wikipedia:CSS]] properties:
== Usage ==
* ''column-width'' (for [[Wikipedia:Cascading Style Sheets#CSS 3|CSS3]]-compliant browsers; see [http://www.w3.org/TR/css3-multicol/ CSS3 module: Multi-column layout])
=== Basic Usage ===
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 [[Wikipedia:CSS#Length units|CSS unit of measure]], for instance, the 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.
; 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>).
; 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.
; style : [[Wikipedia:Cascading Style Sheets|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
<pre>
<pre>
{{div col|colwidth=10em}}
{{div col}}<!-- default width is 30em -->
* a
* a
* b
* b
Line 40: Line 20:
{{div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|colwidth=10em}}
{{div col}}
* a
* a
* b
* b
Line 50: Line 30:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}


===Example of "rules" parameter===
== Parameters ==
; Example:
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 [[CSS#Length units|CSS unit of measure]], for instance, the [[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:Cascading Style Sheets|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>
<pre>
{{Div col|colwidth=10em|rules=yes}}
{{div col|colwidth=10em}} <!-- column width of 10em -->
* a
* a
* b
* b
Line 64: Line 54:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|colwidth=10em|rules=yes}}
{{div col|colwidth=10em}}
* a
* a
* b
* b
Line 76: Line 66:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}


===Example of "gap" parameter===
=== Rules ===
; Example:
<pre>
<pre>
{{Div col|colwidth=10em|rules=yes|gap=2em}}
{{div col|colwidth=10em|rules=yes}} <!-- column width of 10em with rules -->
* a
* a
* b
* b
Line 90: Line 79:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|colwidth=10em|rules=yes|gap=2em}}
{{div col|colwidth=10em|rules=yes}}
* a
* a
* b
* b
Line 102: Line 91:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}


===Example of "small" parameter===
=== Gap ===
; Example showing how setting "small" parameter to "yes" produces smaller font size (90% of the size that would otherwise be displayed)
<pre>
<pre>
{{Div col|small=yes}}
{{div col|colwidth=10em|rules=yes|gap=2em}} <!-- column width of 10em with rules and a gap of 2em -->
* a
* a
* b
* b
Line 116: Line 104:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|small=yes}}
{{div col|colwidth=10em|rules=yes|gap=2em}}
* a
* a
* b
* b
Line 128: Line 116:
* g
* g
* h
* h
{{Div col end}}
{{div col end}}


===Example of "content" parameter===
=== Small ===
; Example showing how to provide "content" parameter without using {{tl|Div col end}}
<pre>
<pre>
{{Div col|colwidth=10em|content=
{{div col|small=yes}} <!-- Small = yes -->
* a
* a
* b
* b
Line 142: Line 129:
* g
* g
* h
* h
}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|colwidth=10em|content=
{{div col|small=yes}}
* a
* a
* b
* b
Line 154: Line 141:
* g
* g
* h
* h
}}
{{div col end}}


===Usage with multiple parameters===
=== Content ===
Parameters can be used in any order.
'''Example: '''
<pre>
<pre>
{{Div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
{{div col|colwidth=10em|content= <!-- content parameter doesn't need {{div col end}} -->
* a
* a
* b
* b
Line 169: Line 154:
* g
* g
* h
* h
{{Div col end}}
}}
</pre>
</pre>
or
Produces:
<pre>
{{div col|colwidth=10em|content=
{{Div col|rules=yes|gap=2em|small=yes|colwidth=10em}}
* a
* a
* b
* b
Line 182: Line 166:
* g
* g
* h
* 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}}
and exactly the same result below
{{Div col|rules=yes|gap=2em|small=yes|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}


; Example with column width of 20em
=== Multiple Parameters ===
<pre>
<pre>
{{div col|colwidth=20em}}
{{div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* a
* b
* b
Line 220: Line 181:
{{div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces:
{{Div col|colwidth=20em}}
{{div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
 
; Example with column width of 30em
<pre>
{{div col|colwidth=30em}}
* a
* a
* b
* b
Line 244: Line 192:
* h
* h
{{div col end}}
{{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 bullets (generated by asterisk mark) are used. 
=== Text characters without list markup ===
<pre>
<pre>
{{div col|colwidth=10em}}
{{div col|colwidth=10em}} <!--Text characters without list markup -->
a
a
b
b
Line 270: Line 206:
{{div col end}}
{{div col end}}
</pre>
</pre>
; produces:
Produces
{{Div col|colwidth=10em}}
{{div col|colwidth=10em}}
a
a
b
b
Line 280: Line 216:
g
g
h
h
{{Div col end}}
{{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==
* {{c|Pages using div col with unknown parameters}} (for erroneous use of parameter names not documented here)
* {{c|Pages using div col with small parameter}}


==TemplateData==
==TemplateData==
Line 298: Line 268:
"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' or '1px dashed blue'"
"example": "yes"
},
},
"gap": {
"gap": {
Line 305: Line 275:
"type": "string",
"type": "string",
"example": "2em"
"example": "2em"
},
"class": {
"label": "HTML class",
"description": "Specifies any class or multiple space-delimited classes.",
"type": "string",
"example": "plainlist nowrap"
},
},
"style": {
"style": {
Line 314: Line 290:
"label": "Content",
"label": "Content",
"description": "Specifies the content to divide into columns",
"description": "Specifies the content to divide into columns",
"type": "string"
"type": "content"
},
},
"small": {
"small": {
Line 320: Line 296:
"description": "Use a smaller font size (90%)",
"description": "Use a smaller font size (90%)",
"example": "yes",
"example": "yes",
"type": "string",
"type": "string"
"default": "no"
}
}
}
}
Line 335: Line 310:
}}
}}


<includeonly>
<includeonly>{{sandbox other||{{testcases other||
 
<!-- Categories below this line, please -->
<!-- Categories below this line, please -->
[[Category:Multi-column templates]]
[[Category:Templates]]
[[Category:Utility Templates]]
[[Category:Templates that add a tracking category]]
[[Category:Templates that add a tracking category]]
[[Category:Templates]]
}}}}</includeonly>
<!--?:-->{{#switch:{{PAGENAME}} |Div col= |Div col end=}}
}}</includeonly>

Revision as of 05:09, 14 June 2023

Light bulb.png }}
It contains usage information, categories and other content that is not part of the original template page.


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

{{div col}}<!-- default width is 30em -->
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

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

{{div col|colwidth=10em}} <!-- column width of 10em -->
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

Produces:

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

Rules

{{div col|colwidth=10em|rules=yes}} <!-- column width of 10em with rules -->
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

Produces:

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

Gap

{{div col|colwidth=10em|rules=yes|gap=2em}} <!-- column width of 10em with rules and a gap of 2em -->
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

Produces:

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

Small

{{div col|small=yes}} <!-- Small = yes -->
* a
* b
* c
* d
* e
* f
* g
* h
{{div col end}}

Produces:

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

Content

{{div col|colwidth=10em|content= <!-- content parameter doesn't need {{div col end}} -->
* a
* b
* c
* d
* e
* f
* g
* h
}}

Produces:

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

Multiple Parameters

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

Produces:

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

Text characters without list markup

{{div col|colwidth=10em}} <!--Text characters without list markup -->
a
b
c
d
e
f
g
h
{{div col end}}

Produces

a b c d e f g h

Limitation

Sub-lists

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

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

Produces:

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

Turning off the break-inside: avoid-column; rule appears to help.

Tracking categories

TemplateData

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}}.

Template parameters

ParameterDescriptionTypeStatus
Column widthcolwidth

Specifies the width of columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.

Example
30em
Stringoptional
Rulesrules

Produces vertical rules between the columns if set to yes.

Example
yes
Stringoptional
Gap sizegap

Specifies the space between the content of adjacent columns.

Example
2em
Stringoptional
HTML classclass

Specifies any class or multiple space-delimited classes.

Example
plainlist nowrap
Stringoptional
CSS stylestyle

Specifies any custom styling.

Stringoptional
Contentcontent

Specifies the content to divide into columns

Contentoptional
Small fontsmall

Use a smaller font size (90%)

Example
yes
Stringoptional