Module:Separated entries

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

This module depends on the following other modules:

• Module:Arguments
• Module:TableTools

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)
    local out = {}
    if #values > 0 and args.before then
        out[#out+1] = args.before
    end
    out[#out+1] = mw.text.listToText(values, separator, conjunction)
    if #values > 0 and args.after then
        out[#out+1] = args.after
    end
    return table.concat(out)
end

local function makeInvokeFunction(separator, conjunction, start)
    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.start = start or args.start
        return p._main(args)
    end
end

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

return p