Module:Separated entries/doc

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

‹ The template below (Module rating ) is being considered for merging with Template rating. See templates for discussion to help reach a consensus. ›

[画像:Warning] This Lua module is used in system messages, and on approximately 2,450,000 pages, or roughly 4% of all pages.
Changes to it can cause immediate changes to the Wikipedia user interface.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them.

This module depends on the following other modules:

Usage

[edit ]

Module:Separated entries serves as a template front-end to mw.text.listToText . It takes any number of positional parameters and pieces them together with |separator=. |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 |start=. Leading and trailing whitespace is stripped. To add deliberate leading and trailing whitespace, use the HTML entity   for a space and 
 for a "newline". Separated entries does not raise any errors by design.

{{#invoke:separated entries|main|separator=...}}

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

{{#invoke:separated entries|main|separator= + |conjunction= ... }}
{{#invoke:params|sequential|squeezing|trimming_values|setting|i/l| + | ... |list_values}}

Usage

See also