Difference between revisions of "Module:Separated entries"
Jump to navigation
Jump to search
imported>Kelapstick m (Protected Module:Separated entries: Highly visible template ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))) |
imported>Izkala (Update from sandbox, with a couple of changes) |
||
| Line 1: | Line 1: | ||
| − | + | -- 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". | ||
| + | |||
local compressSparseArray = require('Module:TableTools').compressSparseArray | local compressSparseArray = require('Module:TableTools').compressSparseArray | ||
local p = {} | local p = {} | ||
| − | + | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
function p._main(args) | function p._main(args) | ||
local separator = args.separator | local separator = args.separator | ||
| Line 18: | Line 14: | ||
-- Discard named parameters. | -- Discard named parameters. | ||
local values = compressSparseArray(args) | local values = compressSparseArray(args) | ||
| + | return mw.text.listToText(values, separator, conjunction) | ||
| + | end | ||
| − | return | + | local function makeInvokeFunction(separator, conjunction) |
| + | return function (frame) | ||
| + | local args = require('Module:Arguments').getArgs(frame) | ||
| + | args.separator = separator or args.separator | ||
| + | args.conjunction = conjunction or args.conjunction | ||
| + | return p._main(args) | ||
| + | end | ||
end | end | ||
| − | + | ||
| + | p.main = makeInvokeFunction() | ||
| + | p.br = makeInvokeFunction('<br />') | ||
| + | p.comma = makeInvokeFunction(mw.message.new('comma-separator'):plain()) | ||
| + | |||
return p | return p | ||
Revision as of 19:01, 26 May 2015
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
 | This Lua module is used on approximately 1,750,000 pages. To avoid large-scale disruption and unnecessary server load, any changes to it should first be tested in the module's /sandbox or /testcases subpages. The tested changes can then be added to this page in a single edit. Please consider discussing changes on the talk page before implementing them. |
Usage
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; if the |separator= should contain spaces, use the HTML escape code  . Separated entries does not raise any errors by design.
{{#invoke:Separated entries|main|separator=...}}
-- 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".
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 named parameters.
local values = compressSparseArray(args)
return mw.text.listToText(values, separator, conjunction)
end
local function makeInvokeFunction(separator, conjunction)
return function (frame)
local args = require('Module:Arguments').getArgs(frame)
args.separator = separator or args.separator
args.conjunction = conjunction or args.conjunction
return p._main(args)
end
end
p.main = makeInvokeFunction()
p.br = makeInvokeFunction('<br />')
p.comma = makeInvokeFunction(mw.message.new('comma-separator'):plain())
return p
