Module:Separated entries/doc

This is a documentation subpage for Module:Separated entries.
It contains usage information, categories and other content that is not part of the original module page.
To view the module page itself, see Module:Separated entries.

Description

This is a relatively simple Lua module taken from wikipedia:Module:Separated entries. Its only job is to splice a variable-length argument list with a given separator. It is powerful; a single-run test with 1000 arguments had a parser profile of 0.029 seconds (Real time usage).

Usage

1. {{#invoke:Separated entries|br|args}}
2. {{#invoke:Separated entries|comma|args}}
3. {{#invoke:Separated entries|main|separator=custom|args}}

In form 1, the entries given by args are separated by line breaks. In form 2, entries are separated by commas. In form 3, entries are separated by the arbitrary separator custom.

Multiple arguments are separated by the standard pipe character. Direct invocation of this module might look like:

{{#invoke:Separated entries|main|separator=•|one|two|three}}

But, as recommended by wikipedia:Wikipedia:Lua, it's preferred that templates call this module. For the case of Template:Br separated entries, the argument list is passed directly to the template with the code:

{{#invoke:Separated entries|br}}