Module:Highest archive number: Difference between revisions

Module documentation[view] [edit] [history] [purge]

This module finds the highest archive number for a given set of numbered archive pages. The only input required is the prefix of the archive set. For example, for Talk:France/Archive 1, Talk:France/Archive 2, etc., the prefix would be "Talk:France/Archive ".

The module uses an exponential search algorithm, so it will make relatively few expensive function calls even for large numbers of archives. (The expensive function call is necessary to determine whether an individual archive exists.) For 1-10 archive pages, the module typically uses 4-6 expensive function calls; for 20-100 archives, it uses 6-12 calls; and for hundreds of archives, it uses 12-20 calls.

Because the module uses an exponential search, no gaps are allowed in the archive numbers; if there are any gaps, then the module may return the number of any archive page that exists where the following archive page does not exist. However, archive numbers do not have to start at 1; if they start at a higher number, you can specify this number in the start parameter.

Usage

From wikitext

From wikitext this module is usually used via the {{highest archive number}} template. However, it is also possible to use it directly from invoke with the syntax {{#invoke:highest archive number|main|prefix|start=start}}.

From Lua

Load the module with the following code:

local mHAN = require('Module:Highest archive number')

You can then use it like this:

mHAN._main(prefix, start)

The prefix variable is the prefix of the archive set.

Examples

#invoke code	Lua code	Result
{{#invoke:highest archive number|main|Wikipedia:Administrators' noticeboard/IncidentArchive}}	mHAN._main("Wikipedia:Administrators' noticeboard/IncidentArchive")	1188
{{#invoke:highest archive number|main|Talk:Byzantine Empire/Archive }}	mHAN._main("Talk:Byzantine Empire/Archive ")	18
{{#invoke:highest archive number|main|Wikipedia talk:WikiProject Chemicals/Archive |start=2005}}	mHAN._main("Wikipedia talk:WikiProject Chemicals/Archive ", 2005)	1

The above documentation is transcluded from Module:Highest archive number/doc. (edit | history)
Editors can experiment in this module's sandbox (edit | diff) and testcases (edit | run) pages.
Subpages of this module.

-- This module finds the highest existing archive number for a set of talk
-- archive pages.

local p = {}

local function pageExists(page)
	local success, title = pcall(mw.title.new, page)
	return success and title and title.exists
end

local function midPoint(lower, upper)
	return math.floor(lower + (upper - lower) / 2)
end

local function findHighestArchive(prefix, i, lower, upper)
	if i < 1 then
		return nil
	elseif pageExists(prefix .. tostring(i)) then
		lower = i
		if upper and i + 1 == upper then
			return i
		elseif upper then
			i = midPoint(lower, upper)
		else
			i = i * 2
		end
		return findHighestArchive(prefix, i, lower, upper)
	else
		upper = i
		lower = lower or 0
		i = midPoint(lower, upper)
		return findHighestArchive(prefix, i, lower, upper)
	end
end

function p._main(prefix)
	if not prefix then
		-- Try to detect whether we are on an archive page or not and create
		-- the prefix accordingly.
		local title = mw.title.getCurrentTitle()
		prefix = title.prefixedText:match('^(.*/Archive )[0-9]+$')
		prefix = prefix or title.prefixedText .. '/Archive '
	end
	return findHighestArchive(prefix, 10)
end

function p.main(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		trim = false,
		removeBlanks = false,
		wrappers = 'Template:Highest archive number'
	})
	local prefix = args[1]
	return p._main(prefix)
end

return p