Template:Columns-list/doc

{{Documentation subpage}}

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

{{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 {{para|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}}

= Examples =

Here is an example:

{{columns-list|colwidth=35em|

}}

which would render as:

{{clear}}

{{columns-list|colwidth=35em|

}}

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

{{columns-list|colwidth=15em|style=width: 600px; font-style: italic;|

}}

which would render as:

{{columns-list|colwidth=15em|style=width: 600px; font-style: italic;|

}}

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

{{columns-list|colwidth=35em|

  1. George Washington
  2. John Adams
  3. Thomas Jefferson
  4. James Madison
  5. James Monroe

}}

{{columns-list|colwidth=35em|

  1. George Washington
  2. John Adams
  3. Thomas Jefferson
  4. James Madison
  5. 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 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}}

{{Sandbox other||

Category:Multi-column templates

Category:List formatting and function templates

Category:Templates that add a tracking category

}}

{

"params": {

"1": {

"label": "Content",

"description": "Specifies the content to divide into columns",

"type": "string"

},

"colwidth": {

"label": "Columns / 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.",

"example": "20em",

"type": "string",

"default": "30"

},

"style": {

"label": "CSS style",

"description": "Specifies any custom styling.",

"example": "width: 600px; font-style: italic;",

"type": "string"

},

"class": {

"label": "HTML class",

"description": "Specifies any class or multiple space-delimited classes.",

"example": "plainlist nowrap",

"type": "string"

}

},

"description": "Turns a list into a list with columns. It is a wrapper for {{div col}}, except it wraps the template by allowing for the content to be in the template rather than above and below."

}