Editing Module:List

Jump to navigation Jump to search
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then publish the changes below to finish undoing the edit.

Latest revision Your text
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,
-- unbulleted, horizontal, ordered, and horizontal ordered lists are supported.
-- horizontal, numbered, and horizontal numbered 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 = {}
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
end
if style or itemStyle then
-- List style types for ordered lists
style = style or ''
-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
itemStyle = itemStyle or ''
-- type is either set by the "type" attribute or the "list-style-type" CSS
return mw.ustring.format(
-- property.
'<li style="%s%s">%s</li>',
if listType == 'ordered' or listType == 'horizontal_ordered' then
style, itemStyle, data
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)
-- List style
return nums
-- 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.renderList(data)
local function getClass(listType, class)
-- Renders the list HTML.
local classes = {}
if listType == 'horizontal' or listType == 'horizontal_numbered' then
-- Return the blank string if there are no list items.
table.insert(classes, 'hlist')
if type(data.items) ~= 'table' or #data.items < 1 then
elseif listType == 'unbulleted' then
return ''
table.insert(classes, 'plainlist')
end
end
table.insert(classes, class)
-- Render the main div tag.
local ret
local root = mw.html.create('div')
if #classes == 0 then
for i, class in ipairs(data.classes or {}) do
return nil
root:addClass(class)
end
root:css{['margin-left'] = data.marginLeft}
if data.style then
root:cssText(data.style)
end
end
return mw.ustring.format(' class="%s"', table.concat(classes, ' '))
end


-- Render the list tag.
local function getStyle(listType, indent, style)
local list = root:tag(data.listTag or 'ul')
local styles = {}
list
if listType == 'horizontal' then
:attr{start = data.start, type = data.type}
indent = indent and tonumber(indent)
:css{
indent = tostring((indent and indent * 1.6) or 0)
['counter-reset'] = data.counterReset,
table.insert(styles, 'margin-left: ' .. indent .. 'em;')
['list-style-type'] = data.listStyleType
}
if data.listStyle then
list:cssText(data.listStyle)
end
end
 
table.insert(styles, style)
-- Render the list items
if #styles == 0 then
for i, t in ipairs(data.items or {}) do
return nil
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
end
 
return mw.ustring.format(' style="%s"', table.concat(styles, ' '))
return data.templatestyles .. tostring(root)
end
end


function p.renderTrackingCategories(args)
function p.makeList(listType, args)
local isDeprecated = false -- Tracks deprecated parameters.
-- This is the main function to be called from other Lua modules.
for k, v in pairs(args) do
-- First, get the list items.
k = tostring(k)
local listItems = {}
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
local argNums = getArgNums(args)
isDeprecated = true
for i, num in ipairs(argNums) do
break
local item = getListItem(
end
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)]
)
table.insert(listItems, item)
end
end
local ret = ''
if #listItems == 0 then
if isDeprecated then
return ''
ret = ret .. '[[Category:List templates with deprecated parameters]]'
end
end
return ret
-- Check if we need a ul tag or an ol tag, and get the start and type attributes for ordered lists.
end
local listTag = 'ul'
 
local startAttr, typeAttr
function p.makeList(listType, args)
if listType == 'numbered' or listType == 'horizontal_numbered' then
if not listType or not listTypes[listType] then
listTag = 'ol'
error(string.format(
startAttr = args.start
"bad argument #1 to 'makeList' ('%s' is not a valid list type)",
if startAttr then
tostring(listType)
startAttr = ' start="' .. startAttr .. '"'
), 2)
end
typeAttr = args.type
if typeAttr then
typeAttr = ' type="' .. typeAttr .. '"'
end
end
end
checkType('makeList', 2, args, 'table')
startAttr = startAttr or ''
local data = p.makeListData(listType, args)
typeAttr = typeAttr or ''
local list = p.renderList(data)
-- Get the classes and styles and output the list.
local trackingCategories = p.renderTrackingCategories(args)
local class = getClass(listType, args.class) or ''
return list .. trackingCategories
local style = getStyle(listType, args.indent, args.style) or ''
local list_style = args.list_style or args.ul_style -- ul_style is included for backwards compatibility, and will work even with ordered 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


for listType in pairs(listTypes) do
local function makeWrapper(listType)
p[listType] = function (frame)
return function(frame)
local mArguments = require('Module:Arguments')
local origArgs
local origArgs = mArguments.getArgs(frame, {
if frame == mw.getCurrentFrame() then
valueFunc = function (key, value)
origArgs = frame:getParent().args
if not value or not mw.ustring.find(value, '%S') then return nil end
for k, v in pairs(frame.args) do
if mw.ustring.find(value, '^%s*[%*#;:]') then
origArgs = frame.args
return value
break
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', 'numbered', 'horizontal_numbered'}
for _, funcName in ipairs(funcNames) do
p[funcName] = makeWrapper(funcName)
end
end


return p
return p
Please note that all contributions to Meta Wiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see Meta Wiki:Copyrights for details). Do not submit copyrighted work without permission!
Cancel Editing help (opens in new window)

Template used on this page:

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