Module:Hatnote

--                             Module:Hatnote                                -- --                                                                           -- -- This module produces hatnote links and links to related articles. It      -- -- implements the and  meta-templates, and a few of    -- -- the more popular templates they depend on, including,            -- --, and. --

local mTableTools = require('Module:TableTools') local mArguments = require('Module:Arguments')

-- Argument processing

-- -- The p table is for functions to be returned from local p, f = {}, {}

local function makeInvokeFunction(func) return function(frame) local args = mArguments.getArgs(frame, {parentOnly = true}) return func(args) end end

-- Helper functions

local function findNamespaceId(link) -- Finds the namespace id (namespace number) of a link or a pagename. This -- function will not work if the link is enclosed in double brackets or if -- the link has been escaped with the colon trick. local namespace = link:match('^(.-):') if namespace then local nsTable = mw.site.namespaces[namespace] if nsTable then return nsTable.id		end end return 0 end

local function formatLink(link, display) -- Makes a wikilink from the given link and display values. Links are -- escaped with colons if necessary, and links to sections are detected -- and displayed with " § " as a separator rather than the standard -- MediaWiki "#".

-- Find whether we need to use the colon trick or not. We need to use the -- colon trick for categories and files, as otherwise category links -- categorise the page and file links display the file. link = link:match('^:?(.*)') -- Remove initial colon if specified. local namespace = findNamespaceId(link) local colon if namespace == 6 or namespace == 14 then colon = ':' else colon = '' end

-- Find the display value. if not display then local page, section = link:match('^(.-)#(.*)$') if page then display = page .. ' § ' .. section end end

-- Assemble the link. if display then return string.format('%s', colon, link, display) else return string.format('%s%s', colon, link) end end

local function formatPages(...) -- Formats a list of pages using formatLink and returns it as an array. Nil -- values are not allowed. local pages = {...} local ret = {} for i, page in ipairs(pages) do		ret[i] = formatLink(page) end return ret end

local function formatPageTables(pages) -- Takes a list of page/display tables and returns it as a list of -- formatted links. Nil values are not allowed. local links = {} for i, t in ipairs(pages) do		local link = t[1] local display = t[2] links[i] = formatLink(link, display) end return links end

local function makeWikitextError(msg) -- Formats an error message to be returned to wikitext. return string.format(' Error: %s. ', msg) end

-- Hatnote -- -- Produces standard hatnote text. Implements the template.

function p._hatnote(s) return string.format(' %s ', s) end

function f.hatnote(args) local s = args[1] if not s then return makeWikitextError('no text specified') end return p._hatnote(s) end

p.hatnote = makeInvokeFunction(f.hatnote)

-- Rellink -- -- Produces a standard link to a related article. Implements the -- template.

function p._rellink(s, extraclasses) if extraclasses then extraclasses = ' ' .. extraclasses else extraclasses = '' end return string.format(' %s ', extraclasses, s) end

function f.rellink(args) local s = args[1] local extraclasses = args.extraclasses if not s then return makeWikitextError('no text specified') end return p._rellink(s, extraclasses) end

p.rellink = makeInvokeFunction(f.rellink)

-- Details -- -- Produces a "For more details on this topic" link. the first parameter is the -- page linked to, and if the second parameter is present it is used instead -- of the "this topic" text.

function p._details(page, topic) page = formatLink(page) topic = topic or 'this topic' local text = string.format('For more details on %s, see %s.', topic, page) local extraclasses = 'boilerplate seealso' return p._rellink(text, extraclasses) end

function f.details(args) local page = args[1] local topic = args[2] if not page then return makeWikitextError('no page specified') end return p._details(page, topic) end

p.details = makeInvokeFunction(f.details)

-- Further -- -- Produces a "Further information: a, b and c" link. It accepts an unlimited -- number of positional parameters, each of which is a page name.

function p._further(...) local links = formatPages(...) local text = 'Further information: ' .. mw.text.listToText(links) return p._rellink(text) end

function f.further(args) local pages = mTableTools.compressSparseArray(args) if #pages < 1 then return makeWikiTextError('no pages specified') end return p._further(unpack(pages)) end

p.further = makeInvokeFunction(f.further)

-- Main -- -- Produces a link to a main article or articles. If used in category or -- category talk space, produces "The main article for this category is xxx". -- Otherwise, produces "Main article: xxx". Accepts an unlimited number of -- page/display tables. Non-table inputs will result in an error. The first -- value in the table should be the page name. Omitting this will result in an -- error, except in the case of the first table, which uses the page name as a -- fallaback. The second value in the table is an optional display value for -- the link. If the first page name is not in mainspace, the output uses "page" -- instead of "article". If more than one page is specified, the function uses -- plural forms.

function p._main(...) -- Get the list of pages. If no first page was specified we use the current -- page name. local pages = {...} local currentTitle = mw.title.getCurrentTitle local firstPageTable = pages[1] local firstPage if firstPageTable then firstPage = firstPageTable[1] else firstPage = currentTitle.text firstPageTable = {firstPage} pages[1] = firstPageTable end

-- Find the pagetype. local firstPageNs = findNamespaceId(firstPage) local pagetype = firstPageNs == 0 and 'article' or 'page'

-- Make the formatted link text local links = formatPageTables(pages) links = mw.text.listToText(links)

-- Build the text. local isPlural = #pages > 1 local currentNs = currentTitle.namespace local isCategoryNamespace = currentNs - currentNs % 2 == 14 local stringToFormat if isCategoryNamespace then if isPlural then stringToFormat = 'The main %ss for this' .. ' category are %s' else stringToFormat = 'The main %s for this' .. ' category is %s' end else if isPlural then stringToFormat = 'Main %ss: %s' else stringToFormat = 'Main %s: %s' end end local text = string.format(stringToFormat, pagetype, links)

-- Pass the text to p._rellink. local extraclasses = 'relarticle mainarticle' return p._rellink(text, extraclasses) end

function f.main(args) local pages = {} for k, v in pairs(args) do		if type(k) == 'number' then local display = args['l' .. tostring(k)] local page = {v, display} pages[k] = page end end pages = mTableTools.compressSparseArray(pages) return p._main(unpack(pages)) end

p.main = makeInvokeFunction(f.main)

-- See also -- -- Produces a "See also: a, b and c" link. The first parameter is an optional -- alternative for the "See also" text. The following parameters are an -- unlimited number of page/display tables. The first entry in the table is the -- page name, and the second entry in the table is the display text.

function p._seealso(altphrase, ...) altphrase = altphrase or 'See also' local pages = {...} local links = formatPageTables(pages) links = mw.text.listToText(links) local text = altphrase .. ': ' .. links local extraclasses = 'boilerplate seealso' return p._rellink(text, extraclasses) end

function f.seealso(args) local pages = {} for k, v in pairs(args) do		if type(k) == 'number' then local numstring = tostring(k) local display = args['label ' .. numstring] or args['l' .. numstring] local page = {v, display} pages[k] = page end end pages = mTableTools.compressSparseArray(pages) if not pages[1] then return makeWikitextError(			''				.. 'Template must be given at least one article name'		) end local altphrase = args.altphrase return p._seealso(altphrase, unpack(pages)) end

p.seealso = makeInvokeFunction(f.seealso)

return p