Module:List

List template. Based on MediaWiki List Module

About

Creates a list in a specified format.

Parameter

Do not use named parameter for 1 ... x. The first Parameter will be automatically marked as 1, the second as 2 and so on.

Parameter		Description	Type	Status
listType	1	List type Default: NULL Example: {{#invoke:list|bulleted|a|b|c}} a b c {{#invoke:list|unbulleted|a|b|c}} a b c {{#invoke:list|horizontal|a|b|c}} a b c {{#invoke:list|ordered|a|b|c}} a b c {{#invoke:list|horizontal_ordered|a|b|c}} a b c	[ "bulleted" | "unbulleted" | "horizontal" | "ordered" | "horizontal_ordered" ]	Required
listEntries	2...x	List entries Default: NULL Example: no example	WikiCode	Optional
olStart	start	Start entry. <ol start=""> MDN (ol). Requires listType [ "ordered" | "horizontal_ordered" ] Default: 1 Example: {{#invoke:list|ordered|a|b|c|start=5}} a b c {{#invoke:list|ordered|a|b|c|start=-5}} a b c	SignedNumber	Optional
olType	type	Ordered list type. <ol type=""> MDN (ol). Requires listType [ "ordered" | "horizontal_ordered" ]. It's recommended to use style,class or param list_style_type instead Default: 1 Example: {{#invoke:list|ordered|a|b|c|type=i}} a b c {{#invoke:list|ordered|a|b|c|type=a}} a b c	[ "1" | "a" | "A" | "i" | "I" ]	Optional
cssType	list_style_type	Recommended list style type. Uses the css attribute list-style-type Default: NULL Example: {{#invoke:list|ordered|a|b|c|list_style_type=lower-alpha}} a b c {{#invoke:list|ordered|a|b|c|list_style_type=lower-greek}} a b c {{#invoke:list|ordered|a|b|c|list_style_type=decimal-leading-zero}} a b c	MDN (list-style-type)	Optional
divClass	class	class attribute for the <div>...</div> surrounding the list Default: NULL Example: no example	String	Optional
divStyle	style	style attribute for the <div>...</div> surrounding the list Default: NULL Example: no example	String	Optional
listStyle	list_style	style attribute for the list Default: NULL Example: no example	String	Optional
itemStyle	item_style	style attribute for the list items Default: NULL Example: no example	String	Optional
itemXStyle	item1_style...itemX_style	style attribute for item x in list Default: NULL Example: no example	String	Optional
itemXValue	item1_value...itemX_value	value attribute for item x in list Default: NULL Example: no example	String	Optional
listIndent	indent	Set margin-left for list (intent * 1.6 em) Default: NULL Example: no example	String	Optional

See Template:TemplateData and Template:TemplateData/entry for more information about the parameter list and DDNCode for more information about types and the DDN Notation

Examples

• First item
• Second item
• Third item

{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;color:black;}}

---

-- This module outputs different kinds of lists. At the moment, bulleted,
-- unbulleted, horizontal, ordered, and horizontal ordered lists are supported.

local libUtil = require('libraryUtil')
local checkType = libUtil.checkType
local mTableTools = require('Module:TableTools')

local p = {}

local listTypes = {
	['bulleted'] = true,
	['unbulleted'] = true,
	['horizontal'] = true,
	['ordered'] = true,
	['horizontal_ordered'] = true
}

function p.makeListData(listType, args)
	-- Constructs a data table to be passed to p.renderList.
	local data = {}

	-- Classes
	data.classes = {}
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		table.insert(data.classes, 'hlist')
	elseif listType == 'unbulleted' then
		table.insert(data.classes, 'plainlist')
	end
	table.insert(data.classes, args.class)

	-- Main div style
	data.style = args.style

	-- Indent for horizontal lists
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		local indent = tonumber(args.indent)
		indent = indent and indent * 1.6 or 0
		if indent > 0 then
			data.marginLeft = indent .. 'em'
		end
	end
	
	-- List style types for ordered lists
	-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
	-- type is either set by the "type" attribute or the "list-style-type" CSS
	-- property.
	if listType == 'ordered' or listType == 'horizontal_ordered' then 
		data.listStyleType = args.list_style_type or args['list-style-type']
		data.type = args['type']

		-- Detect invalid type attributes and attempt to convert them to
		-- list-style-type CSS properties.
		if data.type 
			and not data.listStyleType
			and not tostring(data.type):find('^%s*[1AaIi]%s*$')
		then
			data.listStyleType = data.type
			data.type = nil
		end
	end
	
	-- List tag type
	if listType == 'ordered' or listType == 'horizontal_ordered' then
		data.listTag = 'ol'
	else
		data.listTag = 'ul'
	end

	-- Start number for ordered lists
	data.start = args.start
	if listType == 'horizontal_ordered' then
		-- Apply fix to get start numbers working with horizontal ordered lists.
		local startNum = tonumber(data.start)
		if startNum then
			data.counterReset = 'listitem ' .. tostring(startNum - 1)
		end
	end

	-- List style
	 -- ul_style and ol_style are included for backwards compatibility. No
	 -- distinction is made for ordered or unordered lists.
	data.listStyle = args.list_style

	-- List items
	-- li_style is included for backwards compatibility. item_style was included
	-- to be easier to understand for non-coders.
	data.itemStyle = args.item_style or args.li_style
	data.items = {}
	for i, num in ipairs(mTableTools.numKeys(args)) do
		local item = {}
		item.content = args[num]
		item.style = args['item' .. tostring(num) .. '_style']
			or args['item_style' .. tostring(num)]
		item.value = args['item' .. tostring(num) .. '_value']
			or args['item_value' .. tostring(num)]
		table.insert(data.items, item)
	end
	
	return data
end

function p.renderList(data)
	-- Renders the list HTML.
	
	-- Return the blank string if there are no list items.
	if type(data.items) ~= 'table' or #data.items < 1 then
		return ''
	end
	
	-- Render the main div tag.
	local root = mw.html.create('div')
	for i, class in ipairs(data.classes or {}) do
		root:addClass(class)
	end
	root:css{['margin-left'] = data.marginLeft}
	if data.style then
		root:cssText(data.style)
	end

	-- Render the list tag.
	local list = root:tag(data.listTag or 'ul')
	list
		:attr{start = data.start, type = data.type}
		:css{
			['counter-reset'] = data.counterReset,
			['list-style-type'] = data.listStyleType
		}
	if data.listStyle then
		list:cssText(data.listStyle)
	end

	-- Render the list items
	for i, t in ipairs(data.items or {}) do
		local item = list:tag('li')
		if data.itemStyle then
			item:cssText(data.itemStyle)
		end
		if t.style then
			item:cssText(t.style)
		end
		item
			:attr{value = t.value}
			:wikitext(t.content)
	end

	return tostring(root)
end

function p.makeList(listType, args)
	if not listType or not listTypes[listType] then
		error(string.format(
			"bad argument #1 to 'makeList' ('%s' is not a valid list type)",
			tostring(listType)
		), 2)
	end
	checkType('makeList', 2, args, 'table')
	local data = p.makeListData(listType, args)
	return p.renderList(data)
end

for listType in pairs(listTypes) do
	p[listType] = function (frame)
		local mArguments = require('Module:Arguments')
		local origArgs = mArguments.getArgs(frame)
		-- Copy all the arguments to a new table, for faster indexing.
		local args = {}
		for k, v in pairs(origArgs) do
			args[k] = v
		end
		return p.makeList(listType, args)
	end
end

return p