The wiki has moved!

Visit the new wiki at stationeers-wiki.com The old wiki here at legacy.stationeers-wiki.com will sunset eventually.

Edits made after the 7th of March 6PM EST were NOT carried over to the new server as previously announced right here in this box.

 Actions

Module

Difference between revisions of "List"

From Unofficial Stationeers Wiki

(add list_style_type synonym for list-style-type)
m (29 revisions imported)
 
(20 intermediate revisions by 5 users not shown)
Line 1: Line 1:
−
-- This module outputs different kinds of lists. At the moment, bulleted, unbulleted,
+
-- 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 libUtil = require('libraryUtil')
 +
local checkType = libUtil.checkType
 +
local mTableTools = require('Module:TableTools')
  
 
local p = {}
 
local p = {}
  
−
local htmlBuilder = require('Module:HtmlBuilder')
+
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']
  
−
local function getListItem(data, style, itemStyle)
+
-- Detect invalid type attributes and attempt to convert them to
−
if not data then
+
-- list-style-type CSS properties.
−
return nil
+
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
 
end
−
local item = htmlBuilder.create('li')
 
−
item
 
−
.cssText(style)
 
−
.cssText(itemStyle)
 
−
.wikitext(data)
 
−
return tostring(item)
 
−
end
 
  
−
local function getArgNums(args)
+
-- Start number for ordered lists
−
-- Returns an array containing the keys of all positional arguments
+
data.start = args.start
−
-- that contain data (i.e. non-whitespace values).
+
if listType == 'horizontal_ordered' then
−
local nums = {}
+
-- Apply fix to get start numbers working with horizontal ordered lists.
−
for k, v in pairs(args) do
+
local startNum = tonumber(data.start)
−
if type(k) == 'number' and
+
if startNum then
−
k >= 1 and
+
data.counterReset = 'listitem ' .. tostring(startNum - 1)
−
math.floor(k) == k and
 
−
mw.ustring.match(v, '%S') then
 
−
table.insert(nums, k)
 
 
end
 
end
 
end
 
end
−
table.sort(nums)
+
 
−
return nums
+
-- 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
 
end
  
−
function p.makeList(listType, args)
+
function p.renderList(data)
−
-- This is the main function to be called from other Lua modules.
+
-- Renders the list HTML.
−
-- First, get the list items.
+
−
local listItems = {}
+
-- Return the blank string if there are no list items.
−
local argNums = getArgNums(args)
+
if type(data.items) ~= 'table' or #data.items < 1 then
−
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
−
-- Build the list html.
+
−
local root = htmlBuilder.create('div')
+
-- Render the main div tag.
−
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
local root = mw.html.create('div')
−
root.addClass('hlist')
+
for i, class in ipairs(data.classes or {}) do
−
elseif listType == 'unbulleted' then
+
root:addClass(class)
−
root.addClass('plainlist')
 
 
end
 
end
−
root.addClass(args.class)
+
root:css{['margin-left'] = data.marginLeft}
−
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
if data.style then
−
local indent = tonumber(args.indent)
+
root:cssText(data.style)
−
indent = tostring((indent and indent * 1.6) or 0)
 
−
root.css('margin-left', indent .. 'em')
 
 
end
 
end
−
root.cssText(args.style)
+
 
−
local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
+
-- Render the list tag.
 +
local list = root:tag(data.listTag or 'ul')
 
list
 
list
−
.attr('start', args.start)
+
:attr{start = data.start, type = data.type}
−
.attr('type', args.type)
+
:css{
−
.css('list-style-type', args.list_style_type or args['list-style-type'])
+
['counter-reset'] = data.counterReset,
−
.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.
+
['list-style-type'] = data.listStyleType
−
.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
  
−
local function makeWrapper(listType)
+
function p.renderTrackingCategories(args)
−
return function(frame)
+
local isDeprecated = false -- Tracks deprecated parameters.
−
local origArgs
+
for k, v in pairs(args) do
−
if frame == mw.getCurrentFrame() then
+
k = tostring(k)
−
origArgs = frame:getParent().args
+
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
−
for k, v in pairs(frame.args) do
+
isDeprecated = true
−
origArgs = frame.args
+
break
−
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
−
if type(k) == 'number' or v ~= '' then
+
args[k] = v
−
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

Latest revision as of 15:04, 14 July 2018

Documentation for this module may be created at Module:List/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)
		-- 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
Retrieved from "https://legacy.stationeers-wiki.com/index.php?title=Module:List&oldid=5712"