Module:Separated entries

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

This module depends on the following other modules:

• Module:Arguments
• Module:TableTools

This module was adapted from Module:Separated entries on Wikipedia.
Adaptation is noted for reference and attribution only. This module may differ from the original in function or in usage. The documentation on Wikipedia may be helpful in understanding this module.

The above documentation is transcluded from Module:Separated entries/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) 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 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)
    return mw.text.listToText(values, separator, conjunction)
end

local function makeInvokeFunction(separator, conjunction, first)
    return function (frame)
        local args = require('Module:Arguments').getArgs(frame, {
            parentFirst = true,
        })
        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