Difference between revisions of "Template:Div col/doc"
(Cleanup) |
m (1 revision imported) |
(No difference)
| |
Latest revision as of 11:29, 4 February 2021
{{#switch:<translate></translate> | = {{#ifeq:div col/doc |doc
|
{{#ifeq:show |show
| Template:Mbox }}{{#if: | | {{#ifexist:Template:Div col/doc | [[Category:{{#switch:Template |Template=Template |Module=Module |User=User |#default=Wikipedia}} documentation pages]] | }} }} | }}
| #default=
{{#invoke:Template translation|renderTranslatedTemplate|template=Template:Documentation subpage|noshift=1|uselang=<lang>}}
}} <templatestyles src="Template:Ombox/styles.css" /> {{#invoke:Message box|ombox}} {{#invoke:Lua banner|main}}
Template:Tl formats a list into columns that wrap properly and compatibly with portable computer devices, especially PAD operating systems and small screens.
Contents
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 Template:Para 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 Template:Tl. The Template:Tl 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 (Template:Para), place vertical lines parameter ("rules") between the columns (Template:Para) and to add other custom styling (Template:Para).
Template:Tl 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:
- Template:Para
- 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. - Template:Para
- Adds vertical lines ("rules") between the columns if set to
yesor some CSS styling (e.g.1px dashed blue;). - Template:Para
- 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. - Template:Para
- CSS styling to apply to the columns.
- Template:Para
- sets font size to 90%.
- Template:Para
- 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
</div>
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
</div>
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
</div>
Example of "small" parameter
- Example showing how setting "small" parameter to "yes" produces smaller font size
{{Div col|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
</div>
Example of "content" parameter
- Example showing how to provide "content" parameter without using Template:Tlx
{{Div col|colwidth=10em|content=
* a
* b
* c
* d
* e
* f
* g
* h
}}
- produces
Usage with multiple parameters
Parameters can be used in any order. Example:
{{Div col|colwidth=10em|rules=yes|gap=2em|small=yes}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
or
{{Div col|rules=yes|gap=2em|small=yes|colwidth=10em}}
* a
* b
* c
* d
* e
* f
* g
* h
{{Div col end}}
- produces
- a
- b
- c
- d
- e
- f
- g
- h
</div> and exactly the same result below
- a
- b
- c
- d
- e
- f
- g
- h
</div>
- 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
</div>
- 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
</div>
- 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 </div>
Tracking categories
- Pages using div col with unknown parameters (for erroneous use of parameter names not documented here)
- Pages using div col with small parameter
TemplateData
Template:TemplateDataHeader {{#switch: Div col/doc |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>.", "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" }, "small": { "label": "Small font", "description": "Use a smaller font size (90%)", "example": "yes", "type": "string", "default": "no" } } } </templatedata> |Div col end=<templatedata> {
"description": "Ends a multi-column list started by . It takes no parameters.",
"params": {
}
} </templatedata> }}
