Module:List

From Zoophilia Wiki
Revision as of 02:14, 7 January 2014 by meta>Mr. Stradivarius (Protected Module:List: High-risk Lua module: ~1,100 transclusions ([Edit=Allow only autoconfirmed users] (indefinite) [Move=Allow only autoconfirmed users] (indefinite)))
Jump to navigationJump to search

This module outputs various kinds of lists. At present, it supports bulleted lists, unbulleted lists, horizontal lists, ordered lists (numbered or alphabetical), and horizontal ordered lists. It allows for easy css styling of the list or of the individual list items.

Usage

Quick usage
{{#invoke:list|function|first item|second item|third item|...}}
All parameters
{{#invoke:list|function
|first item|second item|third item|...
|start           = start number for ordered lists
|type            = type of numbering for ordered lists
|list_style_type = type of marker for ordered lists (uses CSS)
|class           = class
|style           = style
|list_style      = style for the list
|item_style      = style for all list items
|item1_style     = style for the first list item |item2_style = style for the second list item |...
|item1_value     = value for the first list item |item2_value = value for the second list item |...
|indent          = indent for horizontal lists
}}
Arguments passed from parent template
{{#invoke:list|function}}
Functions
Function name Produces Example output Template using the function
bulleted Bulleted lists Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found. {{bulleted list}}
unbulleted Unbulleted lists Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found. {{unbulleted list}}
horizontal Horizontal bulleted lists Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found. {{hlist}}
ordered Ordered lists (numbered lists and alphabetical lists) Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found. {{ordered list}}
horizontal_ordered Horizontal ordered lists Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.

Parameters

  • Positional parameters (1, 2, 3...) - these are the list items. If no list items are present, the module will output nothing.
  • start - sets the start item for ordered lists. This can be a start number for numbered lists, or a start letter for alphabetical lists. Horizontal ordered lists only support numbers.
  • type - the type of marker used in ordered lists. Possible values are "1" for numbers (the default), "A" for uppercase letters, "a" for lowercase letters, "I" for uppercase Roman numerals, and "i" for lowercase Roman numerals. Not supported in horizontal ordered lists. See also the list_style_type parameter.
  • list_style_type - the type of marker used in ordered lists. This uses CSS styling, and has more types available than the type parameter, which uses an html attribute. Possible values are listed at MDN's list-style-type page. Support may vary by browser. list-style-type is an alias for this parameter.
  • class - a custom class for the <div>...</div> tags surrounding the list, e.g. plainlinks.
  • style - a custom css style for the <div>...</div> tags surrounding the list, e.g. font-size: 90%;.
  • list_style - a custom css style for the list itself. The format is the same as for the |style= parameter.
  • item_style - a custom css style for all of the list items (the <li>...</li> tags). The format is the same as for the |style= parameter.
  • item1_style, item2_style, item3_style... - custom css styles for each of the list items. The format is the same as for the |style= parameter.
  • item1_value, item2_value, item3_value... - custom value for the given list item. List items following the one given will increment from the specified value. The value should be a positive integer. (Note that this option only has an effect on ordered lists.)
  • indent - this parameter indents the list, for horizontal and horizontal ordered lists only. The value must be a number, e.g. 2. The indent is calculated in em, and is 1.6 times the value specified. If no indent is specified, the default is zero.

Examples

Bulleted lists
Code Result
{{#invoke:list|bulleted|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
Unbulleted lists
Code Result
{{#invoke:list|unbulleted|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
Horizontal lists
Code Result
{{#invoke:list|horizontal|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
Ordered lists
Code Result
{{#invoke:list|ordered|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|ordered|First item|Second item|Third item|start=3}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|ordered|First item|Second item|Third item|type=i} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
Horizontal ordered lists
Code Result
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}} Lua error in package.lua at line 80: module 'Module:HtmlBuilder' not found.

Tracking/maintenance category

See also


-- This module outputs different kinds of lists. At the moment, bulleted, unbulleted,
-- horizontal, ordered, and horizontal ordered lists are supported.

local p = {}

local htmlBuilder = require('Module:HtmlBuilder')

local function getListItem(data, style, itemStyle, itemValue)
	if not data then
		return c
	end
	local item = htmlBuilder.create('li')
	item
		.cssText(style)
		.cssText(itemStyle)
		.wikitext(data)
	if(itemValue) then
		item.attr('value',itemValue)
	end
	return tostring(item)
end

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.makeList(listType, args)
	-- This is the main function to be called from other Lua modules.
	-- First, get the list items.
	local listItems = {}
	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)],
			args['item_value' .. tostring(num)]
		)
		table.insert(listItems, item)
	end
	if #listItems == 0 then
		return ''
	end
	-- Build the opening div tag.
	local root = htmlBuilder.create('div')
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		root.addClass('hlist')
	elseif listType == 'unbulleted' then
		root.addClass('plainlist')
	end
	root.addClass(args.class)
	if listType == 'horizontal' or listType == 'horizontal_ordered' then
		local indent = tonumber(args.indent)
		indent = tostring((indent and indent * 1.6) or 0)
		root.css('margin-left', indent .. 'em')
	end
	-- If we are outputting an ordered list or an ordered horizontal list, get the type and list-style-type.
	-- Horizontal ordered lists aren't supported yet, but including them anyway in case support is ever added to the CSS backend.
	local listStyleType, typeAttr
	if listType == 'ordered' or listType == 'horizontal_ordered' then 
		listStyleType = args.list_style_type or args['list-style-type']
		typeAttr = args['type']
	end
	-- Detect if the type attribute specified by args.type is using an invalid value, and if so try passing it as a list-style-type CSS property.
	if typeAttr and not typeAttr:match('^%s*[1AaIi]%s*$') then
		if not listStyleType then
			listStyleType = typeAttr
			typeAttr = nil
		end
	end
	root.cssText(args.style)
	-- Build the list tags and list items.
	local list = root.tag((listType == 'ordered' or listType == 'horizontal_ordered') and 'ol' or 'ul')
	list
		.attr('start', args.start)
		.attr('type', typeAttr)
		.css('list-style-type', 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))
	return tostring(root)
end

local function makeWrapper(listType)
	return function(frame)
		local origArgs
		if frame == mw.getCurrentFrame() then
			origArgs = frame:getParent().args
			for k, v in pairs(frame.args) do
				origArgs = frame.args
				break
			end
		else
			origArgs = frame
		end
		
		local args = {}
		for k, v in pairs(origArgs) do
			if type(k) == 'number' or v ~= '' then
				args[k] = v
			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