Module:Random portal component/sandbox: Difference between revisions

Browse history interactively

← Previous edit Next edit →

Content deleted Content added

Inline

Revision as of 05:50, 2 May 2019

This is the module sandbox page for Module:Random portal component (diff).

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 module depends on the following other modules:

Module:Random (sandbox)

This module implements {{random portal component}}. Please see the template page for documentation.

-- This module implements [[Template:Random portal component]]

local p = {}

local mRandom = require('Module:Random')
local currentTitle = mw.title.getCurrentTitle()

local portalNamesContainingSlashes = {
	["AC/DC"] = true,
}

local function isSelectedHeader(header)
	-- Whether a page is selected (a selected article, selected list, etc.).
	-- The "'*" part of the pattern checks for italic or bold text, like
	-- ''Selected'' or '''Selected'''.
	return string.find(header, "^'*[sS]elected") ~= nil
end

local function isInPortalNamespace(title)
	-- Whether a title object is in the portal namespace.
	return title.namespace == 100
end

local function isPortalSubpage(title)
	-- Whether a title object is a portal subpage
	return (
		isInPortalNamespace(title)
		and title.isSubpage
		and not portalNamesContainingSlashes[title.text]
	)
end

local function isRootPortalTitle(title)
	-- Whether a title object is for a root portal page.
	return isInPortalNamespace(title) and not isPortalSubpage(title)
end

local function subPageTrackingCategories(pages, max, header)
	local retval = "";
	local availableSubPageCount = 0;
	local i;

	-- Only track root portal pages that have "Selected x" sections.
	if not isSelectedHeader(header) or not isRootPortalTitle(title) then
		return ""
	end

	-- limit checking to prevent Lua overload
	local myMaxCheck = 60
	if tonumber(max) < myMaxCheck then
		myMaxCheck = tonumber(max)
	end
	for i=1,myMaxCheck do 
		local aSubPage = mw.title.new(pages.subpage .. '/' .. i)
		if (aSubPage.exists) then
			availableSubPageCount = availableSubPageCount + 1;
		end
	end
	if myMaxCheck >= tonumber(max) then
		if (availableSubPageCount < tonumber(max)) then
			retval = retval .. "[[Category:Random portal component with fewer available subpages than specified max]]"
		elseif (availableSubPageCount > tonumber(max)) then
			retval = retval .. "[[Category:Random portal component with more available subpages than specified max]]"
		end
	end
	if (availableSubPageCount < 2) then
		retval = retval .. "[[Category:Random portal component with less than 2 available  subpages]]"
	elseif (availableSubPageCount <= 5) then
		retval = retval .. "[[Category:Random portal component with 2–5 available  subpages]]"
	elseif (availableSubPageCount <= 10) then
		retval = retval .. "[[Category:Random portal component with 6–10 available  subpages]]"
	elseif (availableSubPageCount <= 15) then
		retval = retval .. "[[Category:Random portal component with 11–15 available  subpages]]"
	elseif (availableSubPageCount <= 20) then
		retval = retval .. "[[Category:Random portal component with 16–20 available subpages]]"
	elseif (availableSubPageCount <= 25) then
		retval = retval .. "[[Category:Random portal component with 21–25 available subpages]]"
	elseif (availableSubPageCount <= 30) then
		retval = retval .. "[[Category:Random portal component with 26–30 available subpages]]"
	elseif (availableSubPageCount <= 40) then
		retval = retval .. "[[Category:Random portal component with 31–40 available subpages]]"
	elseif (availableSubPageCount <= 50) then
		retval = retval .. "[[Category:Random portal component with 41–50 available subpages]]"
	else
		retval = retval .. "[[Category:Random portal component with over 50 available subpages]]"
	end
	return retval;
end

local function getRandomNumber(max)
	-- gets a random integer between 1 and max; max defaults to 1
	return mRandom.number{max or 1}
end

local function expandArg(args, key)
	-- Emulate how unspecified template parameters appear in wikitext. If the
	-- specified argument exists, its value is returned, and if not the argument
	-- name is returned inside triple curly braces.
	local val = args[key]
	if val then
		return val
	else
		return string.format('{{{%s}}}', key)
	end
end

local function getPages(args)
	local pages = {}
	pages.root = args.rootpage or currentTitle.prefixedText
	pages.subpage = pages.root .. '/' .. expandArg(args, 'subpage')
	pages.random = pages.subpage .. '/' .. getRandomNumber(args.max)
	pages.footer = 'Template:Box-footer'
	return pages
end

local function tryExpandTemplate(frame, title, args)
	local success, result = pcall(frame.expandTemplate, frame, {title = title, args = args})
	if success then
		return result
	else
		local msg = string.format(
			'<strong class="error">The page "[[%s]]" does not exist.</strong>',
			title
		)
		if isRootPortalTitle(currentTitle) then
			msg = msg .. '[[Category:Portals needing attention]]'
		end
		return msg
	end
end

local function getHeader(frame, pages, header, template)
	return tryExpandTemplate(
		frame,
		template or pages.root .. '/box-header',
		{header, pages.random}
	)
end

local function getRandomSubpageContent(frame, pages)
	return tryExpandTemplate(
		frame,
		pages.random
	)
end

local function getFooter(frame, pages, link)
	return tryExpandTemplate(
		frame,
		pages.footer,
		{link}
	)
end

function p._main(args, frame)
	frame = frame or mw.getCurrentFrame()
	local pages = getPages(args)

	local ret = {}
	ret[#ret + 1] = getHeader(frame, pages, args.header or 'subpage', args.headertemplate)
	ret[#ret + 1] = getRandomSubpageContent(frame, pages)
	if not args.footer or not args.footer:find('%S') then
		ret[#ret + 1] = '<div style="clear:both;"></div></div>'
	else
		ret[#ret + 1] = getFooter(frame, pages, string.format(
			'[[%s|%s]]',
			pages.subpage,
			expandArg(args, 'footer')
		))
	end

	return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header)
end

function p._nominate(args, frame)
	frame = frame or mw.getCurrentFrame()
	local pages = getPages(args)

	local ret = {}
	ret[#ret + 1] = getHeader(frame, pages, expandArg(args, 'header'), args.headertemplate)
	ret[#ret + 1] = getRandomSubpageContent(frame, pages)
	ret[#ret + 1] = getFooter(frame, pages, string.format(
		'[[/Nominate/%s|Suggest]] • [[%s|%s]] ',
		expandArg(args, 'subpage'),
		pages.subpage,
		args.footer or 'Archive'
	))

	return table.concat(ret, '\n') .. subPageTrackingCategories(pages, args.max, args.header)
end

local function makeInvokeFunction(func)
	return function (frame)
		local args = require('Module:Arguments').getArgs(frame, {
			trim = false,
			removeBlanks = false,
			wrappers = {
				'Template:Random portal component',
				'Template:Random portal component/BHG-test',
				'Template:Random portal component with nominate'
			}
		})
		return func(args, frame)
	end
end

p.main = makeInvokeFunction(p._main)
p.nominate = makeInvokeFunction(p._nominate)

return p

v t e Portal templates
Visual overview of template usage
Layout and formatting	{{Box portal skeleton}} {{Box-header}} color palettes plain round square watch {{Box-header colour}}^[1] {{Box-footer}} {{Flex columns}} {{Plain navboxes}}
Content transclusion	{{Transclude lead excerpt}}^[2] {{Transclude linked excerpt}}^[2] {{Transclude list item excerpt}}^[2] {{Transclude random excerpt}}^[2] {{Transclude selected excerpt}}^[2] {{Excerpt}} {{Transclude DYK}}^[9] {{Transclude selected current events}}^[3] {{Transclude selected recent additions}}^[4]
Content slideshows	{{Random slideshow}}^[5] {{Transclude files as random slideshow}}^[5] {{Transclude excerpts as random slideshow}}^[6] {{Transclude linked excerpts as random slideshow}}^[6] {{Transclude list item excerpts as random slideshow}}^[6]
Content randomisation	{{Random portal component}}^[7] {{Random quotation}} {{Random subpage}}
General	{{Portals}} {{Portals browsebar}} {{Portal description}} {{Portal information sidebar}} {{Portal navbar no header2}} {{Purge link portals}} {{Wikimedia for portals}}
Linking templates	{{Portal}}^[11] {{Portal bar}}^[12] {{Portal-inline}}^[13] {{Pbox}} {{Related portals2}}
Talk pages / Maintenance	{{Portal talk}} {{Portal maintenance status}}^[8] {{Portal suggestions}} {{Portal toolbox}} {{WikiProject Portals}}^[8]
Images	{{Portal dynamic image}} {{Portal image banner}}^[10] {{Portal pictures}}^[14] {{Portal POTD}}
Modules	1. Module:Box-header 2. Module:Excerpt/portals 3. Module:Selected current events 4. Module:Selected recent additions 5. Module:Random slideshow 6. Module:Excerpt slideshow 7. Module:Random portal component 8. Module:Portal maintenance status 9. Module:Transclude DYK 10. Module:Portal image banner 11. Module:Portal 12. Module:Portal bar 13. Module:Portal-inline 14. Module:Portal pictures
Usage	Wikipedia:Portal Wikipedia:WikiProject Portals
For more information, see: Category:Template-Class Portal pages and Category:Wikipedia Portal templates

Revision as of 05:50, 2 May 2019

See also