Module:List: Difference between revisions

Jump to navigation Jump to search
← Older edit
m>Mr. Stradivarius
add fix to make the start parameter work with horizontal ordered lists, and switch to Module:Arguments for argument processing
MeowyCats2 (talk | contribs)
Bureaucrats, Interface administrators, Stewards, Administrators
38 edits
m 43 revisions imported
 
(22 intermediate revisions by 18 users not shown)
Line 1: Line 1:
-- This module outputs different kinds of lists. At the moment, bulleted, unbulleted,
-- This module outputs different kinds of lists. At the moment, bulleted,
-- horizontal, ordered, and horizontal ordered 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 getArgs = require('Module:Arguments').getArgs
local listTypes = {
local htmlBuilder = require('Module:HtmlBuilder')
['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 = {}
data.templatestyles = ''
if listType == 'horizontal' or listType == 'horizontal_ordered' then
table.insert(data.classes, 'hlist')
data.templatestyles = mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = 'Template:Flatlist/styles.css' }
}
elseif listType == 'unbulleted' then
table.insert(data.classes, 'plainlist')
data.templatestyles = mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = 'Template:Plainlist/styles.css' }
}
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']


local function getListItem(data, style, itemStyle, itemValue)
-- Detect invalid type attributes and attempt to convert them to
if not data then
-- list-style-type CSS properties.
return c
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
local item = htmlBuilder.create('li')
item
-- List tag type
.cssText(style)
if listType == 'ordered' or listType == 'horizontal_ordered' then
.cssText(itemStyle)
data.listTag = 'ol'
.wikitext(data)
else
if(itemValue) then
data.listTag = 'ul'
item.attr('value',itemValue)
end
end
return tostring(item)
end


local function getArgNums(args)
-- Start number for ordered lists
-- Returns an array containing the keys of all positional arguments that contain data (i.e. non-whitespace values).
data.start = args.start
local nums = {}
if listType == 'horizontal_ordered' then
for k, v in pairs(args) do
-- Apply fix to get start numbers working with horizontal ordered lists.
if type(k) == 'number' and
local startNum = tonumber(data.start)
k >= 1 and
if startNum then
math.floor(k) == k and
data.counterReset = 'listitem ' .. tostring(startNum - 1)
mw.ustring.match(v, '%S') then
table.insert(nums, k)
end
end
end
end
table.sort(nums)
 
return nums
-- 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
end


function p.makeList(listType, args)
function p.renderList(data)
-- This is the main function to be called from other Lua modules.
-- Renders the list HTML.
-- First, get the list items.
local listItems = {}
-- Return the blank string if there are no list items.
local argNums = getArgNums(args)
if type(data.items) ~= 'table' or #data.items < 1 then
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 ''
return ''
end
end
-- Build the opening div tag.
local root = htmlBuilder.create('div')
-- Render the main div tag.
if listType == 'horizontal' or listType == 'horizontal_ordered' then
local root = mw.html.create('div')
root.addClass('hlist')
for i, class in ipairs(data.classes or {}) do
elseif listType == 'unbulleted' then
root:addClass(class)
root.addClass('plainlist')
end
end
root.addClass(args.class)
root:css{['margin-left'] = data.marginLeft}
if listType == 'horizontal' or listType == 'horizontal_ordered' then
if data.style then
local indent = tonumber(args.indent)
root:cssText(data.style)
indent = tostring((indent and indent * 1.6) or 0)
root.css('margin-left', indent .. 'em')
end
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.
-- Render the list tag.
local listStyleType, typeAttr
local list = root:tag(data.listTag or 'ul')
if listType == 'ordered' or listType == 'horizontal_ordered' then
list
listStyleType = args.list_style_type or args['list-style-type']
:attr{start = data.start, type = data.type}
typeAttr = args['type']
:css{
['counter-reset'] = data.counterReset,
['list-style-type'] = data.listStyleType
}
if data.listStyle then
list:cssText(data.listStyle)
end
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
-- Render the list items
if not listStyleType then
for i, t in ipairs(data.items or {}) do
listStyleType = typeAttr
local item = list:tag('li')
typeAttr = nil
if data.itemStyle then
item:cssText(data.itemStyle)
end
end
if t.style then
item:cssText(t.style)
end
item
:attr{value = t.value}
:wikitext(t.content)
end
end
root.cssText(args.style)
 
-- Build the list tags and list items.
return data.templatestyles .. tostring(root)
local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
end
local start = args.start
 
list
function p.renderTrackingCategories(args)
.attr('start', start)
local isDeprecated = false -- Tracks deprecated parameters.
if listType == 'horizontal_ordered' then
for k, v in pairs(args) do
-- Apply fix to get start numbers working with horizontal ordered lists.
k = tostring(k)
local startNum = tonumber(start)
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
if startNum then
isDeprecated = true
list.css('counter-reset', 'listitem ' .. tostring(startNum - 1))
break
end
end
end
end
list
local ret = ''
.attr('type', typeAttr)
if isDeprecated then
.css('list-style-type', listStyleType)
ret = ret .. '[[Category:List templates with deprecated parameters]]'
.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.
end
.wikitext(table.concat(listItems))
return ret
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)
local list = p.renderList(data)
local trackingCategories = p.renderTrackingCategories(args)
return list .. trackingCategories
end
end


local function makeWrapper(listType)
for listType in pairs(listTypes) do
return function(frame)
p[listType] = function (frame)
local args = getArgs(frame, {
local mArguments = require('Module:Arguments')
local origArgs = mArguments.getArgs(frame, {
valueFunc = function (key, value)
valueFunc = function (key, value)
if type(key) == 'number' or value ~= '' then
if not value or not mw.ustring.find(value, '%S') then return nil end
return value
if mw.ustring.find(value, '^%s*[%*#;:]') then
end
return value
else
return value:match('^%s*(.-)%s*$')
end
end
return nil
end
})
})
-- 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)
return p.makeList(listType, args)
end
end
end
local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'ordered', 'horizontal_ordered'}
for _, funcName in ipairs(funcNames) do
p[funcName] = makeWrapper(funcName)
end
end


return p
return p
Retrieved from "https://meta.skywiki.org/wiki/Module:List"