Actions

Module

Editing List

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 save 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, 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 htmlBuilder = require('Module:HtmlBuilder')
['bulleted'] = true,
 
['unbulleted'] = true,
 
['horizontal'] = true,
 
['ordered'] = true,
 
['horizontal_ordered'] = true
 
}
 
  
function p.makeListData(listType, args)
+
local function getListItem(data, style, itemStyle, itemValue)
-- Constructs a data table to be passed to p.renderList.
+
if not data then
local data = {}
+
return nil
 
 
-- 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)
+
local item = htmlBuilder.create('li')
 
+
item
-- Main div style
+
.cssText(style)
data.style = args.style
+
.cssText(itemStyle)
 
+
.wikitext(data)
-- Indent for horizontal lists
+
if(itemValue) then
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
item.attr('value',itemValue)
local indent = tonumber(args.indent)
 
indent = indent and indent * 1.6 or 0
 
if indent > 0 then
 
data.marginLeft = indent .. 'em'
 
end
 
 
end
 
end
+
return tostring(item)
-- List style types for ordered lists
+
end
-- 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
+
local function getArgNums(args)
-- list-style-type CSS properties.
+
-- Returns an array containing the keys of all positional arguments
if data.type  
+
-- that contain data (i.e. non-whitespace values).
and not data.listStyleType
+
local nums = {}
and not tostring(data.type):find('^%s*[1AaIi]%s*$')
+
for k, v in pairs(args) do
then
+
if type(k) == 'number' and
data.listStyleType = data.type
+
k >= 1 and  
data.type = nil
+
math.floor(k) == k and
 +
mw.ustring.match(v, '%S') then
 +
table.insert(nums, k)
 
end
 
end
 
end
 
end
+
table.sort(nums)
-- List tag type
+
return nums
if listType == 'ordered' or listType == 'horizontal_ordered' then
+
end
data.listTag = 'ol'
 
else
 
data.listTag = 'ul'
 
end
 
  
-- Start number for ordered lists
+
function p.makeList(listType, args)
data.start = args.start
+
-- This is the main function to be called from other Lua modules.
if listType == 'horizontal_ordered' then
+
-- First, get the list items.
-- Apply fix to get start numbers working with horizontal ordered lists.
+
local listItems = {}
local startNum = tonumber(data.start)
+
local argNums = getArgNums(args)
if startNum then
+
for i, num in ipairs(argNums) do
data.counterReset = 'listitem ' .. tostring(startNum - 1)
+
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)],
 +
args['item_value' .. tostring(num)]
 +
)
 +
table.insert(listItems, item)
 
end
 
end
 
+
if #listItems == 0 then
-- 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 ''
 
return ''
 
end
 
end
+
-- Build the list html.
-- Render the main div tag.
+
local root = htmlBuilder.create('div')
local root = mw.html.create('div')
+
if listType == 'horizontal' or listType == 'horizontal_ordered' then
for i, class in ipairs(data.classes or {}) do
+
root.addClass('hlist')
root:addClass(class)
+
elseif listType == 'unbulleted' then
 +
root.addClass('plainlist')
 
end
 
end
root:css{['margin-left'] = data.marginLeft}
+
root.addClass(args.class)
if data.style then
+
if listType == 'horizontal' or listType == 'horizontal_ordered' then
root:cssText(data.style)
+
local indent = tonumber(args.indent)
 +
indent = tostring((indent and indent * 1.6) or 0)
 +
root.css('margin-left', indent .. 'em')
 
end
 
end
 
+
root.cssText(args.style)
-- Render the list tag.
+
local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
local list = root:tag(data.listTag or 'ul')
 
 
list
 
list
:attr{start = data.start, type = data.type}
+
.attr('start', args.start)
:css{
+
.attr('type', args.type)
['counter-reset'] = data.counterReset,
+
.css('list-style-type', args.list_style_type or args['list-style-type'])
['list-style-type'] = data.listStyleType
+
.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.
}
+
.wikitext(table.concat(listItems))
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)
 
return tostring(root)
 
end
 
end
  
function p.renderTrackingCategories(args)
+
local function makeWrapper(listType)
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
 +
break
 +
end
 +
else
 +
origArgs = frame
 
end
 
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)
 
-- 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
  
 
return p
 
return p

Please note that all contributions to Unofficial Stationeers 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 Unofficial Stationeers Wiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)