Editing Module:Separated entries/doc

{{Module other|{{Module rating|p}}{{used in system}}{{Lua|Module:Arguments|Module:TableTools}}|{{high-use}}{{Lua|Module:Separated entries}}}}

<!-- Please, place template categories where indicated at the bottom of this page. -->
== Usage ==
[[Module:Separated entries]] and {{tl|Separated entries}} serve as a template front-end to <code>[[mw:Extension:Scribunto/Lua reference manual#mw.text.listToText|mw.text.listToText]]</code>. They take [[Variadic function|any number]] of positional parameters and [[Concatenation|piece them together]] with {{Para|separator}}. {{Para|conjunction}} can be optionally defined if a different separator is desired between the last and second last items. The starting positional parameter can be specified using {{Para|start}}. Leading and trailing whitespace is stripped. To add deliberate leading and trailing whitespace, use the HTML entity <code>&amp;#32;</code> for a space and <code>&amp;#10;</code> for a "newline". Separated entries does not raise any errors by design.

<syntaxhighlight lang="wikitext">{{#invoke:separated entries|main|separator=...}}</syntaxhighlight>

For more complex cases – such as selecting the parameters to list, or preprocessing them, or omitting the last parameters – {{mfl|params|list_values}} is available. The following two examples with “ + ” as delimiter and “ ... ” as conjunction produce a similar result:

# <syntaxhighlight lang="wikitext" inline>{{#invoke:separated entries|main|separator=&#32;+&#32;|conjunction=&#32;...&#32;}}</syntaxhighlight>
# <syntaxhighlight lang="wikitext" inline>{{#invoke:params|sequential|squeezing|trimming_values|setting|i/l| + | ... |list_values}}</syntaxhighlight>

== See also ==
* {{Template link|Enum}}
* {{Template link|Br separated entries}}
* {{mfl|params|list_values}}

<includeonly>{{Sandbox other||
<!-- Template categories below this line, please. -->
[[Category:Template metamodules]]
}}</includeonly>