Module:Compact list/sandbox/doc: Difference between revisions

VisualWikitext

Latest revision as of 21:23, 14 March 2025

@@ Line 1: / Line 1: @@
 <includeonly>
-{{Module:Compact list/doc}}
+==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 {{tl|hlist}} to print in the "A·B·C·D" format. If it is long, it will use {{tl|collapsible list}}. The threshold can be set with {{para|_limit}}.
+Typical usage in a parent template, which gathers all arguments named "foo":
+<code><nowiki>{{#invoke:Compact list|main|foo|_limit=4}}</nowiki></code>
+===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.
+<code><nowiki>{{#invoke:Compact list|main|ook|ook=A|spud=1234}}</nowiki></code> → A
+<code><nowiki>{{#invoke:Compact list|main|ook|ook1=A|ook_2=B}}</nowiki></code> → {{hlist|A|B}}
+<code><nowiki>{{#invoke:Compact list|main|ook|ook=A|ook1=B|ook2=C|ook3=D}}</nowiki></code> → {{hlist|A|B|C|D}}
+<code><nowiki>{{#invoke:Compact list|main|ook|ook1=A|ook5=B|ook20=C|ook3000=D|ook342345=E|foofoofoo=234}}</nowiki></code> → {{collapsible list|A|B|C|D|E}}
+<code><nowiki>{{#invoke:Compact list|main|ook|ook1=A|ook5=B|ook20=C|ook3000=D|ook342345=E|foofoofoo=234|_limit=5}}</nowiki></code> → {{hlist|A|B|C|D|E}}
+<code><nowiki>{{#invoke:Compact list|main|ook|ook=A|ook1=B|ook2=C|ook3=D|ook4=E|ook5=F|ook6=G}}</nowiki></code> → {{collapsible list|A|B|C|D|E|F|G}}
 [[Category:Module sandboxes]]
 [[Category:Module sand&test]]