Module:Enumerate

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

Usage

This module is meant to be invoked inside of a template, since it requires the argument list of the calling template.

This module allows the enumeration of a set of parameters with a given prefix. If the prefix was notes, the parameters notes1, notes2, notes3, and so on will be enumerated in a unordered list until it sees the first null parameter.

The prefix is defined by the first argument passed into the invocation.

Template:X35
{{#invoke:Enumerate|main|notes}}
Any page
{{X35 | notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. | notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. | notes3 = Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. | notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. }}
Output

The entries will cut off in the event that the parameters are out of order.

Template:X35
{{#invoke:Enumerate|main|notes}}
Any page
{{X35 | notes1 = Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. | notes2 = Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. | notes3 = | notes4 = Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. }}
Output

Do note that {{X35}} is sandbox template and does not actually call this module.

Parameters

• |1= (or |prefix=) - The parameter prefix to enumerate over. Can be left blank.
• |2= (or |suffix=) - The parameter suffix to enumerate over. Can be left blank.
• |ordered=yes - Set to a yes, true, etc. to output a ordered list (<ol>) rather than a unorder list (<ul>)

• |pre= - Text to prefix each list item with.
• |post= - Text to suffix each list item with.

Examples uses

• {{CCI project update}}

See also

• {{#invoke:params|with_name_matching}}

The above documentation is transcluded from Module:Enumerate/doc. (edit | history)
Editors can experiment in this module's sandbox (create | mirror) and testcases (create) pages.
Subpages of this module.

-- Enumerates a given parameter set from the invoking template as a bullet list.
local endswith = require("Module:String").endswith;
local yesno = require("Module:Yesno");
local p = {}

function p.main(frame)
	local args = getArgs(frame, {
		trim = true,
		removeBlanks = false
	})

    return p._main(frame, args)
end

function startswith(target, prefix)
	return string.sub(target, 1, string.len(prefix)) == prefix
end

function p._main(frame, args)
	if not args[1] then
		error("A parameter prefix to use was not found.")
	end
	
	local prefix = args[1]
	local toEnumerate = {}
	
	for param,_ in ipairs(args) do
		if startswith(param, prefix) then
			if args[2] and not endswith(param, args[2]) then
				toEnumerate.insert(param);
			elseif args[1] == nil then
				toEnumerate.insert(param);
			end
		end
	end
	
	local finalOutput = ""
	
	for param in toEnumerate do
		finalOutput = frame:preprocess(
			(yesno(args["ordered"]) and "#" or "*") .. args[param] .. "\n"
		)
	end
	
	return finalOutput
end

return p