Difference between revisions of "Template:Columns-list/doc"

From blackwiki
Jump to navigation Jump to search
imported>WOSlinker
m (change source to syntaxhighlight)
 
(20 intermediate revisions by 9 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
{{Update|documentation|date=October 2015}}
 
 
<!-- PLEASE ADD CATEGORIES AT THE END OF THIS PAGE -->
 
<!-- PLEASE ADD CATEGORIES AT THE END OF THIS PAGE -->
 
+
{{Hatnote|{{tl|Collist}} redirects here. You may be looking for {{tl|Collapsible list}}.}}
 
{{Tsh|cmn|collist|col-list}}
 
{{Tsh|cmn|collist|col-list}}
 +
{{Lua|Module:Check for unknown parameters}}
  
 
This template is for use in a list in the body of an article, rather than in a navigation template like [[Template:Navbox]]. Based on [[Template:Reflist]], but different in that the text to be displayed is manually created rather than a list of references.
 
This template is for use in a list in the body of an article, rather than in a navigation template like [[Template:Navbox]]. Based on [[Template:Reflist]], but different in that the text to be displayed is manually created rather than a list of references.
  
 
== Use ==
 
== Use ==
The usage of fixed columns is '''deprecated''' and should be removed or replaced by the usage of colwidth (further below):
+
The width of each column may be specified using {{para|colwidth}} and a value in ems.
<s>
 
<nowiki>{{</nowiki>columns-list|''number of columns''|
 
''Text (usually a list)''
 
<nowiki>}}</nowiki>
 
</s>
 
 
 
The width of each column may be specified using
 
 
  <nowiki>{{</nowiki>columns-list|colwidth=''width''|
 
  <nowiki>{{</nowiki>columns-list|colwidth=''width''|
 
  ''Text (usually a list)''
 
  ''Text (usually a list)''
Line 21: Line 14:
 
Here, ''width'' specifies the width of the columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.
 
Here, ''width'' specifies the width of the columns, and determines dynamically the number of columns based on screen width; more columns will be shown on wider displays.
  
This template uses [[CSS]]3 multiple column layout and is not supported by all [[WWW|Web]] [[Web browser|browsers]].
+
If {{para|colwidth}} is not specified, the default width of 30em will be used.
 +
 
 +
This template uses [[CSS]]3 multiple-column layout, which is not supported by all [[WWW|Web]] [[Web&nbsp;browser|browsers]].
  
 
{{CSS3 multiple column layout}}
 
{{CSS3 multiple column layout}}
Line 27: Line 22:
 
=== Examples ===
 
=== Examples ===
 
Here is an example:
 
Here is an example:
<source lang=text>{{columns-list|colwidth=35em|
+
<syntaxhighlight lang=text>{{columns-list|colwidth=35em|
 
* [[George Washington]]
 
* [[George Washington]]
 
* [[John Adams]]
 
* [[John Adams]]
Line 33: Line 28:
 
* [[James Madison]]
 
* [[James Madison]]
 
* [[James Monroe]]
 
* [[James Monroe]]
}}</source>
+
}}</syntaxhighlight>
  
 
which would render as:
 
which would render as:
Line 45: Line 40:
 
}}
 
}}
  
[[CSS]] styles can also be added after the number of columns. For example:
+
[[CSS]] styles can also be added with the {{para|style}} parameter. For example:
  
<source lang=text>{{columns-list|colwidth=35em|style=width: 400px; font-style: italic;|
+
<syntaxhighlight lang=text>{{columns-list|colwidth=15em|style=width: 600px; font-style: italic;|
 
* [[All About Lily Chou-Chou]]
 
* [[All About Lily Chou-Chou]]
 
* [[April Story]]
 
* [[April Story]]
Line 58: Line 53:
 
* [[Rainbow Song]]
 
* [[Rainbow Song]]
 
* [[Swallowtail (film)|Swallowtail]]
 
* [[Swallowtail (film)|Swallowtail]]
}}</source>
+
}}</syntaxhighlight>
  
 
which would render as:
 
which would render as:
{{columns-list|colwidth=35em|style=width: 400px; font-style: italic;|
+
{{columns-list|colwidth=15em|style=width: 600px; font-style: italic;|
 
* [[All About Lily Chou-Chou]]
 
* [[All About Lily Chou-Chou]]
 
* [[April Story]]
 
* [[April Story]]
Line 73: Line 68:
 
* [[Swallowtail (film)|Swallowtail]]
 
* [[Swallowtail (film)|Swallowtail]]
 
}}
 
}}
 +
 +
This template also works with numbered lists as its "text". For example:
 +
 +
<syntaxhighlight lang=text>
 +
{{columns-list|colwidth=35em|
 +
# [[George Washington]]
 +
# [[John Adams]]
 +
# [[Thomas Jefferson]]
 +
# [[James Madison]]
 +
# [[James Monroe]]
 +
}}
 +
</syntaxhighlight>
 +
 +
{{columns-list|colwidth=35em|
 +
# [[George Washington]]
 +
# [[John Adams]]
 +
# [[Thomas Jefferson]]
 +
# [[James Madison]]
 +
# [[James Monroe]]
 +
}}
 +
 +
The template, in fact, works with ''everything'' since all it does is wrap the text provided around a block to be divided into columns by CSS. Do not stop at wikitext lists &ndash; more advanced lists generated by [[Template:HTML lists|the HTML templates]] will work too!
 +
 +
==Error messages==
 +
Use of the no-longer-supported parameter {{para|cols}}, or use of the first unnamed parameter (aka {{para|1}}) along with {{para|2}} or a second unnamed parameter for the template's content, will generate a red error message. To fix this error, use {{para|colwidth}} instead of attempting to specify the number of columns.
 +
 +
The presence of an equals sign within the template's content can also cause display problems and red error messages. To fix this problem, add {{para|1}} in front of the template's content.
  
 
== Redirects ==
 
== Redirects ==
Line 79: Line 101:
 
* {{tl|col-list}}
 
* {{tl|col-list}}
 
* {{tl|Columnslist}}
 
* {{tl|Columnslist}}
 +
 +
== Tracking category ==
 +
* {{clc|Pages using columns-list with unknown parameters}} (for pages in article space only)
  
 
== See also ==
 
== See also ==
 
{{Column-generating template families}}
 
{{Column-generating template families}}
 
+
{{HTML lists}}
 
<!-- == References ==
 
<!-- == References ==
 
{{Reflist}} -->
 
{{Reflist}} -->
  
<includeonly>
+
<includeonly>{{Sandbox other||
{{#ifeq:{{SUBPAGENAME}}|sandbox | |
+
 
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
<!-- Categories below this line, please; interwikis at Wikidata -->
 
[[Category:Multi-column templates]]
 
[[Category:Multi-column templates]]
}}
+
[[Category:List formatting and function templates]]
</includeonly>
+
[[Category:Templates that add a tracking category]]
 +
}}</includeonly>

Latest revision as of 12:56, 7 July 2020

This template is for use in a list in the body of an article, rather than in a navigation template like Template:Navbox. Based on Template:Reflist, but different in that the text to be displayed is manually created rather than a list of references.

Use

The width of each column may be specified using |colwidth= and a value in ems.

{{columns-list|colwidth=width|
Text (usually a list)
}}

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

If |colwidth= is not specified, the default width of 30em will be used.

This template uses CSS3 multiple-column layout, which is not supported by all Web browsers.

CSS3 multiple-column layout browser support
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)

Examples

Here is an example:

{{columns-list|colwidth=35em|
* [[George Washington]]
* [[John Adams]]
* [[Thomas Jefferson]]
* [[James Madison]]
* [[James Monroe]]
}}

which would render as:

CSS styles can also be added with the |style= parameter. For example:

{{columns-list|colwidth=15em|style=width: 600px; font-style: italic;|
* [[All About Lily Chou-Chou]]
* [[April Story]]
* [[Hana and Alice|Hana & Alice]]
* [[Hōtai Club]]
* [[The Kon Ichikawa Story]]
* [[Love Letter (1995 film)|Love Letter]]
* [[New York, I Love You]]
* [[Picnic (1996 film)|Picnic]]
* [[Rainbow Song]]
* [[Swallowtail (film)|Swallowtail]]
}}

which would render as:

This template also works with numbered lists as its "text". For example:

{{columns-list|colwidth=35em|
# [[George Washington]]
# [[John Adams]]
# [[Thomas Jefferson]]
# [[James Madison]]
# [[James Monroe]]
}}

The template, in fact, works with everything since all it does is wrap the text provided around a block to be divided into columns by CSS. Do not stop at wikitext lists – more advanced lists generated by the HTML templates will work too!

Error messages

Use of the no-longer-supported parameter |cols=, or use of the first unnamed parameter (aka |1=) along with |2= or a second unnamed parameter for the template's content, will generate a red error message. To fix this error, use |colwidth= instead of attempting to specify the number of columns.

The presence of an equals sign within the template's content can also cause display problems and red error messages. To fix this problem, add |1= in front of the template's content.

Redirects

Tracking category

See also

Column-generating template families

<section begin="table" />

Family Type
Handles wiki
 table code?Script error: No such module "If empty".
Responsive/
Mobile suited
Start template Column divider End template
"Col" Table Yes Yes {{Col-begin}},
{{Col-begin-fixed}} or
{{Col-begin-small}}
{{Col-break}} or
{{Col-2}} .. {{Col-5}}
{{Col-end}}
"Col-float" CSS float Yes Yes {{Col-float}} {{Col-float-break}} {{Col-float-end}}
"Columns" Table No Yes {{Columns}}
"Columns-list" CSS columns Yes Yes {{Columns-list}} (wrapper)
"Columns-start" CSS float Yes Yes {{Columns-start}} {{Column}} {{Columns-end}}
"Flex columns" CSS flexbox Yes Yes {{Flex columns}}
"Div col" CSS columns Yes Yes {{Div col}} {{Div col end}}

Script error: No such module "If empty". I.e., can the columns handle the wiki markup {| | || |- |} used to create tables? If not, templates that produce these elements (such as {{(!}}, {{!}}, {{!!}}, {{!-}}, {{!)}}) or HTML tags (<table>...</table>, <tr>...</tr>, etc.) will need to be used instead.<section end="table" />