Module:Hatnote: Difference between revisions

From CivWiki
Jump to navigation Jump to search
Content added Content deleted
(split out the namespace-detecting part of formatLink to a new function)
m (51 revisions imported from wikipedia:Module:Hatnote)
 
(49 intermediate revisions by 9 users not shown)
Line 3: Line 3:
-- --
-- --
-- This module produces hatnote links and links to related articles. It --
-- This module produces hatnote links and links to related articles. It --
-- implements the {{rellink}} and {{hatnote}} meta-templates, and a few of --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules. --
-- the more popular templates they depend on, including {{main}}, --
-- {{see also}}, {{further}} and {{details}}. --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local mTableTools = require('Module:TableTools')
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local mArguments = require('Module:Arguments')
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]

local p = {}


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Helper functions
-- Argument processing
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local function getArgs(frame)
--[[
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- The p table is for functions to be returned from #invoke, and for functions
-- blanks are removed.
-- to be used from other Lua modules. The f table is for functions acting as a
mArguments = require('Module:Arguments')
-- bridge between #invoke functions and Lua module functions. #invoke functions
return mArguments.getArgs(frame, {parentOnly = true})
-- are connected to f table functions through the makeInvokeFunction function.
end
-- Functions for use from other Lua modules have names beginning with an
-- underscore.
--]]
local p, f = {}, {}


local function makeInvokeFunction(func)
local function removeInitialColon(s)
-- Removes the initial colon from a string, if present.
return function(frame)
return s:match('^:?(.*)')
local args = mArguments.getArgs(frame, {parentOnly = true})
return func(args)
end
end
end


function p.findNamespaceId(link, removeColon)
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function findNamespaceId(link)
-- Finds the namespace id (namespace number) of a link or a pagename. This
-- 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
-- function will not work if the link is enclosed in double brackets. Colons
-- the link has been escaped with the colon trick.
-- are trimmed from the start of the link by default. To skip colon
-- trimming, set the removeColon parameter to false.
checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
if removeColon ~= false then
link = removeInitialColon(link)
end
local namespace = link:match('^(.-):')
local namespace = link:match('^(.-):')
if namespace then
if namespace then
Line 50: Line 51:
end
end


local function formatLink(link, display)
function p.formatPages(...)
-- Makes a wikilink from the given link and display values. Links are
-- Formats a list of pages using formatLink and returns it as an array. Nil
-- values are not allowed.
-- escaped with colons if necessary, and links to sections are detected
local pages = {...}
-- and displayed with " § " as a separator rather than the standard
local ret = {}
-- MediaWiki "#".
for i, page in ipairs(pages) do

ret[i] = p._formatLink{link = page}
-- 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.
local namespace = findNamespaceId(link)
local colon
if namespace == 6 or namespace == 14 then
colon = ':'
else
colon = ''
end
end
return ret
end


function p.formatPageTables(...)
-- Find the display value.
-- Takes a list of page/display tables and returns it as a list of
if not display then
-- formatted links. Nil values are not allowed.
local page, section = link:match('^(.-)#(.*)$')
local pages = {...}
if page then
local links = {}
display = page .. ' § ' .. section
for i, t in ipairs(pages) do
end
checkType('formatPageTables', i, t, 'table')
local link = t[1]
local display = t[2]
links[i] = p._formatLink{link = link, display = display}
end
end
return links
end


function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Assemble the link.
-- Formats an error message to be returned to wikitext. If
if display then
-- addTrackingCategory is not false after being returned from
return string.format('[[%s%s|%s]]', colon, link, display)
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
-- is added.
checkType('makeWikitextError', 1, msg, 'string')
checkType('makeWikitextError', 2, helpLink, 'string', true)
yesno = require('Module:Yesno')
title = title or mw.title.getCurrentTitle()
-- Make the help link text.
local helpText
if helpLink then
helpText = ' ([[' .. helpLink .. '|help]])'
else
else
helpText = ''
return string.format('[[%s%s]]', colon, link)
end
end
-- Make the category text.
local category
if not title.isTalkPage -- Don't categorise talk pages
and title.namespace ~= 2 -- Don't categorise userspace
and yesno(addTrackingCategory) ~= false -- Allow opting out
then
category = 'Hatnote templates with errors'
category = string.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
category
)
else
category = ''
end
return string.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
helpText,
category
)
end
end


local function makeWikitextError(msg)
function p.disambiguate(page, disambiguator)
-- Formats an error message to be returned to wikitext.
-- Formats a page title with a disambiguation parenthetical,
-- i.e. "Example" → "Example (disambiguation)".
return string.format('<strong class="error">Error: %s.</strong>', msg)
checkType('disambiguate', 1, page, 'string')
checkType('disambiguate', 2, disambiguator, 'string', true)
disambiguator = disambiguator or 'disambiguation'
return string.format('%s (%s)', page, disambiguator)
end
end


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Hatnote
-- Format link
--
--
-- Makes a wikilink from the given link and display values. Links are escaped
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- with colons if necessary, and links to sections are detected and displayed
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
-- the {{format link}} template.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._hatnote(s)
function p.formatLink(frame)
-- The formatLink export function, for use in templates.
return string.format('<div class="dablink">%s</div>', s)
yesno = require('Module:Yesno')
local args = getArgs(frame)
local link = args[1]
if not link then
return p.makeWikitextError(
'no link specified',
'Template:Format link#Errors',
args.category
)
end
return p._formatLink{
link = link,
display = args[2],
italicizePage = yesno(args.italicizepage),
italicizeSection = yesno(args.italicizesection),
}
end
end


function f.hatnote(args)
local function italicize(s)
-- Italicize a string.
local s = args[1]
return '<i>' .. s .. '</i>'
if not s then
end
return makeWikitextError('no text specified')

local function maybeItalicize(s, shouldItalicize)
-- italicize s if s is a string and the shouldItalicize parameter is true.
if s and shouldItalicize then
return italicize(s)
else
return s
end
end
return p._hatnote(s)
end
end


local function parseLink(link)
p.hatnote = makeInvokeFunction(f.hatnote)
-- Parse a link and return a table with the link's components.
-- These components are:
-- - link: the link, stripped of any initial colon (always present)
-- - page: the page name (always present)
-- - section: the page name (may be nil)
-- - display: the display text, if manually entered after a pipe (may be nil)
link = removeInitialColon(link)


-- Find whether a faux display value has been added with the {{!}} magic
--------------------------------------------------------------------------------
-- Rellink
-- word.
local prePipe, display = link:match('^(.-)|(.*)$')
--
link = prePipe or link
-- Produces a standard link to a related article. Implements the {{rellink}}
-- template.
--------------------------------------------------------------------------------


-- Find the page, if it exists.
function p._rellink(s, extraclasses)
-- For links like [[#Bar]], the page will be nil.
if extraclasses then
local preHash, postHash = link:match('^(.-)#(.*)$')
extraclasses = ' ' .. extraclasses
local page
else
if not preHash then
extraclasses = ''
-- We have a link like [[Foo]].
page = link
elseif preHash ~= '' then
-- We have a link like [[Foo#Bar]].
page = preHash
end
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end


-- Find the section, if it exists.
function f.rellink(args)
local s = args[1]
local section
if postHash and postHash ~= '' then
local extraclasses = args.extraclasses
section = postHash
if not s then
return makeWikitextError('no text specified')
end
end
return p._rellink(s, extraclasses)
return {
link = link,
page = page,
section = section,
display = display,
}
end
end


function p._formatLink(options)
p.rellink = makeInvokeFunction(f.rellink)
-- The formatLink export function, for use in modules.

checkType('_formatLink', 1, options, 'table')
--------------------------------------------------------------------------------
checkTypeForNamedArg('_formatLink', 'link', options.link, 'string', false)
-- Details
checkTypeForNamedArg(
--
'_formatLink',
-- Produces a "For more details on this topic" link. the first parameter is the
'display',
-- page linked to, and if the second parameter is present it is used instead
options.display,
-- of the "this topic" text.
'string',
--------------------------------------------------------------------------------
true

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


local parsed = parseLink(options.link)
function f.details(args)
local display = options.display or parsed.display
local page = args[1]
local topic = args[2]
-- Deal with the case where we don't have to pipe the link
if not page then
if not display and not parsed.section and not options.italicizePage then
return makeWikitextError('no page specified')
return string.format('[[:%s]]', parsed.link)
end
end
return p._details(page, topic)
-- Find the display text for piped links
if not display then
local page = maybeItalicize(parsed.page, options.italicizePage)
local section = maybeItalicize(parsed.section, options.italicizeSection)
if not page then
display = string.format('§&nbsp;%s', section)
elseif section then
display = string.format('%s §&nbsp;%s', page, section)
else
display = page
end
end
return string.format('[[:%s|%s]]', parsed.link, display)
end
end

p.details = makeInvokeFunction(f.details)


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Further
-- Hatnote
--
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- 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(...)
function p.hatnote(frame)
local pages = {...}
local args = getArgs(frame)
local formattedPages = {}
local s = args[1]
local options = {}
for i, page in ipairs(pages) do
if not s then
formattedPages[i] = formatLink(page)
return p.makeWikitextError(
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
end
options.extraclasses = args.extraclasses
local text = 'Further information: ' .. mw.text.listToText(formattedPages)
options.selfref = args.selfref
return p._rellink(text)
return p._hatnote(s, options)
end
end


function f.further(args)
function p._hatnote(s, options)
checkType('_hatnote', 1, s, 'string')
local pages = mTableTools.compressSparseArray(args)
checkType('_hatnote', 2, options, 'table', true)
if #pages < 1 then
options = options or {}
return makeWikiTextError('no pages specified')
local classes = {'hatnote', 'navigation-not-searchable'}
local extraclasses = options.extraclasses
local selfref = options.selfref
if type(extraclasses) == 'string' then
classes[#classes + 1] = extraclasses
end
end
if selfref then
return p._further(unpack(pages))
classes[#classes + 1] = 'selfref'
end
return string.format(
'<div role="note" class="%s">%s</div>',
table.concat(classes, ' '),
s
)
end
end

p.further = makeInvokeFunction(f.further)


return p
return p

Latest revision as of 18:14, 5 May 2021

Documentation for this module may be created at Module:Hatnote/doc

--------------------------------------------------------------------------------
--                              Module:Hatnote                                --
--                                                                            --
-- This module produces hatnote links and links to related articles. It       --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules.                            --
--------------------------------------------------------------------------------

local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]

local p = {}

--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------

local function getArgs(frame)
	-- Fetches the arguments from the parent frame. Whitespace is trimmed and
	-- blanks are removed.
	mArguments = require('Module:Arguments')
	return mArguments.getArgs(frame, {parentOnly = true})
end

local function removeInitialColon(s)
	-- Removes the initial colon from a string, if present.
	return s:match('^:?(.*)')
end

function p.findNamespaceId(link, removeColon)
	-- 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. Colons
	-- are trimmed from the start of the link by default. To skip colon
	-- trimming, set the removeColon parameter to false.
	checkType('findNamespaceId', 1, link, 'string')
	checkType('findNamespaceId', 2, removeColon, 'boolean', true)
	if removeColon ~= false then
		link = removeInitialColon(link)
	end
	local namespace = link:match('^(.-):')
	if namespace then
		local nsTable = mw.site.namespaces[namespace]
		if nsTable then
			return nsTable.id
		end
	end
	return 0
end

function p.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] = p._formatLink{link = page}
	end
	return ret
end

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

function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
	-- Formats an error message to be returned to wikitext. If
	-- addTrackingCategory is not false after being returned from
	-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
	-- is added.
	checkType('makeWikitextError', 1, msg, 'string')
	checkType('makeWikitextError', 2, helpLink, 'string', true)
	yesno = require('Module:Yesno')
	title = title or mw.title.getCurrentTitle()
	-- Make the help link text.
	local helpText
	if helpLink then
		helpText = ' ([[' .. helpLink .. '|help]])'
	else
		helpText = ''
	end
	-- Make the category text.
	local category
	if not title.isTalkPage -- Don't categorise talk pages
		and title.namespace ~= 2 -- Don't categorise userspace
		and yesno(addTrackingCategory) ~= false -- Allow opting out
	then
		category = 'Hatnote templates with errors'
		category = string.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return string.format(
		'<strong class="error">Error: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

function p.disambiguate(page, disambiguator)
	-- Formats a page title with a disambiguation parenthetical,
	-- i.e. "Example" → "Example (disambiguation)".
	checkType('disambiguate', 1, page, 'string')
	checkType('disambiguate', 2, disambiguator, 'string', true)
	disambiguator = disambiguator or 'disambiguation'
	return string.format('%s (%s)', page, disambiguator)
end

--------------------------------------------------------------------------------
-- Format link
--
-- 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 "#". Used in
-- the {{format link}} template.
--------------------------------------------------------------------------------

function p.formatLink(frame)
	-- The formatLink export function, for use in templates.
	yesno = require('Module:Yesno')
	local args = getArgs(frame)
	local link = args[1]
	if not link then
		return p.makeWikitextError(
			'no link specified',
			'Template:Format link#Errors',
			args.category
		)
	end
	return p._formatLink{
		link = link,
		display = args[2],
		italicizePage = yesno(args.italicizepage),
		italicizeSection = yesno(args.italicizesection),
	}
end

local function italicize(s)
	-- Italicize a string.
	return '<i>' .. s .. '</i>'
end

local function maybeItalicize(s, shouldItalicize)
	-- italicize s if s is a string and the shouldItalicize parameter is true.
	if s and shouldItalicize then
		return italicize(s)
	else
		return s
	end
end

local function parseLink(link)
	-- Parse a link and return a table with the link's components.
	-- These components are:
	-- - link: the link, stripped of any initial colon (always present)
	-- - page: the page name (always present)
	-- - section: the page name (may be nil)
	-- - display: the display text, if manually entered after a pipe (may be nil)
	link = removeInitialColon(link)

	-- Find whether a faux display value has been added with the {{!}} magic
	-- word.
	local prePipe, display = link:match('^(.-)|(.*)$')
	link = prePipe or link

	-- Find the page, if it exists.
	-- For links like [[#Bar]], the page will be nil.
	local preHash, postHash = link:match('^(.-)#(.*)$')
	local page
	if not preHash then
		-- We have a link like [[Foo]].
		page = link
	elseif preHash ~= '' then
		-- We have a link like [[Foo#Bar]].
		page = preHash
	end

	-- Find the section, if it exists.
	local section
	if postHash and postHash ~= '' then
		section = postHash
	end
	
	return {
		link = link,
		page = page,
		section = section,
		display = display,
	}
end

function p._formatLink(options)
	-- The formatLink export function, for use in modules.
	checkType('_formatLink', 1, options, 'table')
	checkTypeForNamedArg('_formatLink', 'link', options.link, 'string', false)
	checkTypeForNamedArg(
		'_formatLink',
		'display',
		options.display,
		'string',
		true
	)
	checkTypeForNamedArg(
		'_formatLink',
		'italicizePage',
		options.italicizePage,
		'boolean',
		true
	)
	checkTypeForNamedArg(
		'_formatLink',
		'italicizeSection',
		options.italicizeSection,
		'boolean',
		true
	)

	local parsed = parseLink(options.link)
	local display = options.display or parsed.display
	
	-- Deal with the case where we don't have to pipe the link
	if not display and not parsed.section and not options.italicizePage then
		return string.format('[[:%s]]', parsed.link)
	end
	
	-- Find the display text for piped links
	if not display then
		local page = maybeItalicize(parsed.page, options.italicizePage)
		local section = maybeItalicize(parsed.section, options.italicizeSection)
		if not page then
			display = string.format('§&nbsp;%s', section)
		elseif section then
			display = string.format('%s §&nbsp;%s', page, section)
		else
			display = page
		end
	end
	
	return string.format('[[:%s|%s]]', parsed.link, display)
end

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

function p.hatnote(frame)
	local args = getArgs(frame)
	local s = args[1]
	local options = {}
	if not s then
		return p.makeWikitextError(
			'no text specified',
			'Template:Hatnote#Errors',
			args.category
		)
	end
	options.extraclasses = args.extraclasses
	options.selfref = args.selfref
	return p._hatnote(s, options)
end

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local classes = {'hatnote', 'navigation-not-searchable'}
	local extraclasses = options.extraclasses
	local selfref = options.selfref
	if type(extraclasses) == 'string' then
		classes[#classes + 1] = extraclasses
	end
	if selfref then
		classes[#classes + 1] = 'selfref'
	end
	return string.format(
		'<div role="note" class="%s">%s</div>',
		table.concat(classes, ' '),
		s
	)
end

return p