모듈:List

이 모듈은 여러 가지 다양한 목록들을 출력합니다. 현재 글머리기호가 있는 목록과 없는 목록, 가로목록, (숫자나 자모순의) 순서목록, 가로순서목록을 지원합니다. 목록이나 개별 목록 항목들의 CSS 스타일링을 쉽게 만들어줍니다.

사용법

간단한 사용법

전체 매개변수

Arguments passed from parent template

함수

함수명	목적	출력 예시	함수가 사용된 틀
bulleted	기호 목록	항목 1 항목 2 항목 3	틀:Tlx
unbulleted	기호 없는 목록	항목 1 항목 2 항목 3	틀:Tlx
horizontal	기호가 있는 가로목록	항목 1 항목 2 항목 3	틀:Tlx
ordered	순서 목록 (숫자나 알파벳 순)	항목 1 항목 2 항목 3	틀:Tlx
horizontal_ordered	가로 순서 목록	항목 1 항목 2 항목 3

용례

기호 목록

코드	결과
{{#invoke:list|bulleted|항목 1|항목 2|항목 3}}	항목 1 항목 2 항목 3
{{#invoke:list|bulleted|항목 1|항목 2|항목 3|item_style=color:blue;}}	항목 1 항목 2 항목 3
{{#invoke:list|bulleted|항목 1|항목 2|항목 3|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	항목 1 항목 2 항목 3

기호 없는 목록

코드	결과
{{#invoke:list|unbulleted|항목 1|항목 2|항목 3}}	항목 1 항목 2 항목 3
{{#invoke:list|unbulleted|항목 1|항목 2|항목 3|item_style=color:blue;}}	항목 1 항목 2 항목 3
{{#invoke:list|unbulleted|항목 1|항목 2|항목 3|item1_style=background-color:yellow;|item2_style=background-color:silver;}}	항목 1 항목 2 항목 3

가로 목록

코드	결과
{{#invoke:list|horizontal|항목 1|항목 2|항목 3}}	항목 1 항목 2 항목 3
{{#invoke:list|horizontal|항목 1|항목 2|항목 3|indent=2}}	항목 1 항목 2 항목 3

순서 있는 목록

코드	결과
{{#invoke:list|ordered|항목 1|항목 2|항목 3}}	항목 1 항목 2 항목 3
{{#invoke:list|ordered|항목 1|항목 2|항목 3|start=3}}	항목 1 항목 2 항목 3
{{#invoke:list|ordered|항목 1|항목 2|항목 3|type=i}	항목 1 항목 2 항목 3
{{#invoke:list|ordered|항목 1|항목 2|항목 3|list_style_type=lower-greek}}	항목 1 항목 2 항목 3

순서 있는 가로 목록

코드	결과
{{#invoke:list|horizontal_ordered|항목 A|항목 B|항목 C}}	항목 A 항목 B 항목 C
{{#invoke:list|horizontal_ordered|항목 A|항목 B|항목 C|start=3}}	항목 A 항목 B 항목 C
{{#invoke:list|horizontal_ordered|항목 A|항목 B|항목 C|indent=2}}	항목 A 항목 B 항목 C

같이 보기

• 모듈:Separated entries

---

-- 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