Difference between revisions of "Module:Hatnote"

From NixNet
m (1 revision imported)
(parse pages for section-only links as nil - this prevents section-only links that have an italicized page parameter from having empty <i></i> tags)
Line 9: Line 9:
 
local libraryUtil = require('libraryUtil')
 
local libraryUtil = require('libraryUtil')
 
local checkType = libraryUtil.checkType
 
local checkType = libraryUtil.checkType
 +
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
 
local mArguments -- lazily initialise [[Module:Arguments]]
 
local mArguments -- lazily initialise [[Module:Arguments]]
 
local yesno -- lazily initialise [[Module:Yesno]]
 
local yesno -- lazily initialise [[Module:Yesno]]
Line 56: Line 57:
 
local ret = {}
 
local ret = {}
 
for i, page in ipairs(pages) do
 
for i, page in ipairs(pages) do
ret[i] = p._formatLink(page)
+
ret[i] = p._formatLink{link = page}
 
end
 
end
 
return ret
 
return ret
Line 70: Line 71:
 
local link = t[1]
 
local link = t[1]
 
local display = t[2]
 
local display = t[2]
links[i] = p._formatLink(link, display)
+
links[i] = p._formatLink{link = link, display = display}
 
end
 
end
 
return links
 
return links
Line 93: Line 94:
 
-- Make the category text.
 
-- Make the category text.
 
local category
 
local category
if not title.isTalkPage and yesno(addTrackingCategory) ~= false then
+
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 = 'Hatnote templates with errors'
 
category = string.format(
 
category = string.format(
Line 126: Line 130:
 
-- with colons if necessary, and links to sections are detected and displayed
 
-- with colons if necessary, and links to sections are detected and displayed
 
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
 
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
-- the {{format hatnote link}} template.
+
-- the {{format link}} template.
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
 
function p.formatLink(frame)
 
function p.formatLink(frame)
 +
-- The formatLink export function, for use in templates.
 +
yesno = require('Module:Yesno')
 
local args = getArgs(frame)
 
local args = getArgs(frame)
 
local link = args[1]
 
local link = args[1]
local display = args[2]
 
 
if not link then
 
if not link then
 
return p.makeWikitextError(
 
return p.makeWikitextError(
 
'no link specified',
 
'no link specified',
'Template:Format hatnote link#Errors',
+
'Template:Format link#Errors',
 
args.category
 
args.category
 
)
 
)
 
end
 
end
return p._formatLink(link, display)
+
return p._formatLink{
 +
link = link,
 +
display = args[2],
 +
italicizePage = yesno(args.italicizepage),
 +
italicizeSection = yesno(args.italicizesection),
 +
}
 
end
 
end
  
function p._formatLink(link, display)
+
local function italicize(s)
checkType('_formatLink', 1, link, 'string')
+
-- Italicize a string.
checkType('_formatLink', 2, display, 'string', true)
+
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
  
-- Remove the initial colon for links where it was specified manually.
+
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)
 
link = removeInitialColon(link)
  
 
-- Find whether a faux display value has been added with the {{!}} magic
 
-- Find whether a faux display value has been added with the {{!}} magic
 
-- word.
 
-- word.
if not display then
+
local prePipe, display = link:match('^(.-)|(.*)$')
local prePipe, postPipe = link:match('^(.-)|(.*)$')
+
link = prePipe or link
link = prePipe or link
+
 
display = postPipe
+
-- 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
 
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
 +
)
  
-- Find the display value.
+
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
 
if not display then
local page, section = link:match('^(.-)#(.*)$')
+
local page = maybeItalicize(parsed.page, options.italicizePage)
if page then
+
local section = maybeItalicize(parsed.section, options.italicizeSection)
display = page .. ' §&nbsp;' .. section
+
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
 
end
 
end
 
+
-- Assemble the link.
+
return string.format('[[:%s|%s]]', parsed.link, display)
if display then
 
return string.format(
 
'[[:%s|%s]]',
 
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping
 
display
 
)
 
else
 
return string.format('[[:%s]]', link)
 
end
 
 
end
 
end
  

Revision as of 13:46, 30 July 2020

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.

local mHatnote = require('Module:Hatnote')

You can then use the functions as documented below.

Hatnote

mHatnote._hatnote(s, options)

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
mHatnote._hatnote('This is a hatnote.')

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

Displays as:

Example 2
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})

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

Displayed as:

Format link

mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true}

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
mHatnote._formatLink{link = 'Lion'} → [[Lion]] → Lion
mHatnote._formatLink{link = 'Lion#Etymology'} → [[Lion#Etymology|Lion §&nbsp;Etymology]] → Lion § Etymology
mHatnote._formatLink{link = 'Category:Lions'} → [[:Category:Lions]] → Category:Lions
mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'} → [[Lion#Etymology|Etymology of lion]] → Etymology of lion
mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true} → [[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]] → Quo warranto § Philippines
mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true} → [[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

mHatnote.formatPages(...)

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|Lion § Etymology]]'}.

Format page tables

mHatnote.formatPageTables(...)

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 {'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}.

Find namespace id

mHatnote.findNamespaceId(link, removeColon)

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

mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)

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')Error: an error has occurred.
mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')Error: an error has occurred (help).

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 {{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