Модуль:List — Вікіпедія

{{i}} Документація модуля[перегляд] [редагувати] [історія] [очистити кеш]

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.

Використання

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
bulleted Bulleted lists
  • First item
  • Second item
  • Third item
unbulleted Unbulleted lists
  • First item
  • Second item
  • Third item
horizontal Horizontal bulleted lists
  • First item
  • Second item
  • Third item
ordered Ordered lists (numbered lists and alphabetical lists)
  1. First item
  2. Second item
  3. Third item
horizontal_ordered Horizontal ordered lists
  1. First item
  2. Second item
  3. Third item

Параметри

  • 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 W3schools' 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.

Приклади

Bulleted lists
Code Result
{{#invoke:list|bulleted|First item|Second item|Third item}}
  • First item
  • Second item
  • Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item_style=color:blue;}}
  • First item
  • Second item
  • Third item
{{#invoke:list|bulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • First item
  • Second item
  • Third item
Unbulleted lists
Code Result
{{#invoke:list|unbulleted|First item|Second item|Third item}}
  • First item
  • Second item
  • Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}
  • First item
  • Second item
  • Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • First item
  • Second item
  • Third item
Horizontal lists
Code Result
{{#invoke:list|horizontal|First item|Second item|Third item}}
  • First item
  • Second item
  • Third item
{{#invoke:list|horizontal|First item|Second item|Third item|indent=2}}
  • First item
  • Second item
  • Third item
Unbulleted lists
Code Result
{{#invoke:list|unbulleted|First item|Second item|Third item}}
  • First item
  • Second item
  • Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item_style=color:blue;}}
  • First item
  • Second item
  • Third item
{{#invoke:list|unbulleted|First item|Second item|Third item|item1_style=background-color:yellow;|item2_style=background-color:silver;}}
  • First item
  • Second item
  • Third item
Ordered lists
Code Result
{{#invoke:list|ordered|First item|Second item|Third item}}
  1. First item
  2. Second item
  3. Third item
{{#invoke:list|ordered|First item|Second item|Third item|start=3}}
  1. First item
  2. Second item
  3. Third item
{{#invoke:list|ordered|First item|Second item|Third item|type=i}
  1. First item
  2. Second item
  3. Third item
{{#invoke:list|ordered|First item|Second item|Third item|list_style_type=lower-greek}}
  1. First item
  2. Second item
  3. Third item
Horizontal ordered lists
Code Result
{{#invoke:list|horizontal_ordered|First item|Second item|Third item}}
  1. First item
  2. Second item
  3. Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|start=3}}
  1. First item
  2. Second item
  3. Third item
{{#invoke:list|horizontal_ordered|First item|Second item|Third item|indent=2}}
  1. First item
  2. Second item
  3. Third item
local libUtil = require('libraryUtil') local checkType = libUtil.checkType local mTableTools = require('Модуль: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)] 		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 _, 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 .. '[[Категорія:Проблеми у параметрах шаблонів Вікіпедії]]' 	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('Модуль:Arguments') 		local origArgs = mArguments.getArgs(frame, { 			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
Отримано з https://uk.wikipedia.org/w/index.php?title=Модуль:List&oldid=42405790