Module:List - Revision history

Abinash: 26 revisions

2016-04-08T12:23:08Z

26 revisions

Abinash: 1 revision

2016-04-08T11:49:56Z

1 revision

Mr. Stradivarius: 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

2014-06-12T09:21:46Z

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

New page

-- 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.renderTrackingCategories(args)
local isDeprecated = false -- Tracks deprecated parameters.
for k, v in pairs(args) do
k = tostring(k)
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
isDeprecated = true
break
end
end
local ret = ''
if isDeprecated then
ret = ret .. '[[Category:List templates with deprecated parameters]]'
end
return ret
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)
local list = p.renderList(data)
local trackingCategories = p.renderTrackingCategories(args)
return list .. trackingCategories
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

Mr. Stradivarius: don't mark item_stylen parameters as deprecated yet - needs to be saved for the next stage of conversion

2014-06-11T12:19:07Z

don't mark item_stylen parameters as deprecated yet - needs to be saved for the next stage of conversion

Mr. Stradivarius: Changed protection level of Module:List: High-risk Lua module: used by Template:Unbulleted list ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

2014-05-26T01:22:22Z

Changed protection level of Module:List: High-risk Lua module: used by Template:Unbulleted list ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

Mr. Stradivarius: split the HTML rendering code out into a separate function, add a tracking category for deprecated parameters, ignore blank/whitespace arguments, and replace getArgNums with the equivalent function in Module:TableTools

2014-05-26T01:15:39Z

split the HTML rendering code out into a separate function, add a tracking category for deprecated parameters, ignore blank/whitespace arguments, and replace getArgNums with the equivalent function in Module:TableTools

Show changes

Mr. Stradivarius: add fix to make the start parameter work with horizontal ordered lists, and switch to Module:Arguments for argument processing

2014-01-07T03:15:57Z

add fix to make the start parameter work with horizontal ordered lists, and switch to Module:Arguments for argument processing

Mr. Stradivarius: Protected Module:List: High-risk Lua module: ~1,100 transclusions ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite))

2014-01-07T02:14:58Z

Protected Module:List: High-risk Lua module: ~1,100 transclusions ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite))

Mr. Stradivarius: only use type and list_style_type with ordered and horizontal ordered lists

2013-11-24T15:00:23Z

only use type and list_style_type with ordered and horizontal ordered lists

Mr. Stradivarius: fix ordered lists - had a stupid variable clash

2013-11-24T13:24:27Z

fix ordered lists - had a stupid variable clash

@@ Line 4: / Line 4: @@
 local p = {}
 local htmlBuilder = require('Module:HtmlBuilder')
@@ Line 22: / Line 23: @@
 local function getArgNums(args)
-	-- Returns an array containing the keys of all positional arguments
+	-- Returns an array containing the keys of all positional arguments that contain data (i.e. non-whitespace values).
-	-- that contain data (i.e. non-whitespace values).
 	local nums = {}
 	for k, v in pairs(args) do
@@ Line 84: / Line 84: @@
 	-- Build the list tags and list items.
 	local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
 	list
 		.attr('type', typeAttr)
 		.css('list-style-type', listStyleType)
@@ Line 95: / Line 104: @@
 local function makeWrapper(listType)
 	return function(frame)
-		local origArgs
+		local args = getArgs(frame, {
-		if frame == mw.getCurrentFrame() then
+			valueFunc = function (key, value)
-			origArgs = frame:getParent().args
+				if type(key) == 'number' or value ~= '' then
-			for k, v in pairs(frame.args) do
+					return value
-				origArgs = frame.args
+				end
-				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

@@ Line 54: / Line 54: @@
 		return ''
 	end
-	-- Build the list html.
+	-- Build the opening div tag.
 	local root = htmlBuilder.create('div')
 	if listType == 'horizontal' or listType == 'horizontal_ordered' then
@@ Line 66: / Line 66: @@
 		indent = tostring((indent and indent * 1.6) or 0)
 		root.css('margin-left', indent .. 'em')
 	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
@@ Line 77: / Line 82: @@
 	end
 	root.cssText(args.style)
 	local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
 	list

@@ Line 69: / Line 69: @@
 	-- 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.
 	local listStyleType = args.list_style_type or args['list-style-type']
-	local listType = args['type']
+	local typeAttr = args['type']
-	if listType and not listType:match('^%s*[1AaIi]%s*$') then
+	if typeAttr and not typeAttr:match('^%s*[1AaIi]%s*$') then
 		if not listStyleType then
-			listStyleType = listType
+			listStyleType = typeAttr
-			listType = nil
+			typeAttr = nil
 		end
 	end
@@ Line 80: / Line 80: @@
 	list
 		.attr('start', args.start)
-		.attr('type', listType)
+		.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.

@@ Line 80: / Line 80: @@
 	 -- ul_style and ol_style are included for backwards compatibility. No
 	 -- distinction is made for ordered or unordered lists.
-	data.listStyle = args.list_style or args.ul_style or args.ol_style
+	data.listStyle = args.list_style
 	-- List items
@@ Line 90: / Line 90: @@
 		local item = {}
 		item.content = args[num]
-		item.style = args['item_style' .. tostring(num)]
+		item.style = args['item' .. tostring(num) .. '_style']
-			or args['li_style' .. tostring(num)]
+			or args['item_style' .. tostring(num)]
-		item.value = args['item_value' .. tostring(num)]
+		item.value = args['item' .. tostring(num) .. '_value']
 		table.insert(data.items, item)
 	end
@@ Line 148: / Line 149: @@
 function p.renderTrackingCategories(args)
 	local isDeprecated = false -- Tracks deprecated parameters.
-	for i, param in ipairs{'ul_style', 'ol_style', 'li_style'} do
+	for k, v in pairs(args) do
-		if args[param] then
+		k = tostring(k)
 			isDeprecated = true
 			break
 		end
 	end

← Older revision	Revision as of 11:49, 8 April 2016
(No difference)

← Older revision	Revision as of 01:22, 26 May 2014
(No difference)

← Older revision	Revision as of 02:14, 7 January 2014
(No difference)