Module:Separated entries

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|trimming_values|with_value_not_matching||strict|squeezing|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.
Subpages of this module.

-- This module takes positional parameters as input and concatenates them with
-- an optional separator. The final separator (the "conjunction") can be
-- specified independently, enabling natural-language lists like
-- "foo, bar, baz and qux". The starting parameter can also be specified.

local compressSparseArray = require('Module:TableTools').compressSparseArray
local p = {}

function p._main(args)
	local dataPlural = args.dataPlural
	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 values before the starting parameter.
	local start = tonumber(args.start)
	if start then
		for i = 1, start - 1 do args[i] = nil end
	end
	-- Discard named parameters.
	local values = compressSparseArray(args)
	local result = mw.text.listToText(values, separator, conjunction)
	if dataPlural and #values > 0 and (#separator > 0 or #conjunction > 0) then
		-- flag to [[Module:Detect singular]] whether this is a list with >1 element
		result = result..'<span style="display:none" data-plural="'..(#values > 1 and '1' or '0')..'"></span>'
	end
	return result
end

local function makeInvokeFunction(separator, conjunction, first)
	return function (frame)
		local args = require('Module:Arguments').getArgs(frame)
		args.separator = separator or args.separator
		args.conjunction = conjunction or args.conjunction
		args.first = first or args.first
		return p._main(args)
	end
end

p.main = makeInvokeFunction()
p.br = makeInvokeFunction('<br />')
p.comma = makeInvokeFunction(mw.message.new('comma-separator'):plain())

return p