ページ「モジュール:Message box/configuration」と「モジュール:List」の間の差分

提供:林 康紀研究室
< モジュール:Message box(ページ間の差分)
ナビゲーションに移動 検索に移動
yhlabj>ネイ
(en:Module:Message box/configuration oldid=1097616239 より更新)
 
yhlabj>STS2657
(コード修正。モジュール:List/sandboxの2021年12月13日 (月) 00:33(JST)の版から。)
 
1行目: 1行目:
--------------------------------------------------------------------------------
-- This module outputs different kinds of lists. At the moment, bulleted,
--                          Message box configuration                        --
-- unbulleted, horizontal, ordered, and horizontal ordered lists are supported.
--                                                                            --
-- This module contains configuration data for [[Module:Message box]].       --
--------------------------------------------------------------------------------


return {
local libUtil = require('libraryUtil')
ambox = {
local checkType = libUtil.checkType
types = {
local mTableTools = require('Module:TableTools')
speedy = {
 
class = 'ambox-speedy',
local p = {}
image = 'Ambox warning pn.svg'
 
},
local listTypes = {
delete = {
['bulleted'] = true,
class = 'ambox-delete',
['unbulleted'] = true,
image = 'Ambox warning pn.svg'
['horizontal'] = true,
},
['ordered'] = true,
content = {
['horizontal_ordered'] = true
class = 'ambox-content',
}
image = 'Ambox important.svg'
 
},
function p.makeListData(listType, args)
style = {
-- Constructs a data table to be passed to p.renderList.
class = 'ambox-style',
local data = {}
image = 'Edit-clear.svg'
 
},
-- Classes
move = {
data.classes = {}
class = 'ambox-move',
if listType == 'horizontal' or listType == 'horizontal_ordered' then
image = 'Merge-split-transwiki default.svg'
table.insert(data.classes, 'hlist hlist-separated')
},
elseif listType == 'unbulleted' then
protection = {
table.insert(data.classes, 'plainlist')
class = 'ambox-protection',
end
image = 'Padlock-silver-medium.svg'
table.insert(data.classes, args.class)
},
 
notice = {
-- Main div style
class = 'ambox-notice',
data.style = args.style
image = 'Information icon4.svg'
 
}
-- Indent for horizontal lists
},
if listType == 'horizontal' or listType == 'horizontal_ordered' then
default                    = 'notice',
local indent = tonumber(args.indent)
allowBlankParams            = {'talk', 'sect', 'date', 'issue', 'fix', 'subst', 'hidden'},
indent = indent and indent * 1.6 or 0
allowSmall                  = true,
if indent > 0 then
smallParam                  = 'left',
data.marginLeft = indent .. 'em'
smallClass                  = 'mbox-small-left',
end
substCheck                  = true,
end
classes                    = {--[['metadata',]] 'ambox'},
imageEmptyCell              = true,
imageCheckBlank            = true,
imageSmallSize              = '20x20px',
imageCellDiv                = true,
useCollapsibleTextFields    = true,
imageRightNone              = true,
sectionDefault              = '記事',
allowMainspaceCategories    = true,
templateCategory            = '記事メッセージボックス',
        templateCategoryRequireName = true,
templateErrorCategory      = 'パラメータ指定の無い記事メッセージボックス',
templateErrorParamsToCheck  = {'issue', 'fix', 'subst'},
templatestyles              = 'Module:Message box/ambox.css'
},
cmbox = {
-- List style types for ordered lists
types = {
-- This could be "1, 2, 3", "a, b, c", or a number of others. The list style
speedy = {
-- type is either set by the "type" attribute or the "list-style-type" CSS
class = 'cmbox-speedy',
-- property.
image = 'Ambox warning pn.svg'
if listType == 'ordered' or listType == 'horizontal_ordered' then
},
data.listStyleType = args.list_style_type or args['list-style-type']
delete = {
data.type = args['type']
class = 'cmbox-delete',
 
image = 'Ambox warning pn.svg'
-- Detect invalid type attributes and attempt to convert them to
},
-- list-style-type CSS properties.
content = {
if data.type
class = 'cmbox-content',
and not data.listStyleType
image = 'Ambox important.svg'
and not tostring(data.type):find('^%s*[1AaIi]%s*$')
},
then
style = {
data.listStyleType = data.type
class = 'cmbox-style',
data.type = nil
image = 'Edit-clear.svg'
end
},
end
move = {
class = 'cmbox-move',
image = 'Merge-split-transwiki default.svg'
},
protection = {
class = 'cmbox-protection',
image = 'Padlock-silver-medium.svg'
},
notice = {
class = 'cmbox-notice',
image = 'Information icon4.svg'
}
},
default              = 'notice',
showInvalidTypeError = true,
classes              = {'cmbox'},
imageEmptyCell      = true,
templatestyles      = 'Module:Message box/cmbox.css'
},
fmbox = {
-- List tag type
types = {
if listType == 'ordered' or listType == 'horizontal_ordered' then
warning = {
data.listTag = 'ol'
class = 'fmbox-warning',
else
image = 'Ambox warning pn.svg'
data.listTag = 'ul'
},
end
editnotice = {
 
class = 'fmbox-editnotice',
-- Start number for ordered lists
image = 'Information icon4.svg'
data.start = args.start
},
if listType == 'ordered' or listType == 'horizontal_ordered' then
system = {
-- Apply fix to get start numbers working with horizontal ordered lists.
class = 'fmbox-system',
local startNum = tonumber(data.start)
image = 'Information icon4.svg'
if startNum then
}
data.counterReset = 'listitem ' .. tostring(startNum)
},
data.counterIncrement = 'listitem -1'
default              = 'system',
end
showInvalidTypeError = true,
end
classes              = {'fmbox'},
 
imageEmptyCell      = false,
-- List style
imageRightNone      = false,
-- ul_style and ol_style are included for backwards compatibility. No
templatestyles      = 'Module:Message box/fmbox.css'
-- 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)]
if item.value ~= nil then
item.style = 'counter-reset: listitem ' .. item.value .. ';counter-increment: none;' .. ((item.style) or '')
end
table.insert(data.items, item)
end
imbox = {
return data
types = {
end
speedy = {
 
class = 'imbox-speedy',
function p.renderList(data)
image = 'Ambox warning pn.svg'
-- Renders the list HTML.
},
delete = {
class = 'imbox-delete',
image = 'Ambox warning pn.svg'
},
content = {
class = 'imbox-content',
image = 'Ambox important.svg'
},
style = {
class = 'imbox-style',
image = 'Edit-clear.svg'
},
move = {
class = 'imbox-move',
image = 'Merge-split-transwiki default.svg'
},
protection = {
class = 'imbox-protection',
image = 'Padlock-silver-medium.svg'
},
license = {
class = 'imbox-license licensetpl',
image = 'Imbox license.png' -- @todo We need an SVG version of this
},
featured = {
class = 'imbox-featured',
image = 'Cscr-featured.svg'
},
notice = {
class = 'imbox-notice',
image = 'Information icon4.svg'
}
},
default              = 'notice',
showInvalidTypeError = true,
classes              = {'imbox'},
imageEmptyCell      = true,
below                = true,
templateCategory    = 'ファイルメッセージボックス',
templatestyles      = 'Module:Message box/imbox.css'
},
ombox = {
-- Return the blank string if there are no list items.
types = {
if type(data.items) ~= 'table' or #data.items < 1 then
speedy = {
return ''
class = 'ombox-speedy',
end
image = 'Ambox warning pn.svg'
},
delete = {
class = 'ombox-delete',
image = 'Ambox warning pn.svg'
},
content = {
class = 'ombox-content',
image = 'Ambox important.svg'
},
style = {
class = 'ombox-style',
image = 'Edit-clear.svg'
},
move = {
class = 'ombox-move',
image = 'Merge-split-transwiki default.svg'
},
protection = {
class = 'ombox-protection',
image = 'Padlock-silver-medium.svg'
},
notice = {
class = 'ombox-notice',
image = 'Information icon4.svg'
}
},
default              = 'notice',
showInvalidTypeError = true,
classes              = {'ombox'},
allowSmall          = true,
imageEmptyCell      = true,
imageRightNone      = true,
templatestyles      = 'Module:Message box/ombox.css'
},
tmbox = {
-- Render the main div tag.
types = {
local root = mw.html.create('div')
speedy = {
for i, class in ipairs(data.classes or {}) do
class = 'tmbox-speedy',
root:addClass(class)
image = 'Ambox warning pn.svg'
end
},
root:css{['margin-left'] = data.marginLeft}
delete = {
if data.style then
class = 'tmbox-delete',
root:cssText(data.style)
image = 'Ambox warning pn.svg'
end
},
 
content = {
-- Render the list tag.
class = 'tmbox-content',
local list = root:tag(data.listTag or 'ul')
image = 'Ambox important.svg'
list
},
:attr{start = data.start, type = data.type}
style = {
:css{
class = 'tmbox-style',
['counter-reset'] = data.counterReset,
image = 'Edit-clear.svg'
['counter-increment'] = data.counterIncrement,
},
['list-style-type'] = data.listStyleType
move = {
}
class = 'tmbox-move',
if data.listStyle then
image = 'Merge-split-transwiki default.svg'
list:cssText(data.listStyle)
},
end
protection = {
 
class = 'tmbox-protection',
-- Render the list items
image = 'Padlock-silver-medium.svg'
for i, t in ipairs(data.items or {}) do
},
local item = list:tag('li')
notice = {
if data.itemStyle then
class = 'tmbox-notice',
item:cssText(data.itemStyle)
image = 'Information icon4.svg'
end
}
if t.style then
},
item:cssText(t.style)
default              = 'notice',
end
showInvalidTypeError = true,
item
classes              = {'tmbox'},
:attr{value = t.value}
allowSmall          = true,
:wikitext(t.content)
imageRightNone      = true,
end
imageEmptyCell      = true,
 
templateCategory    = 'ノートページメッセージボックス',
return tostring(root)
templatestyles      = 'Module:Message box/tmbox.css'
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, {
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

2022年6月15日 (水) 00:09時点における版

このモジュールについての説明文ページを モジュール:List/doc に作成できます

-- 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 == 'ordered' or 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)
			data.counterIncrement = 'listitem -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)]
		if item.value ~= nil then
			item.style = 'counter-reset: listitem ' .. item.value .. ';counter-increment: none;' .. ((item.style) or '')
		end
		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,
			['counter-increment'] = data.counterIncrement,
			['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, {
			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