Module:Automatic archive navigator/sandbox

From blackwiki
< Module:Automatic archive navigator
Revision as of 13:09, 5 October 2014 by blackwiki>Mr. Stradivarius (use table.concat rather than string concatenation for the getLinksText function)
Jump to navigation Jump to search

Documentation for this module may be created at Module:Automatic archive navigator/sandbox/doc

--
-- This module implements {{Automatic archive navigator}}
--

local p = {}

local function makeWikilink(page, display)
	return string.format('[[%s|%s]]', page, display)
end

local function getSubpageLink(offset, title)
	-- Get a formatted link to the subpage a certain distance away, or nil
	-- if that subpage does not exist. e.g. If the current subpage is
	-- /Archive 27, then getSubpageLink(3, title) returns a link to Archive 30.
	local subpageName
	local archiveNum = title.subpageText:match('^Archive ([1-9][0-9]*)$')
	archiveNum = tonumber(archiveNum)
	if archiveNum then
		subpageName = 'Archive ' .. (archiveNum + offset)
	elseif tonumber(title.subpageText) then
		subpageName = title.subpageText + offset
	else
		return nil  -- Couldn't parse out a subpage number
	end

	local page = mw.title.new(title.baseText .. '/' .. subpageName, title.namespace)
	if page.exists then
		return makeWikilink('/' .. subpageName, subpageName)
	else
		return nil
	end
end

local function getLinksText(args, title)
	local nbsp = '&nbsp;'
	local arrowSpacer, linkSpacer
	if mw.ustring.len(title.subpageText) <= 4 then
		-- If page names are short, we want more space.
		arrowSpacer = nbsp:rep(5)
		linkSpacer = nbsp:rep(7)
	else
		arrowSpacer = nbsp:rep(2)
		linkSpacer = nbsp:rep(4)
	end

	local ret = {}

	for offset = -5, -3 do
		local link = getSubpageLink(offset, title)
		if link then
			if offset == -3 then
				ret[#ret + 1] = link
				ret[#ret + 1] = linkSpacer
			else
				ret[#ret + 1] = link
				ret[#ret + 1] = ' ←'
				ret[#ret + 1] = arrowSpacer
			end
			break
		end
	end

	for offset = -2, -1 do
		local link = getSubpageLink(offset, title)
		if link then
			ret[#ret + 1] = link
			ret[#ret + 1] = linkSpacer
		end
	end

	ret[#ret + 1] = '<span style="font-size:115%;">'
	ret[#ret + 1] = makeWikilink(title.prefixedText, title.subpageText)
	ret[#ret + 1] = '</span>'

	for offset = 1, 2 do
		local link = getSubpageLink(offset, title)
		if link then
			ret[#ret + 1] = linkSpacer
			ret[#ret + 1] = link
		end
	end

	for offset = 5, 3, -1 do
		local link = getSubpageLink(offset, title)
		if link then
			if offset == 3 then
				ret[#ret + 1] = linkSpacer
				ret[#ret + 1] = link
			else
				ret[#ret + 1] = arrowSpacer
				ret[#ret + 1] = '→ '
				ret[#ret + 1] = link
			end
			break
		end
	end

	return table.concat(ret)
end

local function getMessage(args, title)
	if args[1] == '1' then
		return ''
	else
		local msg = '----\n'
		if args.text then
			msg = msg .. args.text
		else
			msg = msg .. "This is an '''[[Help:Archiving a talk page|archive]]''' of past discussions"
			if args.period then
				msg = msg .. " for the period '''" .. args.period .. "'''"
			end
			msg = msg .. ". '''Do not edit the contents of this page.''' If you wish to start a new discussion or revive an old one, please do so on the "
			msg = msg .. makeWikilink(title.rootPageTitle.fullText, 'current talk page') .. '.'
		end
		return msg
	end
end

function p._aan(args, title)
	title = title or mw.title.getCurrentTitle()

	local image = args.image
	if not image then
		image = '[[File:' .. (args.icon or 'Replacement filing cabinet.svg') .. '|40x40px|alt=|link=]]'
	end

	local mbox = require('Module:Message box').main('tmbox', {
		image = image,
		imageright = args.imageright,
		style = args.style or 'width:80%;margin-left:auto;margin-right:auto;',
		textstyle = args.textstyle or 'text-align:center;',
		text = getLinksText(args, title) .. '\n' .. getMessage(args, title)
	})

	return mbox .. '__NONEWSECTIONLINK__ __NOEDITSECTION__'
end

function p.aan(frame)
	local args = require('Module:Arguments').getArgs(frame, {
		wrappers = 'Template:Automatic archive navigator'
	})
	return p._aan(args)
end

return p