Module:Separated entries/sandbox

Module documentation[view] [edit] [history] [purge]

Usage

Module:Separated entries and {{Separated entries}} serve as a template front-end to mw.text.listToText. They take any number of positional parameters and piece 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:

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

See also

• {{Enum}}
• {{Br separated entries}}
• {{#invoke:params|list_values}}

The above documentation is transcluded from Module:Separated entries/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Add categories to the /doc subpage. Subpages of this module.

local getArgs = require('Module:Arguments').getArgs
local compressSparseArray = require('Module:TableTools').compressSparseArray
local p = {}
 
function p.main(frame)
	local args = getArgs(frame, {
		trim = false,
		removeBlanks = true
	})
	return p._main(args)
end
 
function p._main(args)
	local separator = args.separator
		-- Decode (convert to Unicode) HTML escape sequences, such as " " for space.
		and mw.text.decode(args.separator) or ''
	local conjunction = args.conjunction and mw.text.decode(args.conjunction) or separator
	-- Discard named parameters.
	local values = compressSparseArray(args)

	return mw.text.listToText(values, separator, conjunction)
end
 
return p