Module:WikiProject banner/auxiliary

Module documentation[view] [edit] [history] [purge]

This module is rated as beta, and is ready for widespread use. It is still new and should be used with some caution to ensure the results are as expected.

This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing.

This Lua module is used on approximately 4,020,000 pages, or roughly 6% of all pages.
To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

This module depends on the following other modules:

This module contains extra functions not frequently used by Module:WikiProject banner to support the following features:

B-class checklist
To-do list
Assessment category intersection
Image-needed note
Collaboration note
A-class review note
Peer review note

The above documentation is transcluded from Module:WikiProject banner/auxiliary/doc.
Editors can experiment in this module's sandbox and testcases pages.
Subpages of this module.

require('strict')
local p = {}
local sandbox-- = '/sandbox'
local cfg = mw.loadData('Module:WikiProject banner/config' .. (sandbox or ''))

p.b_checklist = function(args, raw_args)
---------------------------
-- B-class checklist ------
---------------------------
local show_checklist, parameters_used = false, nil
parameters_used = args.b1 or args.b2 or args.b3 or args.b4 or args.b5 or args.b6
if class=='B' or class=='C' then
	show_checklist = true
elseif class=='Start' and yesno(args.DISPLAY_ON_START) then
	show_checklist = true
elseif (class=='Start' or class=='Stub') and parameters_used then
	show_checklist = true
end
if show_checklist then
	local scale = args.QUALITY_CRITERIA=='custom' and assessment_link and assessment_link..'#'..lang:ucfirst(cfg.quality.name)
		or cfg.b_checklist.default_scale
	local text = string.format(
		cfg.b_checklist.text,
		parameters_used and cfg.b_checklist.checked or cfg.b_checklist.not_checked,
		scale
	)
	local criteria = mw.html.create('ol')
	for i = 1, 6 do
		local b = raw_args['b'..i]
		if b and b~='unused' then -- crtierion in use
			b = cfg.b_checklist.mask[string.lower(b)] or cfg.b_checklist.mask.default
			local image = '[[File:' .. cfg.b_checklist.icon[b] .. '.svg|16x16px|link=|alt=]]'
			criteria:tag('li')
				:wikitext(image .. ' ' .. cfg.b_checklist.criteria[i] .. ': ')
				:tag('span')
					:css('font-style', 'italic')
					:wikitext(cfg.b_checklist.status[b])
			:allDone()
		end
	end
	local checklist = mw.html.create('tr')
		:tag('td')
			:addClass('assess-b')
			:css('background', cfg.b_checklist.background):css('padding-bottom', '5px')
			:wikitext(cfg.b_checklist.image)
		:done()
		:tag('td')
			:addClass('wpb-collapsed-notes')
			:tag('table')
				:addClass('plainlinks mw-collapsible mw-collapsed')
				:tag('tr')
					:tag('th')
						:addClass('wpb-collapsed-head mbox-text')
						:attr('colspan', '3')
						:css('font-weight', 'normal')
						:wikitext(text)
					:done()
					:tag('td'):css('min-width', '3em'):done() -- empty cell for show/hide toggle
				:done()
				:tag('tr')
					:tag('td')
						:css('font-size', '90%')
						:node(criteria)
					:done()
					:tag('td')
						:css('font-size', '88%')
					:done()
					:tag('td'):addClass('empty-cell'):done()
				:done()
			:done()
		:done()
	:done()
	return checklist
end

end