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 function getListItem(data, style, itemStyle)
−
['bulleted'] = true,
+
if not data then
−
['unbulleted'] = true,
+
return nil
−
['horizontal'] = true,
+
end
−
['ordered'] = true,
+
if style or itemStyle then
−
['horizontal_ordered'] = true
+
style = style or ''
−
}
+
itemStyle = itemStyle or ''
−
 
+
return mw.ustring.format(
−
function p.makeListData(listType, args)
+
'<li style="%s%s">%s</li>',
−
-- Constructs a data table to be passed to p.renderList.
+
style, itemStyle, data
−
local data = {}
+
)
−
 
+
else
−
-- Classes
+
return mw.ustring.format(
−
data.classes = {}
+
'<li>%s</li>',
−
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
data
−
table.insert(data.classes, 'hlist hlist-separated')
+
)
−
elseif listType == 'unbulleted' then
 
−
table.insert(data.classes, 'plainlist')
 
 
end
 
end
−
table.insert(data.classes, args.class)
+
end
  
−
-- Main div style
+
local function getArgNums(args)
−
data.style = args.style
+
-- Returns an array containing the keys of all positional arguments
−
 
+
-- that contain data (i.e. non-whitespace values).
−
-- Indent for horizontal lists
+
local nums = {}
−
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
for k, v in pairs(args) do
−
local indent = tonumber(args.indent)
+
if type(k) == 'number' and
−
indent = indent and indent * 1.6 or 0
+
k >= 1 and
−
if indent > 0 then
+
math.floor(k) == k and  
−
data.marginLeft = indent .. 'em'
+
mw.ustring.match(v, '%S') then
 +
table.insert(nums, k)
 
end
 
end
 
end
 
end
−
+
table.sort(nums)
−
-- List style types for ordered lists
+
return nums
−
-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
+
end
−
-- 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 getClass(listType, class)
−
-- list-style-type CSS properties.
+
local classes = {}
−
if data.type
+
if listType == 'horizontal' or listType == 'horizontal_ordered' then
−
and not data.listStyleType
+
table.insert(classes, 'hlist')
−
and not tostring(data.type):find('^%s*[1AaIi]%s*$')
+
elseif listType == 'unbulleted' then
−
then
+
table.insert(classes, 'plainlist')
−
data.listStyleType = data.type
 
−
data.type = nil
 
−
end
 
 
end
 
end
−
+
table.insert(classes, class)
−
-- List tag type
+
local ret
−
if listType == 'ordered' or listType == 'horizontal_ordered' then
+
if #classes == 0 then
−
data.listTag = 'ol'
+
return nil
−
else
 
−
data.listTag = 'ul'
 
 
end
 
end
 +
return mw.ustring.format(' class="%s"', table.concat(classes, ' '))
 +
end
  
−
-- Start number for ordered lists
+
local function getStyle(listType, indent, style)
−
data.start = args.start
+
local styles = {}
−
if listType == 'horizontal_ordered' then
+
if listType == 'horizontal' or listType == 'horizontal_ordered' then
−
-- Apply fix to get start numbers working with horizontal ordered lists.
+
indent = indent and tonumber(indent)
−
local startNum = tonumber(data.start)
+
indent = tostring((indent and indent * 1.6) or 0)
−
if startNum then
+
table.insert(styles, 'margin-left: ' .. indent .. 'em;')
−
data.counterReset = 'listitem ' .. tostring(startNum - 1)
 
−
end
 
 
end
 
end
−
 
+
table.insert(styles, style)
−
-- List style
+
if #styles == 0 then
−
-- ul_style and ol_style are included for backwards compatibility. No
+
return nil
−
-- 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
 
end
−
+
return mw.ustring.format(' style="%s"', table.concat(styles, ' '))
−
return data
 
 
end
 
end
  
−
function p.renderList(data)
+
function p.makeList(listType, args)
−
-- Renders the list HTML.
+
-- This is the main function to be called from other Lua modules.
−
+
-- First, get the list items.
−
-- Return the blank string if there are no list items.
+
local listItems = {}
−
if type(data.items) ~= 'table' or #data.items < 1 then
+
local argNums = getArgNums(args)
 +
for i, num in ipairs(argNums) do
 +
local item = getListItem(
 +
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
 +
if #listItems == 0 then
 
return ''
 
return ''
 
end
 
end
−
+
-- Check if we need a ul tag or an ol tag, and get the start and type attributes for ordered lists.
−
-- Render the main div tag.
+
local listTag = 'ul'
−
local root = mw.html.create('div')
+
local startAttr, typeAttr
−
for i, class in ipairs(data.classes or {}) do
+
if listType == 'ordered' or listType == 'horizontal_ordered' then
−
root:addClass(class)
+
listTag = 'ol'
−
end
+
startAttr = args.start
−
root:css{['margin-left'] = data.marginLeft}
+
if startAttr then
−
if data.style then
+
startAttr = ' start="' .. startAttr .. '"'
−
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
 
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.class) or ''
 +
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
  
−
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)
Retrieved from "https://stationeers-wiki.com/Module:List"