Misplaced Pages

Latest revision as of 10:08, 3 October 2020

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 depends on the following other modules: Module:Random (sandbox)

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

See also

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}} {{Box-footer}} {{Flex columns}} {{Plain navboxes}}
Content transclusion	{{Transclude lead excerpt}} {{Transclude linked excerpt}} {{Transclude list item excerpt}} {{Transclude random excerpt}} {{Transclude selected excerpt}} {{Excerpt}} {{Transclude DYK}} {{Transclude selected current events}} {{Transclude selected recent additions}}
Content slideshows	{{Random slideshow}} {{Transclude files as random slideshow}} {{Transclude excerpts as random slideshow}} {{Transclude linked excerpts as random slideshow}} {{Transclude list item excerpts as random slideshow}}
Content randomisation	{{Random portal component}} {{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}} {{Portal bar}} {{Portal-inline}} {{Pbox}} {{Related portals2}}
Talk pages / Maintenance	{{Portal talk}} {{Portal maintenance status}} {{Portal suggestions}} {{Portal toolbox}} {{WikiProject Portals}}
Images	{{Portal dynamic image}} {{Portal image banner}} {{Portal pictures}} {{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	Misplaced Pages:Portal Misplaced Pages:WikiProject Portals
For more information, see: Category:Template-Class Portal pages and Category:Misplaced Pages Portal templates

-- This module implements ]

local p = {}

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

-- tracking function added by BHG 29/04/2019
-- called as subPageTrackingCategories(pages, args.max)
local function subPageTrackingCategories(pages, max, header)
	local retval = "";
	local thispagetitle = mw.title.getCurrentTitle().text

	-- don't track DYK etc, only selected/featured articles, biogs etc
	if ((string.find(header, "/elected") == -1) and (string.find(header, "/eatured") == -1)) then
		return retval
	end
	-- no tracking unless we are in Portal namespace
	if (mw.title.getCurrentTitle().nsText ~= "Portal") then
		return ""
	end

	-- no tracking if this is a subpage
	if ((mw.ustring.match(thispagetitle, "/") ~= nil) and (thispagetitle ~= "AC/DC")) then
		return retval
	end

	local maxNum = tonumber(max)
	local availableSubPageCount = maxNum

	-- Check for missing subpages at end of alleged number range
	while availableSubPageCount > 0 and not mw.title.new(pages.subpage .. '/' .. tostring(availableSubPageCount)).exists do
		availableSubPageCount = availableSubPageCount - 1
	end
	if availableSubPageCount < maxNum then 
		retval = retval .. "]"
	else
		-- Check for spurious subpages beyond end of alleged number range
		while mw.title.new(pages.subpage .. '/' .. tostring(availableSubPageCount + 1)).exists do
			availableSubPageCount = availableSubPageCount + 1
		end
		if availableSubPageCount > maxNum then 
			retval = retval .. "]"
		end
	end

	-- before categorising, check what type of subpage we are categorising, and if detected, categorise images separately
	local subpageType = "subpages" -- generic type
	local subpageName = pages.subpage
	subpageName = mw.ustring.gsub(subpageName, "^*/", "")
	subpageName = mw.ustring.lower(subpageName)
	if ((mw.ustring.find(subpageName, "picture", 1, true) ~= nil) or
		(mw.ustring.find(subpageName, "image", 1, true) ~= nil) or
		(mw.ustring.find(subpageName, "panorama", 1, true) ~= nil)) then
		subpageType = "image subpages"
	end
	if (availableSubPageCount < 2) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 5) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 10) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 15) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 20) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 25) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 30) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 40) then
		retval = retval .. "]"
	elseif (availableSubPageCount <= 50) then
		retval = retval .. "]"
	else
		retval = retval .. "]"
	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
	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')
	local tries = 10
	repeat
		pages.random = pages.subpage .. '/' .. getRandomNumber(args.max)
		tries = tries - 1
	until tries < 1 or mw.title.new(pages.random).exists
	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 "]" does not exist.</strong>',
			title
		)
		if mw.title.getCurrentTitle().namespace == 100 then -- is in the portal namespace
			msg = msg .. ']'
		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 = getHeader(frame, pages, args.header or 'subpage', args.headertemplate)
	ret = getRandomSubpageContent(frame, pages)
	if not args.footer or not args.footer:find('%S') then
		ret = '<div style="clear:both;"></div></div>'
	else
		ret = getFooter(frame, pages, string.format(
			']',
			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 = getHeader(frame, pages, expandArg(args, 'header'), args.headertemplate)
	ret = getRandomSubpageContent(frame, pages)
	ret = getFooter(frame, pages, string.format(
		'] • ] ',
		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

• Modules in beta