Module:Progress box - Revision history

Izno: -silly implements line, it's in the /doc

2023-03-01T04:23:23Z

-silly implements line, it's in the /doc

← Previous revision		Revision as of 04:23, 1 March 2023
Line 1:		Line 1:
	-- This module implements [[Template:Progress box]]

	local makePurgeLink = require('Module:Purge')._main		local makePurgeLink = require('Module:Purge')._main
	local lang = mw.language.getContentLanguage()		local lang = mw.language.getContentLanguage()

Izno: pull infobox styles local

2023-03-01T04:23:03Z

pull infobox styles local

← Previous revision		Revision as of 04:23, 1 March 2023
Line 129:		Line 129:

	-- Set data		-- Set data
	~~self._float~~ = args.float or 'left'		if not args.float or (args.float and (args.float == 'left' or args.float == '')) then
			self._float_class = 'maint-cat-progress-left'
⚫	~~self._margin =~~ args.float == 'none' ~~and 'auto' or nil~~
			elseif args.float == 'right' then
			self._float_class = 'maint-cat-progress-right'
		⚫	elseif args.float == 'none' then
			-- 'none' is actually 'center'ed
			self._float_class = 'maint-cat-progress-center'
			end

	self._header = args[1]		self._header = args[1]
	self._frame = mw.getCurrentFrame()		self._frame = mw.getCurrentFrame()
Line 240:		Line 247:
	function ProgressBox:__tostring()		function ProgressBox:__tostring()
	data = data or {}		data = data or {}
	local root = mw.html.create('~~table~~')		local root = mw.html.create('div')

	-- Base classes and styles		-- Base classes and styles
	root		root
	:addClass('~~infobox~~')		:addClass('maint-cat-progress')
	:~~css~~(~~'float',~~ self.~~_float~~)		:addClass(self._float_class)
	:css('clear', self._float)
	:css('margin', self._margin)
	:css('width', '22em')

	-- Header row		-- Header row
	root:tag('~~tr'):tag('th~~')		root:tag('div')
			:addClass('maint-cat-progress-header')
	:attr('colspan', 2)
	:css('background', '#ddf')
	:css('padding', '0.2em')
	:css('font-size', '125%')
	:wikitext(self._header)		:wikitext(self._header)

	-- Refresh row		-- Refresh row
	root:tag('~~tr'):tag('td~~')		root:tag('div')
			:addClass('maint-cat-progress-refresh')
	:attr('colspan', 2)
	:css('text-align', 'center')
	:wikitext(makePurgeLink{self:message('purge-link-display')})		:wikitext(makePurgeLink{self:message('purge-link-display')})

	-- Subtotals		-- Subtotals
	local subtotalTable = ~~root~~		local subtotalTable = mw.html.create('table')
⚫	:tag('tr')
	:tag('td')
	:attr('colspan', 2)
	:css('padding', 0)
	:tag('table')
⚫	:addClass('collapsible')
⚫	:addClass(self:isCollapsed() and 'collapsed' or nil)
	:css('width', '100%')
	:css('margin', 0)
	subtotalTable		subtotalTable
		⚫	:addClass('maint-cat-progress-subtotals mw-collapsible')
	:tag('tr')
		⚫	:addClass(self:isCollapsed() and 'mw-collapsed' or nil)
	:tag('th')
	:~~attr~~('~~colspan~~'~~, 2~~)		:tag('caption')
	:wikitext(self:message('subtotal-heading'))		:wikitext(self:message('subtotal-heading'))
		⚫
	for i, datedCategoryObj in ipairs(self._datedCategories) do		for i, datedCategoryObj in ipairs(self._datedCategories) do
	subtotalTable		subtotalTable
Line 289:		Line 281:
	:done()		:done()
	:tag('td')		:tag('td')
	:css('text-align', 'right')
	:wikitext(datedCategoryObj:getFormattedCount())		:wikitext(datedCategoryObj:getFormattedCount())
	end		end
Line 302:		Line 293:
	:done()		:done()
	:tag('td')		:tag('td')
	:css('text-align', 'right')
	:wikitext(self._baseCategoryObj:getFormattedCount())		:wikitext(self._baseCategoryObj:getFormattedCount())
			:allDone()

	-- Total		-- Total
	root		root
	:~~tag~~(~~'tr'~~)		:node(subtotalTable)
	:~~css~~('~~font-size', '110%~~')		:tag('div')
			:addClass('maint-cat-progress-total-row')
	:tag('td')
		⚫	:tag('div')
⚫	:wikitext(~~string.format("'''%s'''",~~ self:makeTotalLabel()))
			:addClass('maint-cat-progress-total-label')
		⚫	:wikitext(self:makeTotalLabel())
	:done()		:done()
	:tag('td')		:tag('div')
	:~~css~~('~~text~~-~~align', 'right~~')		:addClass('maint-cat-progress-total')
	:wikitext(~~string.format~~(		:wikitext(self:getFormattedTotalCount())
	"'''%s'''",
	self:getFormattedTotalCount()
⚫	))

	return ~~tostring~~(~~root~~)		return mw.getCurrentFrame():extensionTag{
			name = 'templatestyles', args = {src = 'Module:Progress box/styles.css'}
			} .. tostring(root)
	end		end

Frietjes: fix use of navbox classes outside of navbox (should be the same as navbox-abovebelow)

2021-11-11T17:43:21Z

fix use of navbox classes outside of navbox (should be the same as navbox-abovebelow)

← Previous revision		Revision as of 17:43, 11 November 2021
Line 253:		Line 253:
	root:tag('tr'):tag('th')		root:tag('tr'):tag('th')
	:attr('colspan', 2)		:attr('colspan', 2)
	:~~addClass~~('~~navbox-title~~')		:css('background', '#ddf')
	:css('padding', '0.2em')		:css('padding', '0.2em')
	:css('font-size', '125%')		:css('font-size', '125%')

Mr. Stradivarius: add "count" parameter to allow counting subcats or files

2016-01-20T10:45:36Z

add "count" parameter to allow counting subcats or files

← Previous revision		Revision as of 10:45, 20 January 2016
Line 34:		Line 34:
	local self = setmetatable({}, Category)		local self = setmetatable({}, Category)
	self._cfg = data.cfg		self._cfg = data.cfg
			self._whatToCount = data.whatToCount
	self:setCategory(data.category)		self:setCategory(data.category)
	return self		return self
Line 54:		Line 55:
	function Category:getCount()		function Category:getCount()
	if not self._count then		if not self._count then
	~~self._count~~ = mw.site.stats.pagesInCategory(self:getCategory(), '~~pages~~')		local counts = mw.site.stats.pagesInCategory(self:getCategory(), '*')
			self._count = counts[self._whatToCount or 'pages']
			if not self._count then
			error("the count type must be one of 'pages', 'subcats', 'files' or 'all'")
			end
	end		end
	return self._count		return self._count
Line 143:		Line 148:
	local cfg = self._cfg		local cfg = self._cfg
	local baseCategory = args[2] or self._baseCategoryObj:getCategory()		local baseCategory = args[2] or self._baseCategoryObj:getCategory()
			local whatToCount = args.count
	local from = args.from or self:message('dated-category-format-from')		local from = args.from or self:message('dated-category-format-from')
	local suffix = args.suffix		local suffix = args.suffix
Line 152:		Line 158:
	cfg = cfg,		cfg = cfg,
	baseCategory = baseCategory,		baseCategory = baseCategory,
			whatToCount = whatToCount,
	from = from,		from = from,
	suffix = suffix,		suffix = suffix,

Mr. Stradivarius: fix base category name bug

2015-05-18T02:20:59Z

fix base category name bug

← Previous revision		Revision as of 02:20, 18 May 2015
Line 130:		Line 130:

	-- Make the base category object		-- Make the base category object
		⚫	if not args[1] then
	do
		⚫	error('no base category specified', 3)
	local baseCategory = args[2] or args[1]
⚫	if not ~~baseCategory~~ then
⚫	error('no category specified', 3)
	end
⚫	self._baseCategoryObj = Category.new{
⚫	cfg = self._cfg,
⚫	category = ~~baseCategory~~,
	}
	end		end
		⚫	self._baseCategoryObj = Category.new{
		⚫	cfg = self._cfg,
		⚫	category = args[1],
			}

	-- Make datedCategory objects		-- Make datedCategory objects
Line 145:		Line 142:
	do		do
	local cfg = self._cfg		local cfg = self._cfg
	local baseCategory = self._baseCategoryObj:getCategory()		local baseCategory = args[2] or self._baseCategoryObj:getCategory()
	local from = args.from or self:message('dated-category-format-from')		local from = args.from or self:message('dated-category-format-from')
	local suffix = args.suffix		local suffix = args.suffix

Mr. Stradivarius: Protected Module:Progress box: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

2015-05-17T23:29:43Z

Protected Module:Progress box: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))

← Previous revision	Revision as of 23:29, 17 May 2015
(No difference)

Mr. Stradivarius: use baseCategory instead of undatedCategory, as this is closer to its true purpose; also, use "label" for category display messages

2015-05-17T02:22:21Z

use baseCategory instead of undatedCategory, as this is closer to its true purpose; also, use "label" for category display messages

← Previous revision		Revision as of 02:22, 17 May 2015
Line 84:		Line 84:
	local category = self:message(		local category = self:message(
	'dated-category-format',		'dated-category-format',
	data.~~undatedCategory~~,		data.baseCategory,
	self._formattedDate,		self._formattedDate,
	data.from or self:message('dated-category-format-from'),		data.from or self:message('dated-category-format-from'),
Line 129:		Line 129:
	self._frame = mw.getCurrentFrame()		self._frame = mw.getCurrentFrame()

	-- Make the ~~undated~~ category object		-- Make the base category object
	do		do
	local ~~undatedCategory~~ = args[2] or args[1]		local baseCategory = args[2] or args[1]
	if not ~~undatedCategory~~ then		if not baseCategory then
	error('no category specified', 3)		error('no category specified', 3)
	end		end
	self.~~_undatedCategoryObj~~ = Category.new{		self._baseCategoryObj = Category.new{
	cfg = self._cfg,		cfg = self._cfg,
	category = ~~undatedCategory~~,		category = baseCategory,
	}		}
	end		end
Line 145:		Line 145:
	do		do
	local cfg = self._cfg		local cfg = self._cfg
	local ~~undatedCategory~~ = self.~~_undatedCategoryObj~~:getCategory()		local baseCategory = self._baseCategoryObj:getCategory()
	local from = args.from or self:message('dated-category-format-from')		local from = args.from or self:message('dated-category-format-from')
	local suffix = args.suffix		local suffix = args.suffix
Line 154:		Line 154:
	local datedCategoryObj = DatedCategory.new{		local datedCategoryObj = DatedCategory.new{
	cfg = cfg,		cfg = cfg,
	~~undatedCategory~~ = ~~undatedCategory~~,		baseCategory = baseCategory,
	from = from,		from = from,
	suffix = suffix,		suffix = suffix,
Line 175:		Line 175:
	allCategory = self:message(		allCategory = self:message(
	'all-articles-category-format',		'all-articles-category-format',
	self.~~_undatedCategoryObj~~:getCategory()		self._baseCategoryObj:getCategory()
	)		)
	allCategory = self._frame:preprocess(allCategory)		allCategory = self._frame:preprocess(allCategory)
Line 213:		Line 213:

	function ProgressBox:makeTotalLabel()		function ProgressBox:makeTotalLabel()
	local display = self:message('all-articles-~~heading~~')		local display = self:message('all-articles-label')
	if self._allCategoryObj:exists() then		if self._allCategoryObj:exists() then
	return self._allCategoryObj:makeCategoryLink(display)		return self._allCategoryObj:makeCategoryLink(display)
Line 226:		Line 226:
	count = count + obj:getCount()		count = count + obj:getCount()
	end		end
	count = count + self.~~_undatedCategoryObj~~:getCount()		count = count + self._baseCategoryObj:getCount()
	return count		return count
	end		end
Line 293:		Line 293:
	:tag('tr')		:tag('tr')
	:tag('td')		:tag('td')
	:wikitext(self.~~_undatedCategoryObj~~:makeCategoryLink(		:wikitext(self._baseCategoryObj:makeCategoryLink(
	self:message('undated-~~category~~-~~link-display~~')		self:message('undated-articles-label')
	))		))
	:done()		:done()
	:tag('td')		:tag('td')
	:css('text-align', 'right')		:css('text-align', 'right')
	:wikitext(self.~~_undatedCategoryObj~~:getFormattedCount())		:wikitext(self._baseCategoryObj:getFormattedCount())

	-- Total		-- Total

Mr. Stradivarius: use a setter for category names to better preserve encapsulation, and use a better fallback for DatedCategory's "for" argument

2015-05-17T02:06:31Z

use a setter for category names to better preserve encapsulation, and use a better fallback for DatedCategory's "for" argument

← Previous revision		Revision as of 02:06, 17 May 2015
Line 34:		Line 34:
	local self = setmetatable({}, Category)		local self = setmetatable({}, Category)
	self._cfg = data.cfg		self._cfg = data.cfg
	self~~._category =~~ data.category		self:setCategory(data.category)
	return self		return self
			end

			function Category:setCategory(category)
		⚫	self._category = category
	end		end

Line 77:		Line 81:
	self._dateFormat = data.dateFormat or self:message('date-format')		self._dateFormat = data.dateFormat or self:message('date-format')
	self._formattedDate = self:formatDate(self._date)		self._formattedDate = self:formatDate(self._date)
			do
⚫	self._category = ~~self:message(~~
	~~'dated-~~category~~-format',~~		local category = self:message(
			'dated-category-format',
	data.undatedCategory,		data.undatedCategory,
	self._formattedDate,		self._formattedDate,
⚫	data.~~from~~ or '',
	data.~~suffix~~ or ''		data.from or self:message('dated-category-format-from'),
		⚫	data.suffix or ''
	)
			)
	~~self._category~~ = ~~self._category~~:match('^%s(.-)%s$') -- trim whitespace		category = category:match('^%s(.-)%s$') -- trim whitespace
			self:setCategory(category)
			end
	return self		return self
	end		end

Mr. Stradivarius: don't use the "all" category to find the total count, as counting the subcategories should be more accurate and requires less expensive function calls

2015-05-16T05:28:13Z

don't use the "all" category to find the total count, as counting the subcategories should be more accurate and requires less expensive function calls

@@ Line 215: / Line 215: @@
 function ProgressBox:getTotalCount()
 	end
 end

Mr. Stradivarius: add the subtotal heading

2015-05-16T05:22:21Z

add the subtotal heading

← Previous revision		Revision as of 05:22, 16 May 2015
Line 268:		Line 268:
	:css('width', '100%')		:css('width', '100%')
	:css('margin', 0)		:css('margin', 0)
			subtotalTable
			:tag('tr')
			:tag('th')
			:attr('colspan', 2)
			:wikitext(self:message('subtotal-heading'))
	for i, datedCategoryObj in ipairs(self._datedCategories) do		for i, datedCategoryObj in ipairs(self._datedCategories) do
	subtotalTable		subtotalTable