Модуль:NumberOf

З пляцоўкі Вікіпедыя
Jump to navigation Jump to search
(i) Дакументацыя

Дадзены модуль выкарыстоўваецца для паказу і абнаўлення статыстыкі на старонцы Спіс Вікіпедый. Падстаронкі з дадзенымі гэтага модуля перыядычна абнаўляюцца ботам MBHbot. Калі ласка, не праўце модуль самастойна!

Выкарыстанне

  • {{#invoke:NumberOf|Editions}} — вывад спісу Вікіпедый па мовах, з поўнай статыстыкай.
  • {{#invoke:NumberOf|Today|wiki=en|param=articles}} — вывад колькасці артыкулаў канкрэтнага моўнага раздзелу Вікіпедыі (нефарматаванае значэнне). Прыклад: у Англійскай Вікіпедыі налічваецца 6113143 артыкулаў.
  • {{#invoke:NumberOf|Today|wiki=en|param=articles|fmt=N}} — Той жа параметр (фарматаванае значэнне). Прыклад: у Англійскай Вікіпедыі налічваецца 6 113 143 артыкулаў.

Канкрэтны моўны раздзел Вікіпедыі пазначаецца функцыяй wiki (абавязковая функцыя) і кодам мовы. Напрыклад у кодах вышэй прысутнічае функцыя wiki=en, дзе en — код Англійскай Вікіпедыі. Змяняючы апошні можна паказваць статыстыку любога моўнага раздзела. Коды для ўсіх моўных раздзелаў можна знайсці ў спісе Вікіпедый

Функцыя Today у кодах вышэй паказае статыстыку раздзелаў па стане на 0:00 (UTC) сённяшняй даты, інфармацыя бярэцца з падстаронкі NumberOf/today, якая абнаўляецца раз у суткі ботам MBHbot. Па тым жа прынцыпе можна адлюстроўваць больш актуальную статыстыку на дадзены момант, для гэтага патрэбна змяніць функцыю Today на функцыю Now, апошняя будзе выводзіць інфармацыю з падстаронкі NumberOf/data, якая абнаўляецца ботам раз у 2 гадзіны. Калі ласка, не праўце модулі самастойна! Пры неабходнасці зменаў звярніцеся на старонку размоў дадзенага модуля.

Увага! Беларускі раздзел Вікіпедыі праз дадзены модуль таксама абнаўляецца раз у дзве гадзіны. Але для яго існуе статыстыка ў рэальным часе, каб яе выкарыстаць, скарыстайцеся шаблонам NUMBEROF.

Функцыі

Коды вышэй, якія паказваюць колькасць артыкулаў, па тым жа прынцыпе могуць адлюстроўваць іншыя паказчыкі канкрэтнага моўнага раздзела, для гэтага дастаткова змяніць у кодзе функцыю articles на адну з наступных:

  • admins — колькасць адміністратараў,
  • activeusers — колькасць актыўных удзельнікаў,
  • date — дата абнаўлення дадзеных у модулі,
  • depth — глыбіня раздзела,
  • edits — колькасць правак у раздзеле,
  • files — колькасць файлаў,
  • pages — колькасць старонак,
  • pos — месца раздзела па колькасці артыкулаў (гл. спіс Вікіпедый),
  • users — колькасць удзельнікаў.


Каб пазбегнуць паломак старонак, якія выкарыстоўваюць гэты модуль, пажадана эксперыментаваць у пясочніцы для модуляў.


-- Модуль для выкарыстання серыі NUMBEROF і старонкі [[Вікіпедыя:Спіс Вікіпедый]]
local p = {}

-- Важнейшыя пераменныя
local mwlang = mw.getContentLanguage()
local langs = mw.loadData('Модуль:NumberOf/lang')

-- Раздзелы Вікіпедыі закрытыя для рэдагавання
local readOnly = {
	aa = true,
	cho = true,
	ho = true,
	hz = true,
	ii = true,
	kj = true,
	kr = true,
	mh = true,
	mus = true,
	ng = true
}

-- Праверка пустэчы параметра
local function isEmpty(s)
	return s == nil or s == ''
end

-- Акругленне да сотых
local function round(n)
	return math.floor(n * 100) / 100
end

-- Фарміраванне даты
local function formatDate(val)
	return mwlang:formatDate('j xg Y, G:i', val) .. ' (UTC)'
end

-- Даўжыня табліцы
local function tableLength(t)
	local count = 0
	for _ in pairs(t) do count = count + 1 end
	return count
end

-- Рэндэрынг неабходнага параметра з старонкі з дадзенымі
local function renderNum(f, info)
	-- Парсінг параметраў шаблона
	local wiki = f.wiki
	local param = f.param
	local fmt = f.fmt
	
	-- Калі няма абавязковых параметраў, выводзіцца нуль
	local result
	if isEmpty(wiki) or isEmpty(param) then
		result = 0
	else
		if param == 'date' then
			result = formatDate(info['total']['date'])
			return result
		end
		
		-- Разлікі для агульнай колькасці раздзелаў
		if wiki == 'total' then
			if param == 'all' then
				result = tableLength(info) - 1
			end
			if param == 'active' then
				result = tableLength(info) - 1 - tableLength(readOnly)
			end
		end
		
		local obj = info[wiki]
		if obj ~= nil then
			-- Прыбіраем NUMBEROF з легасі-кода параметраў
			param = param:lower():gsub('numberof','')
			
			if param ~= nil and info[wiki][param] ~= nil then
				result = info[wiki][param]
				
				-- Фарматуем значэнне, калі зададзены параметр
				if not isEmpty(fmt) and type(result) == 'number' then
					if param == 'depth' then
						result = math.floor(result * 100) / 100
					end
					result = mwlang:formatNum(result)
				end
			end
		else
			result = 0
		end
	end
	return tostring(result)
end

-- Вывад спасылкі на моўны раздзел
local function renderLink(val, text)
	local text = (isEmpty(text) and val or text)
	
	local result = ''
	if val ~= mwlang:getCode() then
		result = result .. '[[:' .. val ..  ':|'
		
		if readOnly[val] == true then
			result = result .. '<span style="color:#222; text-decoration:inherit; -moz-text-decoration-color:#222; text-decoration-color:#222;"><s title="Дадзены раздзел закрыты, і даступны толькі ў рэжыме для чытання">' .. text .. '</s></span>'
		else
			result = result .. text
		end
		
		result = result .. ']]'
	else
		result = result .. text
	end
	return result
end

-- Вывад назвы мовы
local function renderLang(val, frame)
	local text = ''
	local result = ''
	local hasArticle = false
	if not isEmpty(langs[val]) then
		text = langs[val][1]
		if not isEmpty(langs[val][2]) then
			result = '[[' .. langs[val][2] .. '|'
			hasArticle = true
		else
			result = frame:expandTemplate{
				title = 'Каляровая спасылка',
				args = { '#222', string.format('%s:', val), text }
			}
		end
	else
		text = mwlang:ucfirst(mw.language.fetchLanguageName(val))
		result = frame:expandTemplate{
			title = 'Каляровая спасылка',
			args = { '#222', string.format('%s:', val), text }
		}
	end

	if readOnly[val] == true then
		result = frame:expandTemplate{
			title = 'Каляровая спасылка',
			args = { '#222', string.format('%s:', val), '<span title="Дадзены раздзел закрыты, і даступны толькі ў рэжыме для чытання">' .. text .. '</s>' }
		}
		result = '<s>' .. result .. '</s>'
	end

	if hasArticle then
		result = result .. text .. ']]'
	end
	
	if val == mwlang:getCode() then
		result = result .. '<span class="nomobile" style="margin-left:4px;">[[File:Mw-unwatch-icon.svg|16px|text-top|alt=★|link=]]</span>'
	end
	
	return result
end

-- Функцыя для вываду ячэйкі
local function createCell(val, style, fmt, stats, frame)
	local result = '|'
	if not isEmpty(fmt) then
		result = result .. 'data-sort-value="' .. val .. '" '
	end
	result = result .. 'style="border:0; ' .. (not isEmpty(style) and style or 'padding:4px 24px 4px 0;') .. '"| '
	
	if not isEmpty(stats) then
		result = result .. frame:expandTemplate{
			title = 'Каляровая спасылка',
			args = { '#222', stats, (not isEmpty(fmt) and mwlang:formatNum(val) or val) }
		}
	else
		result = result .. (not isEmpty(fmt) and mwlang:formatNum(val) or val) .. ' '
	end
	
	return result
end

-- Функцыя для вываду радка табліцы
local function createRow(key, val, frame)
	local result = '|- style="'
	local style, originalStyle = ''
	if key == mwlang:getCode() then
		result = result .. 'font-weight:bold; '
		style = 'background:#d5fdf4; '
		originalStyle = style .. 'padding:4px 24px 4px 0;'
	end
	result = result .. 'text-align:right; vertical-align:top;"\n'
	
	result = result .. createCell(val['pos'], style .. 'font-weight:normal; padding:4px 24px 4px 0;')
					.. '|' .. createCell(renderLink(key), style .. 'font-weight:normal; padding:4px 24px 4px 0; white-space:nowrap;')
					.. '|' .. createCell(renderLang(key, frame), style .. 'padding:4px 24px 4px 0; text-align:left;')
					.. '|' .. createCell(val['articles'], originalStyle, true, key .. ':' .. 'Special:Statistics', frame)
					.. '|' .. createCell(val['pages'], originalStyle, true)
					.. '|' .. createCell(val['edits'], originalStyle, true)
					.. '|' .. createCell(round(val['depth']), originalStyle, true)
					.. '|' .. createCell(val['users'], originalStyle, true, key .. ':' .. 'Special:ListUsers', frame)
					.. '|' .. createCell(val['activeusers'], originalStyle, true, key .. ':' .. 'Special:ActiveUsers', frame)
					.. '|' .. createCell(val['admins'], originalStyle, true, key .. ':' .. 'Special:ListAdmins', frame)
					.. '|' .. createCell(val['files'], originalStyle, true)
	
	return result .. '\n'
end

-- Функцыя для вываду шапкі табліцы
local function createHeader()
	local cell = 'background-color:transparent; padding-bottom:2px; padding-right:24px;'
	local cellLang = 'background-color:transparent; padding-bottom:2px; text-align:left; width:25%;'
	
	local result = '\n{| class="mw-datatable sortable" style="border:0; font-feature-settings:\'tnum\' 1; margin:4px 0 0; width:100%;"\n'
				.. '|- style="border-bottom:1px solid #a2a9b1; text-align:right;"\n'
				.. '!style="border:0; ' .. cell .. '"| №'
				.. '|' .. createCell('Код', cell)
				.. '|' .. createCell('Мова', cellLang)
				.. '|' .. createCell('Артыкулаў', cell)
				.. '|' .. createCell('Старонак', cell)
				.. '|' .. createCell('Правак', cell)
				.. '|' .. createCell('<abbr title="Глыбіня">Глыб.</abbr>', cell)
				.. '|' .. createCell('Удзельнікаў', cell)
				.. '|' .. createCell('(<abbr title="Актыўных удзельнікаў">акт.</abbr>)', cell)
				.. '|' .. createCell('<abbr title="Адміністратараў">Адм.</abbr>', cell)
				.. '|' .. createCell('Файлаў', cell)
	
	return result .. '\n'
end

-- Функцыя для вываду дна табліцы
local function createFooter(frame, hide)
	-- Параметр hide адказвае за аптычнае выраўнованне табліц
	local val = frame['total']
	local cell = 'background:transparent; padding-right:24px; ' .. (hide and '' or 'padding-top:2px;')
	local cellHide = 'padding-right:24px;'  .. (hide and '' or ' padding-top:2px;') .. ' visibility:hidden; white-space:nowrap;'
	
	-- aa — закрыты раздзел з самай вялікай глыбінёй
	local num = tableLength(frame) - 1
	local depth = (hide and round(frame['aa']['depth']) or round(val['depth']))
	local result = '\n|- style="border-top:1px solid; font-weight:bold; text-align:right; vertical-align:top;'
				.. (hide and ' line-height:0; visibility:hidden; border-top-color:transparent;' or ' border-top-color:#a2a9b1;') .. '"'
				.. (hide and ' class="nomobile"' or '') .. '\n'
				.. '!style="border:0; ' .. cellHide .. '"| ' .. num
	
	-- zh-classical — самая доўгая назва раздзела
	result = result .. '|' .. createCell('zh-classical', cellHide)
					.. '|' .. createCell('Усяго', cell .. ' text-align:left;')
					.. '|' .. createCell(val['articles'], cell, true)
					.. '|' .. createCell(val['pages'], cell, true)
					.. '|' .. createCell(val['edits'], cell, true)
					.. '|' .. createCell(depth, cell, true)
					.. '|' .. createCell(val['users'], cell, true)
					.. '|' .. createCell(val['activeusers'], cell, true)
					.. '|' .. createCell(val['admins'], cell, true)
					.. '|' .. createCell(val['files'], cell, true)
	
	return result
end

-- Функцыя для вываду ў {{NUMBEROF}}
function p.Now(frame)
	local data = mw.loadData('Модуль:NumberOf/data')
	
	return renderNum(frame.args, data)
end

-- Функцыя для вываду ў {{TODAYNUMBEROF}}
function p.Today(frame)
	local data = mw.loadData('Модуль:NumberOf/today')
	
	return renderNum(frame.args, data)
end

-- Функцыя для вываду ў [[Вікіпедыя:Спіс Вікіпедый]]
function p.Editions(frame)
	local data = mw.loadData('Модуль:NumberOf/today')
	local length = tableLength(data)
	local result = ''
	
	-- Таблица для збору раздзелаў па велічыні
	local sorted = {
		[1000000] = {},
		[100000] = {},
		[10000] = {},
		[1000] = {},
		[0] = {}
	}
	local sortedKeys = { 0, 1000, 10000, 100000, 1000000 }
	
	-- Запаўняем пустымі элементамі кожную табліцу
	for i = #sortedKeys, 1, -1 do
		local n = sortedKeys[i]
		for j = 1, length, 1 do
			table.insert(sorted[n], false)
		end
	end
	
	-- Сартаванне раздзелаў па пазіцыі і велічыні
	for key, val in pairs(data) do
		local curr = data[key]
		if key ~= 'total' then
			if curr['articles'] <= 1000 then
				sorted[ 0 ][ tonumber(curr['pos']) ] = key
			else
				for i = #sortedKeys, 2, -1 do
					local n = sortedKeys[i]
					if curr['articles'] / n > 1 then
						sorted[ n ][ tonumber(curr['pos']) ] = key
						break
					end
				end
			end
		end
	end
	
	-- Вывад табліцы
	for i = #sortedKeys, 1, -1 do
		if i ~= #sortedKeys then
			result = result .. '\n'
		end
		
		local n = sortedKeys[i]
		if n == 0 then 
			result = result .. '=== Меньш за 1 000 артыкулаў ==='
		else
			result = result .. string.format('=== Больш за %s артыкулаў ===', mwlang:formatNum(n))
		end
		
		-- Аўтаматычны скрол для недастаткова шырокіх манітораў
		result = result .. '\n<div style="overflow-x:auto; overflow-y:hidden;">\n' .. createHeader()

		-- Вывад радоў табліцы
		for _, val in ipairs(sorted[n]) do
			if val ~= false then
				local curr = data[val]
				result = result .. createRow(val, curr, frame)
			end
		end
		
		-- Вывад дна табліцы
		result = result .. createFooter(data, (n ~= 0))
		result = result .. '\n|}\n</div>'
	end
	
	return result
end

return p