Module:List: Difference between revisions
From Mariopedia, a wiki on Mario, Yoshi, Wario, Donkey Kong, Super Smash Bros., and more!
Jump to navigationJump to search
Content deleted Content added
first attempt to add support for list-style-type, but broken for now |
m 34 revisions imported from wikipedia:Module:List |
||
(26 intermediate revisions by 7 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, |
||
-- 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 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 hlist-separated') |
|||
elseif listType == 'unbulleted' then |
|||
table.insert(data.classes, 'plainlist') |
|||
end |
end |
||
table.insert(data.classes, args.class) |
|||
if style or itemStyle then |
|||
style = style or '' |
|||
-- Main div style |
|||
itemStyle = itemStyle or '' |
|||
data.style = args.style |
|||
return mw.ustring.format( |
|||
'<li style="%s%s">%s</li>', |
|||
-- Indent for horizontal lists |
|||
style, itemStyle, data |
|||
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 |
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) |
|||
return nums |
|||
end |
|||
-- List style |
|||
local function getClass(listType, args) |
|||
-- ul_style and ol_style are included for backwards compatibility. No |
|||
local classes = {} |
|||
-- distinction is made for ordered or unordered lists. |
|||
if listType == 'horizontal' or listType == 'horizontal_ordered' then |
|||
data.listStyle = args.list_style |
|||
table.insert(classes, 'hlist') |
|||
elseif listType == 'unbulleted' then |
|||
-- List items |
|||
table.insert(classes, 'plainlist') |
|||
-- li_style is included for backwards compatibility. item_style was included |
|||
end |
|||
-- to be easier to understand for non-coders. |
|||
table.insert(classes, args.class) |
|||
data.itemStyle = args.item_style or args.li_style |
|||
local ret |
|||
data.items = {} |
|||
if #classes == 0 then |
|||
for i, num in ipairs(mTableTools.numKeys(args)) do |
|||
return nil |
|||
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 |
end |
||
return mw.ustring.format(' class="%s"', table.concat(classes, ' ')) |
|||
return data |
|||
end |
end |
||
function p.renderList(data) |
|||
-- Renders the list HTML. |
|||
local styles = {} |
|||
if listType == 'horizontal' or listType == 'horizontal_ordered' then |
|||
-- Return the blank string if there are no list items. |
|||
local indent = args.indent and tonumber(indent) |
|||
if type(data.items) ~= 'table' or #data.items < 1 then |
|||
indent = tostring((indent and indent * 1.6) or 0) |
|||
return '' |
|||
table.insert(styles, 'margin-left: ' .. indent .. 'em;') |
|||
end |
end |
||
local listStyleType = args['list-style-type'] |
|||
-- Render the main div tag. |
|||
if listStyleType then |
|||
local root = mw.html.create('div') |
|||
table.insert(styles, 'list-style-type: ' .. listStyleType .. ';') |
|||
for i, class in ipairs(data.classes or {}) do |
|||
root:addClass(class) |
|||
end |
end |
||
root:css{['margin-left'] = data.marginLeft} |
|||
table.insert(styles, args.style) |
|||
if |
if data.style then |
||
root:cssText(data.style) |
|||
return nil |
|||
end |
end |
||
return mw.ustring.format(' style="%s"', table.concat(styles, ' ')) |
|||
end |
|||
-- Render the list tag. |
|||
function p.makeList(listType, args) |
|||
local list = root:tag(data.listTag or 'ul') |
|||
-- This is the main function to be called from other Lua modules. |
|||
list |
|||
-- First, get the list items. |
|||
:attr{start = data.start, type = data.type} |
|||
local listItems = {} |
|||
:css{ |
|||
local argNums = getArgNums(args) |
|||
['counter-reset'] = data.counterReset, |
|||
for i, num in ipairs(argNums) do |
|||
['list-style-type'] = data.listStyleType |
|||
local item = getListItem( |
|||
} |
|||
args[num], |
|||
if data.listStyle then |
|||
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. |
|||
list:cssText(data.listStyle) |
|||
args['item_style' .. tostring(num)] or args['li_style' .. tostring(num)] |
|||
) |
|||
table.insert(listItems, item) |
|||
end |
end |
||
if #listItems == 0 then |
|||
-- Render the list items |
|||
return '' |
|||
for i, t in ipairs(data.items or {}) do |
|||
end |
|||
local item = list:tag('li') |
|||
-- Check if we need a ul tag or an ol tag, and get the start and type attributes for ordered lists. |
|||
if data.itemStyle then |
|||
local listTag = 'ul' |
|||
item:cssText(data.itemStyle) |
|||
local startAttr, typeAttr |
|||
if listType == 'ordered' or listType == 'horizontal_ordered' then |
|||
listTag = 'ol' |
|||
startAttr = args.start |
|||
if startAttr then |
|||
startAttr = ' start="' .. startAttr .. '"' |
|||
end |
end |
||
if t.style then |
|||
typeAttr = args.type |
|||
item:cssText(t.style) |
|||
if typeAttr then |
|||
typeAttr = ' type="' .. typeAttr .. '"' |
|||
end |
end |
||
item |
|||
:attr{value = t.value} |
|||
:wikitext(t.content) |
|||
end |
end |
||
startAttr = startAttr or '' |
|||
return tostring(root) |
|||
typeAttr = typeAttr or '' |
|||
-- Get the classes and styles and output the list. |
|||
local class = getClass(listType, args) or '' |
|||
local style = getStyle(listType, args) or '' |
|||
local list_style = 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 = list_style and (' style="' .. list_style .. '"') or '' |
|||
return mw.ustring.format( |
|||
'<div%s%s><%s%s%s%s>%s</%s></div>', |
|||
class, style, listTag, startAttr, typeAttr, list_style, table.concat(listItems), listTag |
|||
) |
|||
end |
end |
||
function p.renderTrackingCategories(args) |
|||
local isDeprecated = false -- Tracks deprecated parameters. |
|||
return function(frame) |
|||
for k, v in pairs(args) do |
|||
local origArgs |
|||
k = tostring(k) |
|||
if frame == mw.getCurrentFrame() then |
|||
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then |
|||
origArgs = frame:getParent().args |
|||
isDeprecated = true |
|||
for k, v in pairs(frame.args) do |
|||
break |
|||
origArgs = frame.args |
|||
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, { |
|||
valueFunc = function (key, value) |
|||
if not value or not mw.ustring.find(value, '%S') then return nil end |
|||
if mw.ustring.find(value, '^%s*[%*#;:]') then |
|||
return value |
|||
else |
|||
return value:match('^%s*(.-)%s*$') |
|||
end |
end |
||
return nil |
|||
else |
|||
origArgs = frame |
|||
end |
end |
||
}) |
|||
-- Copy all the arguments to a new table, for faster indexing. |
|||
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', 'ordered', 'horizontal_ordered'} |
|||
for _, funcName in ipairs(funcNames) do |
|||
p[funcName] = makeWrapper(funcName) |
|||
end |
end |
||
Latest revision as of 13:49, April 30, 2022
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 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 hlist-separated')
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, {
valueFunc = function (key, value)
if not value or not mw.ustring.find(value, '%S') then return nil end
if mw.ustring.find(value, '^%s*[%*#;:]') then
return value
else
return value:match('^%s*(.-)%s*$')
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)
end
end
return p