Difference between revisions of "Module:List/sandbox"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (create a p.makeListData function to finish splitting out the data processing from the rendering) |
m (29 revisions imported) |
||
| (20 intermediate revisions by 6 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, 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 | + | local listTypes = { |
| − | + | ['bulleted'] = true, | |
| − | + | ['unbulleted'] = true, | |
| − | + | ['horizontal'] = true, | |
| − | + | ['ordered'] = true, | |
| − | + | ['horizontal_ordered'] = true | |
| − | + | } | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
function p.makeListData(listType, args) | function p.makeListData(listType, args) | ||
| Line 27: | Line 23: | ||
data.classes = {} | data.classes = {} | ||
if listType == 'horizontal' or listType == 'horizontal_ordered' then | if listType == 'horizontal' or listType == 'horizontal_ordered' then | ||
| − | table.insert(data.classes, 'hlist') | + | table.insert(data.classes, 'hlist hlist-separated') |
elseif listType == 'unbulleted' then | elseif listType == 'unbulleted' then | ||
table.insert(data.classes, 'plainlist') | table.insert(data.classes, 'plainlist') | ||
| Line 39: | Line 35: | ||
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 = indent and indent * 1.6 or 0 |
| − | data.marginLeft = indent .. 'em' | + | if indent > 0 then |
| + | data.marginLeft = indent .. 'em' | ||
| + | end | ||
end | end | ||
| Line 55: | Line 53: | ||
if data.type | if data.type | ||
and not data.listStyleType | and not data.listStyleType | ||
| − | and not data.type:find('^%s*[1AaIi]%s*$') | + | and not tostring(data.type):find('^%s*[1AaIi]%s*$') |
then | then | ||
data.listStyleType = data.type | data.listStyleType = data.type | ||
| Line 82: | Line 80: | ||
-- ul_style and ol_style are included for backwards compatibility. No | -- ul_style and ol_style are included for backwards compatibility. No | ||
-- distinction is made for ordered or unordered lists. | -- distinction is made for ordered or unordered lists. | ||
| − | data.listStyle = args.list_style | + | data.listStyle = args.list_style |
-- List items | -- List items | ||
| Line 89: | Line 87: | ||
data.itemStyle = args.item_style or args.li_style | data.itemStyle = args.item_style or args.li_style | ||
data.items = {} | data.items = {} | ||
| − | for i, num in ipairs( | + | for i, num in ipairs(mTableTools.numKeys(args)) do |
local item = {} | local item = {} | ||
item.content = args[num] | item.content = args[num] | ||
| − | item.style = args[' | + | item.style = args['item' .. tostring(num) .. '_style'] |
| − | or args[' | + | or args['item_style' .. tostring(num)] |
| − | item.value = args['item_value' .. tostring(num)] | + | item.value = args['item' .. tostring(num) .. '_value'] |
| + | or args['item_value' .. tostring(num)] | ||
table.insert(data.items, item) | table.insert(data.items, item) | ||
end | end | ||
| Line 114: | Line 113: | ||
root:addClass(class) | root:addClass(class) | ||
end | end | ||
| − | + | root:css{['margin-left'] = data.marginLeft} | |
| − | |||
| − | |||
if data.style then | if data.style then | ||
root:cssText(data.style) | root:cssText(data.style) | ||
| Line 123: | Line 120: | ||
-- Render the list tag. | -- Render the list tag. | ||
local list = root:tag(data.listTag or 'ul') | 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 | if data.listStyle then | ||
list:cssText(data.listStyle) | list:cssText(data.listStyle) | ||
| Line 148: | Line 139: | ||
item:cssText(t.style) | item:cssText(t.style) | ||
end | end | ||
| − | + | item | |
| − | + | :attr{value = t.value} | |
| − | + | :wikitext(t.content) | |
| − | |||
end | end | ||
return tostring(root) | 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 | end | ||
function p.makeList(listType, args) | 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 data = p.makeListData(listType, args) | ||
| − | + | local list = p.renderList(data) | |
| + | local trackingCategories = p.renderTrackingCategories(args) | ||
| + | return list .. trackingCategories | ||
end | end | ||
| − | + | for listType in pairs(listTypes) do | |
| − | + | p[listType] = function (frame) | |
local mArguments = require('Module:Arguments') | local mArguments = require('Module:Arguments') | ||
| − | local | + | local origArgs = mArguments.getArgs(frame, { |
valueFunc = function (key, value) | valueFunc = function (key, value) | ||
| − | if | + | if not value or not mw.ustring.find(value, '%S') then return nil end |
| + | if mw.ustring.find(value, '^%s*[%*#;:]') or mw.ustring.find(value, '^%s*{|') then | ||
return value | return value | ||
| + | else | ||
| + | return mw.text.trim(value) | ||
end | end | ||
end | 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 | end | ||
return p | return p | ||
Latest revision as of 06:18, 27 September 2020
Documentation for this module may be created at Module:List/sandbox/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*[%*#;:]') or mw.ustring.find(value, '^%s*{|') then
return value
else
return mw.text.trim(value)
end
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