close
Sayahna Sayahna
Search

Difference between revisions of "Module:List"


(remove li_style, ul_style and ol_style parameters, allow itemn_style and itemn_value parameters, and add a tracking category for item_stylen and item_valuen parameters)
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
-- This module outputs different kinds of lists. At the moment, bulleted,
+
-- This module outputs different kinds of lists. At the moment, bulleted, unbulleted,
-- unbulleted, horizontal, ordered, and horizontal ordered lists are supported.
+
-- horizontal, ordered, and horizontal ordered lists are supported.
  
local libUtil = require('libraryUtil')
+
local p = {}
local checkType = libUtil.checkType
 
local mTableTools = require('Module:TableTools')
 
  
local p = {}
+
local getArgs = require('Module:Arguments').getArgs
 +
local htmlBuilder = require('Module:HtmlBuilder')
  
local listTypes = {
+
local function getListItem(data, style, itemStyle, itemValue)
['bulleted'] = true,
+
if not data then
['unbulleted'] = true,
+
return c
['horizontal'] = true,
+
end
['ordered'] = true,
+
local item = htmlBuilder.create('li')
['horizontal_ordered'] = true
+
item
}
+
.cssText(style)
 +
.cssText(itemStyle)
 +
.wikitext(data)
 +
if(itemValue) then
 +
item.attr('value',itemValue)
 +
end
 +
return tostring(item)
 +
end
  
function p.makeListData(listType, args)
+
local function getArgNums(args)
-- Constructs a data table to be passed to p.renderList.
+
-- Returns an array containing the keys of all positional arguments that contain data (i.e. non-whitespace values).
local data = {}
+
local nums = {}
 +
for k, v in pairs(args) do
 +
if type(k) == 'number' and
 +
k >= 1 and
 +
math.floor(k) == k and
 +
mw.ustring.match(v, '%S') then
 +
table.insert(nums, k)
 +
end
 +
end
 +
table.sort(nums)
 +
return nums
 +
end
  
-- Classes
+
function p.makeList(listType, args)
data.classes = {}
+
-- This is the main function to be called from other Lua modules.
 +
-- First, get the list items.
 +
local listItems = {}
 +
local argNums = getArgNums(args)
 +
for i, num in ipairs(argNums) do
 +
local item = getListItem(
 +
args[num],
 +
args.item_style or args.li_style, -- li_style is included for backwards compatibility. item_style was included to be easier to understand for non-coders.
 +
args['item_style' .. tostring(num)] or args['li_style' .. tostring(num)],
 +
args['item_value' .. tostring(num)]
 +
)
 +
table.insert(listItems, item)
 +
end
 +
if #listItems == 0 then
 +
return ''
 +
end
 +
-- Build the opening div tag.
 +
local root = htmlBuilder.create('div')
 
if listType == 'horizontal' or listType == 'horizontal_ordered' then
 
if listType == 'horizontal' or listType == 'horizontal_ordered' then
table.insert(data.classes, 'hlist')
+
root.addClass('hlist')
 
elseif listType == 'unbulleted' then
 
elseif listType == 'unbulleted' then
table.insert(data.classes, 'plainlist')
+
root.addClass('plainlist')
 
end
 
end
table.insert(data.classes, args.class)
+
root.addClass(args.class)
 
 
-- Main div style
 
data.style = args.style
 
 
 
-- Indent for horizontal lists
 
 
if listType == 'horizontal' or listType == 'horizontal_ordered' then
 
if listType == 'horizontal' or listType == 'horizontal_ordered' then
 
local indent = tonumber(args.indent)
 
local indent = tonumber(args.indent)
indent = indent and indent * 1.6 or 0
+
indent = tostring((indent and indent * 1.6) or 0)
if indent > 0 then
+
root.css('margin-left', indent .. 'em')
data.marginLeft = indent .. 'em'
 
end
 
 
end
 
end
+
-- If we are outputting an ordered list or an ordered horizontal list, get the type and list-style-type.
-- List style types for ordered lists
+
-- Horizontal ordered lists aren't supported yet, but including them anyway in case support is ever added to the CSS backend.
-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
+
local listStyleType, typeAttr
-- type is either set by the "type" attribute or the "list-style-type" CSS
 
-- property.
 
 
if listType == 'ordered' or listType == 'horizontal_ordered' then  
 
if listType == 'ordered' or listType == 'horizontal_ordered' then  
data.listStyleType = args.list_style_type or args['list-style-type']
+
listStyleType = args.list_style_type or args['list-style-type']
data.type = args['type']
+
typeAttr = args['type']
 
+
end
-- Detect invalid type attributes and attempt to convert them to
+
-- Detect if the type attribute specified by args.type is using an invalid value, and if so try passing it as a list-style-type CSS property.
-- list-style-type CSS properties.
+
if typeAttr and not typeAttr:match('^%s*[1AaIi]%s*$') then
if data.type
+
if not listStyleType then
and not data.listStyleType
+
listStyleType = typeAttr
and not tostring(data.type):find('^%s*[1AaIi]%s*$')
+
typeAttr = nil
then
 
data.listStyleType = data.type
 
data.type = nil
 
 
end
 
end
 
end
 
end
+
root.cssText(args.style)
-- List tag type
+
-- Build the list tags and list items.
if listType == 'ordered' or listType == 'horizontal_ordered' then
+
local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
data.listTag = 'ol'
+
local start = args.start
else
+
list
data.listTag = 'ul'
+
.attr('start', start)
end
 
 
 
-- Start number for ordered lists
 
data.start = args.start
 
 
if listType == 'horizontal_ordered' then
 
if listType == 'horizontal_ordered' then
 
-- Apply fix to get start numbers working with horizontal ordered lists.
 
-- Apply fix to get start numbers working with horizontal ordered lists.
local startNum = tonumber(data.start)
+
local startNum = tonumber(start)
 
if startNum then
 
if startNum then
data.counterReset = 'listitem ' .. tostring(startNum - 1)
+
list.css('counter-reset', 'listitem ' .. tostring(startNum - 1))
 
end
 
end
 
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
 
list
:attr{start = data.start, type = data.type}
+
.attr('type', typeAttr)
:css{
+
.css('list-style-type', listStyleType)
['counter-reset'] = data.counterReset,
+
.cssText(args.list_style or args.ul_style or args.ol_style) -- ul_style and ol_style are included for backwards compatibility. No distinction is made for ordered or unordered lists.
['list-style-type'] = data.listStyleType
+
.wikitext(table.concat(listItems))
}
 
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)
 
return tostring(root)
 
end
 
end
  
function p.renderTrackingCategories(args)
+
local function makeWrapper(listType)
local isDeprecated = false -- Tracks deprecated parameters.
+
return function(frame)
for k, v in pairs(args) do
+
local args = getArgs(frame, {
k = tostring(k)
+
valueFunc = function (key, value)
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
+
if type(key) == 'number' or value ~= '' then
isDeprecated = true
+
return value
break
+
end
end
+
end
 +
})
 +
return p.makeList(listType, args)
 
end
 
end
local ret = ''
 
if isDeprecated then
 
ret = ret .. '[[Category:List templates with deprecated parameters]]'
 
end
 
return ret
 
 
end
 
end
  
function p.makeList(listType, args)
+
local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'ordered', 'horizontal_ordered'}
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)
 
local list = p.renderList(data)
 
local trackingCategories = p.renderTrackingCategories(args)
 
return list .. trackingCategories
 
end
 
  
for listType in pairs(listTypes) do
+
for _, funcName in ipairs(funcNames) do
p[listType] = function (frame)
+
p[funcName] = makeWrapper(funcName)
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
 
end
  
 
return p
 
return p

Latest revision as of 08:31, 22 August 2014

Documentation for this module may be created at Module:List/doc

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

local p = {}

local getArgs = require('Module:Arguments').getArgs
local htmlBuilder = require('Module:HtmlBuilder')

local function getListItem(data, style, itemStyle, itemValue)
	if not data then
		return c
	end
	local item = htmlBuilder.create('li')
	item
		.cssText(style)
		.cssText(itemStyle)
		.wikitext(data)
	if(itemValue) then
		item.attr('value',itemValue)
	end
	return tostring(item)
end

local function getArgNums(args)
	-- Returns an array containing the keys of all positional arguments that contain data (i.e. non-whitespace values).
	local nums = {}
	for k, v in pairs(args) do
		if type(k) == 'number' and 
			k >= 1 and 
			math.floor(k) == k and 
			mw.ustring.match(v, '%S') then
				table.insert(nums, k)
		end
	end
	table.sort(nums)
	return nums
end

function p.makeList(listType, args)
	-- This is the main function to be called from other Lua modules.
	-- First, get the list items.
	local listItems = {}
	local argNums = getArgNums(args)
	for i, num in ipairs(argNums) do
		local item = getListItem(
			args[num],
			args.item_style or args.li_style, -- li_style is included for backwards compatibility. item_style was included to be easier to understand for non-coders.
			args['item_style' .. tostring(num)] or args['li_style' .. tostring(num)],
			args['item_value' .. tostring(num)]
		)
		table.insert(listItems, item)
	end
	if #listItems == 0 then
		return ''
	end
	-- Build the opening div tag.
	local root = htmlBuilder.create('div')
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		root.addClass('hlist')
	elseif listType == 'unbulleted' then
		root.addClass('plainlist')
	end
	root.addClass(args.class)
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		local indent = tonumber(args.indent)
		indent = tostring((indent and indent * 1.6) or 0)
		root.css('margin-left', indent .. 'em')
	end
	-- If we are outputting an ordered list or an ordered horizontal list, get the type and list-style-type.
	-- Horizontal ordered lists aren't supported yet, but including them anyway in case support is ever added to the CSS backend.
	local listStyleType, typeAttr
	if listType == 'ordered' or listType == 'horizontal_ordered' then 
		listStyleType = args.list_style_type or args['list-style-type']
		typeAttr = args['type']
	end
	-- Detect if the type attribute specified by args.type is using an invalid value, and if so try passing it as a list-style-type CSS property.
	if typeAttr and not typeAttr:match('^%s*[1AaIi]%s*$') then
		if not listStyleType then
			listStyleType = typeAttr
			typeAttr = nil
		end
	end
	root.cssText(args.style)
	-- Build the list tags and list items.
	local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
	local start = args.start
	list
		.attr('start', start)
	if listType == 'horizontal_ordered' then
		-- Apply fix to get start numbers working with horizontal ordered lists.
		local startNum = tonumber(start)
		if startNum then
			list.css('counter-reset', 'listitem ' .. tostring(startNum - 1))
		end
	end
	list
		.attr('type', typeAttr)
		.css('list-style-type', listStyleType)
		.cssText(args.list_style or args.ul_style or args.ol_style) -- ul_style and ol_style are included for backwards compatibility. No distinction is made for ordered or unordered lists.
		.wikitext(table.concat(listItems))
	return tostring(root)
end

local function makeWrapper(listType)
	return function(frame)
		local args = getArgs(frame, {
			valueFunc = function (key, value)
				if type(key) == 'number' or value ~= '' then
					return value
				end
			end
		})
		return p.makeList(listType, args)
	end
end

local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'ordered', 'horizontal_ordered'}

for _, funcName in ipairs(funcNames) do
	p[funcName] = makeWrapper(funcName)
end

return p