Module:Community Wishlist

Module documentation

[create]

You might want to create a documentation page for this Scribunto module.
Editors can experiment in this module’s sandbox (create | mirror) and testcases (create) pages.
Please add categories to the /doc subpage. Subpages of this module.

-- Utilities for Community Wishlist

local p = {}

local function getProjectName( frame, value )
	local projectCodes = {
		['wikipedia'] = 'project-localized-name-group-wikipedia',
		['wikidata'] = 'project-localized-name-wikidatawiki',
		['commons'] = 'project-localized-name-commonswiki',
		['wikisource'] = 'project-localized-name-group-wikisource',
		['wiktionary'] = 'project-localized-name-group-wiktionary',
		['wikivoyage'] = 'project-localized-name-group-wikivoyage',
		['wikiquote'] = 'project-localized-name-group-wikiquote',
		['wikiversity'] = 'project-localized-name-group-wikiversity',
		['wikifunctions'] = 'project-localized-name-wikifunctionswiki',
		['wikispecies'] = 'project-localized-name-specieswiki',
		['wikinews'] = 'project-localized-name-group-wikinews',
		['metawiki'] = 'project-localized-name-metawiki',
		['wmcs'] = 'wikimedia-otherprojects-cloudservices',
	}
	if projectCodes[ value ] == nil then
		-- For an unknown project name, show error and add to tracking category.
		return '<span class="error">Unknown: "' .. value .. '"</span>'
			.. '[[Category:Community Wishlist/Wishes with unknown project names]]'
	end
	return mw.message.new( projectCodes[ value ] ):plain()
end

function p.csvToProjectNames( frame )
	local csv = mw.text.trim( frame.args[ 1 ] )
	if csv == '' then
		return ''
	end
	local list = mw.text.split( csv, ",", true )
	local out = {}
	for _, value in ipairs( list ) do
		local project = mw.text.trim( value )
		-- Return early if one of the values is 'all'.
		if project == 'all' then
			return frame:expandTemplate{ title = 'Community Wishlist/All projects' }
		end
		table.insert( out, getProjectName( frame, project ) )
	end
	local listSep = mw.message.new( 'comma-separator' ):plain() .. mw.message.new( 'word-separator' ):plain();
	return table.concat( out, listSep )
end

function p.csvToPhabLinks( frame )
	local csv = mw.text.trim( frame.args[ 1 ] )
	if csv == '' then
		return ''
	end
	local list = mw.text.split( csv, ",", true )
	local out = {}
	for _, id in ipairs( list ) do
		table.insert( out, '[[phab:' .. id .. '|' .. id .. ']]' )
	end
	return table.concat( out, mw.message.new( 'comma-separator' ):plain() .. mw.message.new( 'word-separator' ):plain() )
end

-- Get a formatted timestamp of when the given wish or focus area was last updated
function p.lastUpdated( frame )
	local pageType = frame.args[ 1 ] or 'Wishes'
	local slug = frame.args[ 2 ]
	local titleStr = 'Community Wishlist/' .. pageType .. '/' .. slug
	local lastUpdated = ''
	local translatablePage = mw.title.new( titleStr .. '/Translatable' )
	if translatablePage ~= nil and translatablePage.exists then
		lastUpdated = frame:callParserFunction( 'REVISIONTIMESTAMP', titleStr .. '/Translatable' )
	else
		lastUpdated = frame:callParserFunction( 'REVISIONTIMESTAMP', titleStr )
	end
	return frame:callParserFunction( '#time', 'H:i, j F Y', lastUpdated ) .. ' (UTC)'
end

-- Whether to hide a given wish index table column on the current page.
-- This is called from {{Community Wishlist/Wishes/Row}}.
-- @param frame.args.1 The name of the column, either 'area' or 'status'.
-- @return string Non-empty string if the given column should be hidden
function p.hideWishIndexCol( frame )
	local colName = frame.args[ 1 ] or ''
	local titleParts = mw.text.split( mw.title.getCurrentTitle().text, '/' )
	if titleParts[ 2 ] ~= nil and (
		( colName == 'area' and titleParts[ 2 ] == 'Focus areas' )
		or  ( colName == 'status' and titleParts[ 2 ] == 'Archive' )
	) then
		return '1'
	else
		return ''
	end
end

return p