Module:Hatnote

This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in hatnotes at the top of pages, and the {{format link}} template, which is used to format a wikilink for use in hatnotes. It also contains a number of helper functions for use in other Lua hatnote modules.

Use from wikitext

The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Hatnote and Template:Format link for documentation.

Use from other Lua modules

To load this module from another Lua module, use the following code.

<syntaxhighlight lang="lua"> local mHatnote = require('Module:Hatnote') </syntaxhighlight>

You can then use the functions as documented below.

Hatnote

<syntaxhighlight lang="lua"> mHatnote._hatnote(s, options) </syntaxhighlight>

Formats the string s as a hatnote. This encloses s in the tags <div class="hatnote">...</div>. Options are provided in the options table. Options include:

• options.extraclasses - a string of extra classes to provide
• options.selfref - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see Template:Selfref))

The CSS of the hatnote class is defined in MediaWiki:Common.css.

Example 1

<syntaxhighlight lang="lua"> mHatnote._hatnote('This is a hatnote.') </syntaxhighlight>

Produces: <div class="hatnote">This is a hatnote.</div>

Displays as:

This is a hatnote.

Example 2

<syntaxhighlight lang="lua"> mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) </syntaxhighlight>

Produces: <div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>

Displayed as:

This is a hatnote.

Format link

<syntaxhighlight lang="lua"> mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true} </syntaxhighlight>

Formats link as a wikilink for display in hatnote templates, with optional display value display. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

If italicizePage is true then the page portion of the link is italicized, and if italicizePage is true then the section portion of the link is italicized.

Examples

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</syntaxhighlight> → [[Lion]] → Lion

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</syntaxhighlight> → [[Lion#Etymology|Lion §&nbsp;Etymology]] → Lion § Etymology

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</syntaxhighlight> → [[:Category:Lions]] → Category:Lions

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</syntaxhighlight> → [[Lion#Etymology|Etymology of lion]] → Etymology of lion

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</syntaxhighlight> → [[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]] → Quo warranto § Philippines

<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true}</syntaxhighlight> → [[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&nbsp;<i>Disini v. Secretary of Justice</i>]] → Cybercrime Prevention Act of 2012 § Disini v. Secretary of Justice

Format pages

<syntaxhighlight lang="lua"> mHatnote.formatPages(...) </syntaxhighlight>

Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology') would produce an array like {'Lion', 'Category:Lions', 'Lion § Etymology'}.

Format page tables

<syntaxhighlight lang="lua"> mHatnote.formatPageTables(...) </syntaxhighlight>

Takes a list of page/display tables, formats them with the _formatLink function, and returns the result as an array. Each item in the list must be a table. The first value in the table is the link, and is required. The second value in the table is the display value, and is optional. For example, the code mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'}) would produce an array like {'the Lion article', 'Category:Lions', 'the etymology of lion'}.

Find namespace id

<syntaxhighlight lang="lua"> mHatnote.findNamespaceId(link, removeColon) </syntaxhighlight>

Finds the namespace id of the string link, which should be a valid page name, with or without the section name. This function will not work if the page name is enclosed with square brackets. When trying to parse the namespace name, colons are removed from the start of the link by default. This is helpful if users have specified colons when they are not strictly necessary. If you do not need to check for initial colons, set removeColon to false.

Examples

mHatnote.findNamespaceId('Lion') → 0

mHatnote.findNamespaceId('Category:Lions') → 14

mHatnote.findNamespaceId(':Category:Lions') → 14

mHatnote.findNamespaceId(':Category:Lions', false) → 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error

<syntaxhighlight lang="lua"> mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) </syntaxhighlight>

Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:Hatnote templates with errors (0). To suppress categorization, pass false as third parameter of the function (addTrackingCategory).

Examples:

mHatnote.makeWikitextError('an error has occurred') →

mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors') →

Examples

For an example of how this module is used in other Lua modules, see Module:Main

---

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

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

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. If the
	-- removeColon parameter is set to true, the function will remove initial
	-- colons from the link.
	checkType('_findNamespaceId', 1, link, 'string')
	checkType('_findNamespaceId', 2, removeColon, 'boolean', true)
	if removeColon 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(page)
	end
	return ret
end

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

function p._makeWikitextError(msg)
	-- Formats an error message to be returned to wikitext.
	checkType('_makeWikitextError', 1, msg, 'string')
	return string.format('<strong class="error">Error: %s.</strong>', msg)
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 "#".
--------------------------------------------------------------------------------

function p.formatLink(frame)
	local args = getArgs(frame)
	local link = args[1]
	local display = args[2]
	if not link then
		return p._makeWikitextError('no link specified')
	end
	return p._formatLink(link, display)
end

function p._formatLink(link, display)
	-- 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.
	checkType('_formatLink', 1, link, 'string')
	checkType('_formatLink', 2, display, 'string', true)
	link = removeInitialColon(link)
	local namespace = p._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%s|%s]]', colon, link, display)
	else
		return string.format('[[%s%s]]', colon, link)
	end
end

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

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

function p._hatnote(s)
	checkType('_hatnote', 1, s, 'string')
	return string.format('<div class="dablink">%s</div>', s)
end

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

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

function p._rellink(s, extraclasses)
	checkType('_rellink', 1, s, 'string')
	checkType('_rellink', 2, extraclasses, 'string', true)
	if extraclasses then
		extraclasses = ' ' .. extraclasses
	else
		extraclasses = ''
	end
	return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end

return p