Модуль:List — различия между версиями

Материал из HARITONOV
Перейти к: навигация, поиск
(Minerva skin needs whether an hlist is separated to be explicit (see https://en.wikipedia.org/wiki/Wikipedia:Village_pump_(technical)#Hlist_bullets_not_shown_in_mobile))
 
м (tst)
 
Строка 1: Строка 1:
−
-- 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 p = {}
  
−
local listTypes = {
+
local function get_args (frame)
−
['bulleted'] = true,
+
-- На случай вызова из шаблона и из модуля:
−
['unbulleted'] = true,
+
local args = frame:getParent () and mw.clone (frame:getParent ().args) or {}
−
['horizontal'] = true,
+
-- Overrides:
−
['ordered'] = true,
+
for key, val in pairs (frame.args) do
−
['horizontal_ordered'] = true
+
args [key] = val
−
}
+
−
 
+
−
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
 
end
−
table.insert(data.classes, args.class)
+
return args
 +
end -- local function get_args (frame)
  
−
-- Main div style
+
local function remove_empty (list)
−
data.style = args.style
+
local ret = {}
−
 
+
for i, item in ipairs (list) do
−
-- Indent for horizontal lists
+
if item ~= '' then
−
if listType == 'horizontal' or listType == 'horizontal_ordered' then
+
ret [#ret + 1] = item
−
local indent = tonumber(args.indent)
+
−
indent = indent and indent * 1.6 or 0
+
−
if indent > 0 then
+
−
data.marginLeft = indent .. 'em'
+
 
end
 
end
 
end
 
end
−
+
return ret
−
-- List style types for ordered lists
+
end -- local function remove_empty (list)
−
-- 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
+
local function multiline (list, mark, header)
−
-- list-style-type CSS properties.
+
local ret = ''
−
if data.type
+
for _, item in ipairs (list) do
−
and not data.listStyleType
+
ret = ret .. '\n' .. mark .. ' ' .. tostring (item)
−
and not tostring(data.type):find('^%s*[1AaIi]%s*$')
+
−
then
+
−
data.listStyleType = data.type
+
−
data.type = nil
+
−
end
+
 
end
 
end
−
+
if ret ~= '' and header then
−
-- List tag type
+
ret = header .. ret
−
if listType == 'ordered' or listType == 'horizontal_ordered' then
+
−
data.listTag = 'ol'
+
−
else
+
−
data.listTag = 'ul'
+
 
end
 
end
 +
return ret
 +
end -- local function multiline (list, mark, header)
  
−
-- Start number for ordered lists
+
function p.l (frame)
−
data.start = args.start
+
local args = get_args (frame)
−
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
+
local header = args ['заголовок']
−
-- distinction is made for ordered or unordered lists.
+
local separator = args ['разделитель']
−
data.listStyle = args.list_style
+
-- Для явно заданного разделителя, вроде «•», «и» не нужно:
 +
local last = separator or args ['последний']
  
−
-- List items
+
-- Случай многострочного списка:
−
-- li_style is included for backwards compatibility. item_style was included
+
if separator == '*' or separator == '#' then
−
-- to be easier to understand for non-coders.
+
return multiline (remove_empty (args), separator, header)
−
data.itemStyle = args.item_style or args.li_style
+
else
−
data.items = {}
+
local ret = mw.text.listToText (remove_empty (args), separator, last)
−
for i, num in ipairs(mTableTools.numKeys(args)) do
+
if ret ~= '' and header then
−
local item = {}
+
ret = header .. ' ' .. ret
−
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
 
end
−
if t.style then
+
return ret
−
item:cssText(t.style)
+
−
end
+
−
item
+
−
:attr{value = t.value}
+
−
:wikitext(t.content)
+
 
end
 
end
 +
end -- function p.l (frame)
  
−
return tostring(root)
+
function p.bl (frame)
−
end
+
local args = get_args (frame)
 +
-- Общий маркёр:
 +
local bullet = args ['маркёр'] or args ['bullet'] or '{{*}}'
  
−
function p.renderTrackingCategories(args)
+
local lines = {}
−
local isDeprecated = false -- Tracks deprecated parameters.
+
for i = 1, #args, 2 do
−
for k, v in pairs(args) do
+
lines [#lines + 1] = {bullet = args [i] or bullet, str = args [i + 1] or ''}
−
k = tostring(k)
+
−
if k:find('^item_style%d+$') or k:find('^item_value%d+$') then
+
−
isDeprecated = true
+
−
break
+
−
end
+
 
end
 
end
 
local ret = ''
 
local ret = ''
−
if isDeprecated then
+
if #lines > 0 then
−
ret = ret .. '[[Category:List templates with deprecated parameters]]'
+
ret = ret .. '<table style="background: transparent; vertical-align: top;">'
 +
for _, line in ipairs (lines) do
 +
ret = ret .. '\n<tr><td style="vertical-align:top; padding-top: 0.3ex">' .. line.bullet
 +
  .. '</td><td style="vertical-align:top">' .. line.str .. '</td></tr>'
 +
end
 +
ret = ret .. '\n</table>'
 
end
 
end
 
return ret
 
return ret
−
end
+
end -- function p.bl (frame)
  
−
function p.makeList(listType, args)
+
function p.ul (frame)
−
if not listType or not listTypes[listType] then
+
local args = get_args (frame)
−
error(string.format(
+
-- Извлекаем параметры — не пункты списка:
−
"bad argument #1 to 'makeList' ('%s' is not a valid list type)",
+
local header = args ['заголовок']
−
tostring(listType)
+
return multiline (remove_empty (args), '*', header)
−
), 2)
+
end -- function p.ul (frame)
−
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
+
function p.ol (frame)
−
p[listType] = function (frame)
+
local args = get_args (frame)
−
local mArguments = require('Module:Arguments')
+
-- Извлекаем параметры — не пункты списка:
−
local origArgs = mArguments.getArgs(frame)
+
local header = args ['заголовок']
−
-- Copy all the arguments to a new table, for faster indexing.
+
return multiline (remove_empty (args), '#', header)
−
local args = {}
+
end -- function p.ol (frame)
−
for k, v in pairs(origArgs) do
+
−
args[k] = v
+
−
end
+
−
return p.makeList(listType, args)
+
−
end
+
−
end
+
  
 
return p
 
return p

Текущая версия на 03:18, 29 мая 2019

Для документации этого модуля может быть создана страница Модуль:List/doc 

local p = {}

local function get_args (frame)
	-- На случай вызова из шаблона и из модуля:
	local args = frame:getParent () and mw.clone (frame:getParent ().args) or {}
	-- Overrides:
	for key, val in pairs (frame.args) do
		args [key] = val
	end
	return args
end		-- local function get_args (frame)

local function remove_empty (list)
	local ret = {}
	for i, item in ipairs (list) do
		if item ~= '' then
			ret [#ret + 1] = item
		end
	end
	return ret
end		-- local function remove_empty (list)

local function multiline (list, mark, header)
	local ret = ''
	for _, item in ipairs (list) do
		ret = ret .. '\n' .. mark .. ' ' .. tostring (item)
	end
	if ret ~= '' and header then
		ret = header .. ret
	end
	return ret
end		-- local function multiline (list, mark, header)

function p.l (frame)
	local args = get_args (frame)

	-- Извлекаем параметры — не пункты списка:
	local header = args ['заголовок']
	local separator = args ['разделитель']
	-- Для явно заданного разделителя, вроде «•», «и» не нужно:
	local last = separator or args ['последний']

	-- Случай многострочного списка:
	if separator == '*' or separator == '#' then
		return multiline (remove_empty (args), separator, header)
	else
		local ret = mw.text.listToText (remove_empty (args), separator, last)
		if ret ~= '' and header then
			ret = header .. ' ' .. ret
		end
		return ret
	end
end		-- function p.l (frame)

function p.bl (frame)
	local args = get_args (frame)
	-- Общий маркёр:
	local bullet = args ['маркёр'] or args ['bullet'] or '{{*}}'

	local lines = {}
	for i = 1, #args, 2 do
		lines [#lines + 1] = {bullet = args [i] or bullet, str = args [i + 1] or ''}
	end
	local ret = ''
	if #lines > 0 then
		ret = ret .. '<table style="background: transparent; vertical-align: top;">'
		for _, line in ipairs (lines) do
			ret = ret .. '\n<tr><td style="vertical-align:top; padding-top: 0.3ex">' .. line.bullet
					  .. '</td><td style="vertical-align:top">' .. line.str .. '</td></tr>'
		end
		ret = ret .. '\n</table>'
	end
	return ret
end		-- function p.bl (frame)

function p.ul (frame)
	local args = get_args (frame)
	-- Извлекаем параметры — не пункты списка:
	local header = args ['заголовок']
	return multiline (remove_empty (args), '*', header)
end	-- function p.ul (frame)

function p.ol (frame)
	local args = get_args (frame)
	-- Извлекаем параметры — не пункты списка:
	local header = args ['заголовок']
	return multiline (remove_empty (args), '#', header)
end	-- function p.ol (frame)

return p
Источник — «https://haritonov.wiki/index.php?title=Модуль:List&oldid=5309»