Module:Compact list/doc

This is a documentation subpage for Module:Compact list.
It may contain usage information, categories and other content that is not part of the original module page.

This Lua module is used on approximately 1,800 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

Usage

Lua code for inside of another template (e.g., an infobox). Creates a compact list out of a set of named arguments. For example, if the argument to this module is "foo", it searches for all arguments named "foo" followed by an optional underscore followed by one or more digits. It then assembles all of the named argument into a "pretty printed" list, in numerical order. If the list is short (<= 4 long), the module uses {{hlist}} to print in the "A·B·C·D" format. If it is long, it will use {{collapsible list}}. The threshold can be set with |_limit=.

Typical usage in a parent template, which gathers all arguments named "foo":

{{#invoke:Compact list|main|foo|_limit=4}}

Examples

Note: these examples have the named arguments passed to the module directly. In practice, these named arguments would be passed to the template that invokes the module.

{{#invoke:Compact list|main|ook|ook=A|spud=1234}} → A

{{#invoke:Compact list|main|ook|ook1=A|ook_2=B}} →

A
B

{{#invoke:Compact list|main|ook|ook=A|ook1=B|ook2=C|ook3=D}} →

A
B
C
D

{{#invoke:Compact list|main|ook|ook1=A|ook5=B|ook20=C|ook3000=D|ook342345=E|foofoofoo=234}} →

List

A
B
C
D
E

{{#invoke:Compact list|main|ook|ook1=A|ook5=B|ook20=C|ook3000=D|ook342345=E|foofoofoo=234|_limit=5}} →

A
B
C
D
E

{{#invoke:Compact list|main|ook|ook=A|ook1=B|ook2=C|ook3=D|ook4=E|ook5=F|ook6=G}} →

List

A
B
C
D
E
F
G