Difference between revisions of "Module:List"

From BESA® Wiki
Jump to: navigation, search
m (1 revision)
(Create modified version of Module:Bulleted list. The code is by myself and User:Frietjes.)
(26 intermediate revisions by 2 users 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, horizontal, and numbered lists are supported.
−
-- 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 p = {}
  
−
local listTypes = {
+
local function getListItem(data, style, itemStyle)
−
['bulleted'] = true,
+
if not data then
−
['unbulleted'] = true,
+
return nil
−
['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
 
end
−
+
if style or itemStyle then
−
-- List tag type
+
style = style or ''
−
if listType == 'ordered' or listType == 'horizontal_ordered' then
+
itemStyle = itemStyle or ''
−
data.listTag = 'ol'
+
return mw.ustring.format(
 +
'<li style="%s%s">%s</li>',
 +
style, itemStyle, data
 +
)
 
else
 
else
−
data.listTag = 'ul'
+
return mw.ustring.format(
 +
'<li>%s</li>',
 +
data
 +
)
 
end
 
end
 +
end
  
−
-- Start number for ordered lists
+
local function getArgNums(args)
−
data.start = args.start
+
-- Returns an array containing the keys of all positional arguments
−
if listType == 'horizontal_ordered' then
+
-- that contain data (i.e. non-whitespace values).
−
-- Apply fix to get start numbers working with horizontal ordered lists.
+
local nums = {}
−
local startNum = tonumber(data.start)
+
for k, v in pairs(args) do
−
if startNum then
+
if type(k) == 'number' and
−
data.counterReset = 'listitem ' .. tostring(startNum - 1)
+
k >= 1 and
 +
math.floor(k) == k and
 +
mw.ustring.match(v, '%S') then
 +
table.insert(nums, k)
 
end
 
end
 
end
 
end
−
 
+
table.sort(nums)
−
-- List style
+
return nums
−
-- 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
 
end
  
−
function p.renderList(data)
+
local function getClass(listType, class)
−
-- Renders the list HTML.
+
local classes = {}
−
+
if listType == 'horizontal' then
−
-- Return the blank string if there are no list items.
+
table.insert(classes, 'hlist')
−
if type(data.items) ~= 'table' or #data.items < 1 then
+
elseif listType == 'unbulleted' then
−
return ''
+
table.insert(classes, 'plainlist')
 
end
 
end
−
+
table.insert(classes, class)
−
-- Render the main div tag.
+
local ret
−
local root = mw.html.create('div')
+
if #classes == 0 then
−
for i, class in ipairs(data.classes or {}) do
+
return nil
−
root:addClass(class)
+
 
end
 
end
−
root:css{['margin-left'] = data.marginLeft}
+
return mw.ustring.format(' class="%s"', table.concat(classes, ' '))
−
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
 
end
  
−
function p.renderTrackingCategories(args)
+
local function getStyle(listType, indent, style)
−
local isDeprecated = false -- Tracks deprecated parameters.
+
local styles = {}
−
for k, v in pairs(args) do
+
if listType == 'horizontal' then
−
k = tostring(k)
+
indent = indent and tonumber(indent)
−
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
+
indent = tostring((indent and indent * 1.6) or 0)
−
isDeprecated = true
+
table.insert(styles, 'margin-left: ' .. indent .. 'em;')
−
break
+
−
end
+
 
end
 
end
−
local ret = ''
+
table.insert(styles, style)
−
if isDeprecated then
+
if #styles == 0 then
−
ret = ret .. '[[Category:List templates with deprecated parameters]]'
+
return nil
 
end
 
end
−
return ret
+
return mw.ustring.format(' style="%s"', table.concat(styles, ' '))
 
end
 
end
  
 
function p.makeList(listType, args)
 
function p.makeList(listType, args)
−
if not listType or not listTypes[listType] then
+
-- This is the main function to be called from other Lua modules.
−
error(string.format(
+
-- First, get the list items.
−
"bad argument #1 to 'makeList' ('%s' is not a valid list type)",
+
local listItems = {}
−
tostring(listType)
+
local argNums = getArgNums(args)
−
), 2)
+
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)]
 +
)
 +
table.insert(listItems, item)
 
end
 
end
−
checkType('makeList', 2, args, 'table')
+
if #listItems == 0 then
−
local data = p.makeListData(listType, args)
+
return ''
−
local list = p.renderList(data)
+
end
−
local trackingCategories = p.renderTrackingCategories(args)
+
-- Check if we need a ul tag or an ol tag.
−
return list .. trackingCategories
+
local listTag = 'ul'
 +
if listType == 'numbered' then
 +
listTag = 'ol'
 +
end
 +
-- Get the classes and styles and output the list.
 +
local class = getClass(listType, args.class) or ''
 +
local style = getStyle(listType, args.indent, args.style) or ''
 +
local list_style = args.list_style or args.ul_style -- ul_style is included for backwards compatibility, and will work even with ordered lists.
 +
list_style = list_style and (' style="' .. list_style .. '"') or ''
 +
return mw.ustring.format(
 +
'<div%s%s><%s%s>%s</%s></div>',
 +
class, style, listTag, list_style, table.concat(listItems), listTag
 +
)
 
end
 
end
  
−
for listType in pairs(listTypes) do
+
local function makeWrapper(listType)
−
p[listType] = function (frame)
+
return function(frame)
−
local mArguments = require('Module:Arguments')
+
local origArgs
−
local origArgs = mArguments.getArgs(frame)
+
if frame == mw.getCurrentFrame() then
−
-- Copy all the arguments to a new table, for faster indexing.
+
origArgs = frame:getParent().args
 +
for k, v in pairs(frame.args) do
 +
origArgs = frame.args
 +
break
 +
end
 +
else
 +
origArgs = frame
 +
end
 +
 
local args = {}
 
local args = {}
 
for k, v in pairs(origArgs) do
 
for k, v in pairs(origArgs) do
−
args[k] = v
+
if type(k) == 'number' or v ~= '' then
 +
args[k] = v
 +
end
 
end
 
end
 
return p.makeList(listType, args)
 
return p.makeList(listType, args)
 
end
 
end
 +
end
 +
 +
local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'numbered'}
 +
 +
for _, funcName in ipairs(funcNames) do
 +
p[funcName] = makeWrapper(funcName)
 
end
 
end
  
 
return p
 
return p

Revision as of 11:41, 13 November 2013

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

Script error: Lua error: Internal error: Error reading from pipe. 

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

local p = {}

local function getListItem(data, style, itemStyle)
	if not data then
		return nil
	end
	if style or itemStyle then
		style = style or ''
		itemStyle = itemStyle or ''
		return mw.ustring.format(
			'<li style="%s%s">%s</li>',
			style, itemStyle, data
		)
	else
		return mw.ustring.format(
			'<li>%s</li>',
			data
		)
	end
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

local function getClass(listType, class)
	local classes = {}
	if listType == 'horizontal' then
		table.insert(classes, 'hlist')
	elseif listType == 'unbulleted' then
		table.insert(classes, 'plainlist')
	end
	table.insert(classes, class)
	local ret
	if #classes == 0 then
		return nil
	end
	return mw.ustring.format(' class="%s"', table.concat(classes, ' '))
end

local function getStyle(listType, indent, style)
	local styles = {}
	if listType == 'horizontal' then
		indent = indent and tonumber(indent)
		indent = tostring((indent and indent * 1.6) or 0)
		table.insert(styles, 'margin-left: ' .. indent .. 'em;')
	end
	table.insert(styles, style)
	if #styles == 0 then
		return nil
	end
	return mw.ustring.format(' style="%s"', table.concat(styles, ' '))
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)]
		)
		table.insert(listItems, item)
	end
	if #listItems == 0 then
		return ''
	end
	-- Check if we need a ul tag or an ol tag.
	local listTag = 'ul'
	if listType == 'numbered' then
		listTag = 'ol'
	end
	-- Get the classes and styles and output the list.
	local class = getClass(listType, args.class) or ''
	local style = getStyle(listType, args.indent, args.style) or ''
	local list_style = args.list_style or args.ul_style -- ul_style is included for backwards compatibility, and will work even with ordered lists.
	list_style = list_style and (' style="' .. list_style .. '"') or ''
	return mw.ustring.format(
		'<div%s%s><%s%s>%s</%s></div>',
		class, style, listTag, list_style, table.concat(listItems), listTag
	)
end

local function makeWrapper(listType)
	return function(frame)
		local origArgs
		if frame == mw.getCurrentFrame() then
			origArgs = frame:getParent().args
			for k, v in pairs(frame.args) do
				origArgs = frame.args
				break
			end
		else
			origArgs = frame
		end
		
		local args = {}
		for k, v in pairs(origArgs) do
			if type(k) == 'number' or v ~= '' then
				args[k] = v
			end
		end
		return p.makeList(listType, args)
	end
end

local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'numbered'}

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

return p
Retrieved from "https://wiki.besa.de/index.php?title=Module:List&oldid=1910"