模块:List

该模块输出各种列表。目前，它支持项目符号列表、无项目符号列表、水平列表、排序列表(编号或字母顺序)和水平排序列表。它允许轻松设置列表或单个列表项的CSS样式。

用法

快捷用法

{{#invoke:list|function|第一项|第二项|第三项|...}}

所有参数

{{#invoke:list|function
|第一项|第二项|第三项|...
|start           = 有序列表的起始号
|type            = 有序列表编号类型
|list_style_type = 有序列表的标记类型(使用CSS代码)
|class           = 类（CSS）
|style           = 样式（CSS代码）
|list_style      = 列表样式
|item_style      = 所有列表项的样式
|item1_style     = 第一个列表项的样式
|item2_style = 第二个列表项的样式 |...
|item1_value     = 第一个列表项的值
|item2_value = 第二个列表项的值 |...
|indent          = 水平列表的缩进
}}

从父模板传递的参数

{{#invoke:list|function}}

功能

函数名	产生	示例输出
bulleted	有序列表	第一项 第二项 第三项
unbulleted	无序列表	第一项 第二项 第三项
horizontal	水平项目符号列表	第一项 第二项 第三项
ordered	有序列表（编号列表和字母列表）	第一项 第二项 第三项
horizontal_ordered	水平有序列表	第一项 第二项 第三项

参数

• 位置参数（1，2，3...） - 这些是列表项。如果没有列表项，则模块将不输出任何内容。
• start - 设置有序列表的起始项。这可以是有序列表的起始数字，也可以是有序列表的起始字母。水平有序列表只支持数字。
• type - 有序列表中使用的标记类型。可能的值为 "1" 表示数字（默认），"A" 表示大写字母，"a" 表示小写字母，"I" 表示大写罗马数字，"i" 表示小写罗马数字。水平有序列表不支持。另请参阅 list_style_type 参数。
• list_style_type - 有序列表中使用的标记类型。这使用CSS样式，比 type 参数提供更多类型的标记。可能的值列在 MDN 的 list-style-type 页面 上。浏览器支持可能有所不同。 list-style-type 是此参数的别名。
• class - <div>...</div> 标签周围列表的自定义类，例如 plainlinks。
• style - <div>...</div> 标签周围列表的自定义CSS样式，例如 font-size: 90%;。
• list_style - 列表本身的自定义CSS样式。格式与 |style= 参数相同。
• item_style - 所有列表项（<li>...</li> 标签）的自定义CSS样式。格式与 |style= 参数相同。
• item1_style、item2_style、item3_style... - 每个列表项的自定义CSS样式。格式与 |style= 参数相同。
• item1_value、item2_value、item3_value... - 给定列表项的自定义值。在给定值之后的列表项将从指定值递增。该值应为正整数。（请注意，此选项仅对有序列表有效。）
• indent - 此参数缩进列表，仅适用于水平和水平有序列表。值必须为数字，例如 2。缩进以 em 计算，并且是指定值的 1.6 倍。如果未指定缩进，则默认值为零。

示例

无序列表

代码	效果
{{#invoke:list|bulleted|第一项|第二项|第三项}}	第一项 第二项 第三项
{{#invoke:list|bulleted|第一项|第二项|第三项|item_style=color:blue;}}	第一项 第二项 第三项
{{#invoke:list|bulleted|第一项|第二项|第三项|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	第一项 第二项 第三项

无序列表

代码	效果
{{#invoke:list|unbulleted|第一项|第二项|第三项}}	第一项 第二项 第三项
{{#invoke:list|unbulleted|第一项|第二项|第三项|item_style=color:blue;}}	第一项 第二项 第三项
{{#invoke:list|unbulleted|第一项|第二项|第三项|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	第一项 第二项 第三项

水平列表

代码	效果
{{#invoke:list|horizontal|第一项|第二项|第三项}}	第一项 第二项 第三项
{{#invoke:list|horizontal|第一项|第二项|第三项|indent=2}}	第一项 第二项 第三项

有序列表

代码	效果
{{#invoke:list|ordered|第一项|第二项|第三项}}	第一项 第二项 第三项
{{#invoke:list|ordered|第一项|第二项|第三项|start=3}}	第一项 第二项 第三项
{{#invoke:list|ordered|第一项|第二项|第三项|type=i}	第一项 第二项 第三项
{{#invoke:list|ordered|第一项|第二项|第三项|list_style_type=lower-greek}}	第一项 第二项 第三项

水平有序列表

代码	效果
{{#invoke:list|horizontal_ordered|第一项|第二项|第三项}}	第一项 第二项 第三项
{{#invoke:list|horizontal_ordered|第一项|第二项|第三项|start=3}}	第一项 第二项 第三项
{{#invoke:list|horizontal_ordered|第一项|第二项|第三项|indent=2}}	第一项 第二项 第三项

追蹤分類

• Category:含有过期参数的列表模板（0）

參見

• Module:Separated entries
• Module:Unbulleted list

---

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 and TemplateStyles
	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 = 'Hlist/styles.css' }
		}
	elseif listType == 'unbulleted' then
		table.insert(data.classes, 'plainlist')
		data.templatestyles = mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = { src = '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
	
	-- 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 _, 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)]
			or args['li_style' .. tostring(num)]
		item.value = args['item' .. tostring(num) .. '_value']
			or args['item_value' .. tostring(num)]
			or args['li_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 _, 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 _, 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 data.templatestyles .. 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:含有过期参数的列表模板]]'
	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'不是合适的列表类型)",
			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, {
			frameOnly = ((frame and frame.args and frame.args.frameonly or '') ~= ''),
			valueFunc = function (key, value)
			if not value or not mw.ustring.find(value, '%S') then return nil end
			if mw.ustring.find(value, '^%s*[%*#;:]') then
				return value
			else
				return value:match('^%s*(.-)%s*$')
			end
			return nil
		end
		})
		-- 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