Difference between revisions of "Module:List/sandbox"
Jump to navigation
Jump to search
blackwiki>Mr. Stradivarius (return the blank string if there are no list items) |
blackwiki>Mr. Stradivarius (create a p.makeListData function to finish splitting out the data processing from the rendering) |
||
| 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 p = {} | local p = {} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
local function getArgNums(args) | local function getArgNums(args) | ||
| − | -- Returns an array containing the keys of all positional arguments that contain data (i.e. non-whitespace values). | + | -- Returns an array containing the keys of all positional arguments that |
| + | -- contain data (i.e. non-whitespace values). | ||
local nums = {} | local nums = {} | ||
for k, v in pairs(args) do | for k, v in pairs(args) do | ||
| Line 37: | Line 20: | ||
end | end | ||
| − | function p. | + | function p.makeListData(listType, args) |
| − | -- | + | -- Constructs a data table to be passed to p.renderList. |
| − | + | local data = {} | |
| − | local | + | |
| − | + | -- Classes | |
| − | + | data.classes = {} | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
if listType == 'horizontal' or listType == 'horizontal_ordered' then | if listType == 'horizontal' or listType == 'horizontal_ordered' then | ||
| − | + | table.insert(data.classes, 'hlist') | |
elseif listType == 'unbulleted' then | elseif listType == 'unbulleted' then | ||
| − | + | table.insert(data.classes, 'plainlist') | |
end | 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 | if listType == 'horizontal' or listType == 'horizontal_ordered' then | ||
local indent = tonumber(args.indent) | local indent = tonumber(args.indent) | ||
indent = tostring((indent and indent * 1.6) or 0) | indent = tostring((indent and indent * 1.6) or 0) | ||
| − | + | 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 | if listType == 'ordered' or listType == 'horizontal_ordered' then | ||
| − | listStyleType = args.list_style_type or args['list-style-type'] | + | 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 data.type:find('^%s*[1AaIi]%s*$') | ||
| + | then | ||
| + | data.listStyleType = data.type | ||
| + | data.type = nil | ||
| + | end | ||
end | end | ||
| − | -- | + | |
| − | if | + | -- List tag type |
| − | + | if listType == 'ordered' or listType == 'horizontal_ordered' then | |
| − | + | data.listTag = 'ol' | |
| − | + | else | |
| − | + | data.listTag = 'ul' | |
end | end | ||
| − | + | ||
| − | -- | + | -- Start number for ordered lists |
| − | + | data.start = args.start | |
| − | |||
| − | |||
| − | |||
if listType == 'horizontal_ordered' then | if listType == 'horizontal_ordered' then | ||
-- Apply fix to get start numbers working with horizontal ordered lists. | -- Apply fix to get start numbers working with horizontal ordered lists. | ||
| − | local startNum = tonumber(start) | + | local startNum = tonumber(data.start) |
if startNum then | if startNum then | ||
| − | + | data.counterReset = 'listitem ' .. tostring(startNum - 1) | |
end | end | ||
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 or args.ul_style or args.ol_style |
| − | return | + | |
| + | -- 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(getArgNums(args)) do | ||
| + | local item = {} | ||
| + | item.content = args[num] | ||
| + | item.style = args['item_style' .. tostring(num)] | ||
| + | or args['li_style' .. tostring(num)] | ||
| + | item.value = args['item_value' .. tostring(num)] | ||
| + | table.insert(data.items, item) | ||
| + | end | ||
| + | |||
| + | return data | ||
end | end | ||
| Line 106: | Line 105: | ||
-- Return the blank string if there are no list items. | -- Return the blank string if there are no list items. | ||
| − | if | + | if type(data.items) ~= 'table' or #data.items < 1 then |
return '' | return '' | ||
end | end | ||
| Line 156: | Line 155: | ||
return tostring(root) | return tostring(root) | ||
| + | end | ||
| + | |||
| + | function p.makeList(listType, args) | ||
| + | local data = p.makeListData(listType, args) | ||
| + | return p.renderList(data) | ||
end | end | ||
local function makeWrapper(listType) | local function makeWrapper(listType) | ||
return function(frame) | return function(frame) | ||
| − | local args = getArgs(frame, { | + | local mArguments = require('Module:Arguments') |
| + | local args = mArguments.getArgs(frame, { | ||
valueFunc = function (key, value) | valueFunc = function (key, value) | ||
if type(key) == 'number' or value ~= '' then | if type(key) == 'number' or value ~= '' then | ||
| Line 171: | Line 176: | ||
end | end | ||
| − | local funcNames = {'bulleted', 'unbulleted', 'horizontal', 'ordered', 'horizontal_ordered'} | + | local funcNames = { |
| + | 'bulleted', | ||
| + | 'unbulleted', | ||
| + | 'horizontal', | ||
| + | 'ordered', | ||
| + | 'horizontal_ordered' | ||
| + | } | ||
for _, funcName in ipairs(funcNames) do | for _, funcName in ipairs(funcNames) do | ||
Revision as of 12:37, 19 May 2014
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 p = {}
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
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 = tostring((indent and indent * 1.6) or 0)
data.marginLeft = indent .. 'em'
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 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 or args.ul_style or args.ol_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(getArgNums(args)) do
local item = {}
item.content = args[num]
item.style = args['item_style' .. tostring(num)]
or args['li_style' .. tostring(num)]
item.value = 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
if data.marginLeft then
root:css('margin-left', data.marginLeft)
end
if data.style then
root:cssText(data.style)
end
-- Render the list tag.
local list = root:tag(data.listTag or 'ul')
if data.start then
list:attr('start', data.start)
end
if data.type then
list:attr('type', data.type)
end
if data.counterReset then
list:css('counter-reset', data.counterReset)
end
if data.listStyleType then
list:css('list-style-type', data.listStyleType)
end
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
if t.value then
item:attr('value', t.value)
end
item:wikitext(t.content)
end
return tostring(root)
end
function p.makeList(listType, args)
local data = p.makeListData(listType, args)
return p.renderList(data)
end
local function makeWrapper(listType)
return function(frame)
local mArguments = require('Module:Arguments')
local args = mArguments.getArgs(frame, {
valueFunc = function (key, value)
if type(key) == 'number' or value ~= '' then
return value
end
end
})
return p.makeList(listType, args)
end
end
local funcNames = {
'bulleted',
'unbulleted',
'horizontal',
'ordered',
'horizontal_ordered'
}
for _, funcName in ipairs(funcNames) do
p[funcName] = makeWrapper(funcName)
end
return p