Editing Template:Columns-list/doc

{{Documentation subpage}}

<!-- PLEASE ADD CATEGORIES AT THE END OF THIS PAGE -->
{{Hatnote|{{tl|Collist}} redirects here. You may be looking for {{tl|Collapsible list}}.}}
{{High-use}}
{{Tsh|cmn|collist|col-list}}
{{Lua|Module:Template wrapper|Module:Check for unknown parameters}}

'''Template:Columns-list''' turns a list into a list with columns. It is a wrapper for {{tl|div col}}, except it wraps the template by allowing for the content to be in the template rather than above and below.

== Use ==
The width of each column may be specified using {{para|colwidth}} and a value in ems.
 <nowiki>{{</nowiki>columns-list|colwidth=''width''|
 ''Text (usually a list)''
 <nowiki>}}</nowiki>
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 {{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 web browsers.

{{CSS3 multiple column layout}}

=== Examples ===
Here is an example:
<syntaxhighlight lang="wikitext">{{columns-list|colwidth=35em|
* [[George Washington]]
* [[John Adams]]
* [[Thomas Jefferson]]
* [[James Madison]]
* [[James Monroe]]
}}</syntaxhighlight>

which would render as:
{{clear}}<!-- just in case {{CSS3 multiple column layout}} pokes down this far -->
{{columns-list|colwidth=35em|
* [[George Washington]]
* [[John Adams]]
* [[Thomas Jefferson]]
* [[James Madison]]
* [[James Monroe]]
}}

HTML classes and CSS styles can also be added with the {{para|class}} and {{para|style}} parameters. For example:

<syntaxhighlight lang="wikitext">{{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]]
}}</syntaxhighlight>

which would render as:
{{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]]
}}

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

<syntaxhighlight lang="wikitext">
{{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{{snd}}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 ==
* {{tl|cmn}}
* {{tl|collist}}
* {{tl|col-list}}
* {{tl|Columnslist}}

== Tracking category ==
* {{clc|Pages using columns-list with unknown parameters}} (for pages in article space only)

== See also ==
{{Column-generating template families}}
{{HTML lists}}
<!-- == References ==
{{Reflist}} -->

<includeonly>{{Sandbox other||

<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:Multi-column templates]]
[[Category:List formatting and function templates]]
[[Category:Templates that add a tracking category]]
}}</includeonly>