Module:Format link and Module:Hatnote: Difference between pages

From DMJ Productions
(Difference between pages)
m (1 revision imported)
 
w>Nihiltres
(Reordered helper functions (first by export status, then alphabetically) and migrated p.quote upstream from Module:Redirect hatnote (includes contributions by Tamzin and Nihiltres))
 
Line 1: Line 1:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Format link
--                             Module:Hatnote                                --
--
--                                                                           --
-- Makes a wikilink from the given link and display values. Links are escaped
-- This module produces hatnote links and links to related articles. It      --
-- with colons if necessary, and links to sections are detected and displayed
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
-- helper functions for other Lua hatnote modules.                           --
-- the {{format link}} template.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
local libraryUtil = require('libraryUtil')
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
local checkType = libraryUtil.checkType
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
local mArguments -- lazily initialise [[Module:Arguments]]
local mArguments -- lazily initialise [[Module:Arguments]]
local mError -- lazily initialise [[Module:Error]]
local yesno -- lazily initialise [[Module:Yesno]]
local yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink


local p = {}
local p = {}
Line 32: Line 32:
end
end


local function maybeItalicize(s, shouldItalicize)
function p.defaultClasses(inline)
-- Italicize s if s is a string and the shouldItalicize parameter is true.
-- Provides the default hatnote classes as a space-separated string; useful
if s and shouldItalicize then
-- for hatnote-manipulation modules like [[Module:Hatnote group]].
return '<i>' .. s .. '</i>'
return
else
(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
return s
'navigation-not-searchable'
end
end
end


local function parseLink(link)
function p.disambiguate(page, disambiguator)
-- Parse a link and return a table with the link's components.
-- Formats a page title with a disambiguation parenthetical,
-- These components are:
-- i.e. "Example" → "Example (disambiguation)".
-- - link: the link, stripped of any initial colon (always present)
checkType('disambiguate', 1, page, 'string')
-- - page: the page name (always present)
checkType('disambiguate', 2, disambiguator, 'string', true)
-- - section: the page name (may be nil)
disambiguator = disambiguator or 'disambiguation'
-- - display: the display text, if manually entered after a pipe (may be nil)
return mw.ustring.format('%s (%s)', page, disambiguator)
link = removeInitialColon(link)
end


-- Find whether a faux display value has been added with the {{!}} magic
function p.findNamespaceId(link, removeColon)
-- word.
-- Finds the namespace id (namespace number) of a link or a pagename. This
local prePipe, display = link:match('^(.-)|(.*)$')
-- function will not work if the link is enclosed in double brackets. Colons
link = prePipe or link
-- are trimmed from the start of the link by default. To skip colon
 
-- trimming, set the removeColon parameter to false.
-- Find the page, if it exists.
checkType('findNamespaceId', 1, link, 'string')
-- For links like [[#Bar]], the page will be nil.
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
local preHash, postHash = link:match('^(.-)#(.*)$')
if removeColon ~= false then
local page
link = removeInitialColon(link)
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
end
 
local namespace = link:match('^(.-):')
-- Find the section, if it exists.
if namespace then
local section
local nsTable = mw.site.namespaces[namespace]
if postHash and postHash ~= '' then
if nsTable then
section = postHash
return nsTable.id
end
end
end
return 0
return {
link = link,
page = page,
section = section,
display = display,
}
end
end


local function formatDisplay(parsed, options)
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Formats a display string based on a parsed link table (matching the
-- Formats an error message to be returned to wikitext. If
-- output of parseLink) and an options table (matching the input options for
-- addTrackingCategory is not false after being returned from
-- _formatLink).
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
local page = maybeItalicize(parsed.page, options.italicizePage)
-- is added.
local section = maybeItalicize(parsed.section, options.italicizeSection)
checkType('makeWikitextError', 1, msg, 'string')
if (not section) then
checkType('makeWikitextError', 2, helpLink, 'string', true)
return page
yesno = require('Module:Yesno')
elseif (not page) then
title = title or mw.title.getCurrentTitle()
return mw.ustring.format('§&nbsp;%s', section)
-- Make the help link text.
local helpText
if helpLink then
helpText = ' ([[' .. helpLink .. '|help]])'
else
else
return mw.ustring.format('%s §&nbsp;%s', page, section)
helpText = ''
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 = mw.ustring.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
category
)
else
category = ''
end
return mw.ustring.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
helpText,
category
)
end
end


local function missingArgError(target)
local curNs = mw.title.getCurrentTitle().namespace
mError = require('Module:Error')
p.missingTargetCat =
return mError.error{message =
--Default missing target category, exported for use in related modules
'Error: no link or target specified! ([[' .. target .. '#Errors|help]])'
((curNs ==  0) or (curNs == 14)) and
'Articles with hatnote templates targeting a nonexistent page' or nil
 
function p.quote(title)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
--mark, kerns that side as with {{-'}}
local quotationMarks = {
["'"]=true, ['"']=true, ['']=true, ["‘"]=true, ['”']=true, ["’"]=true
}
}
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
quotationMarks[string.sub(title,  1,  1)],
quotationMarks[string.sub(title, -1, -1)]
if quoteLeft or quoteRight then
title = mw.html.create("span"):wikitext(title)
end
if quoteLeft  then title:css("padding-left",  "0.15em") end
if quoteRight then title:css("padding-right", "0.15em") end
return '"' .. tostring(title) .. '"'
end
end


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


function p.formatLink(frame)
function p.hatnote(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] or args.link
local s = args[1]
local target = args[3] or args.target
if not s then
if not (link or target) then
return p.makeWikitextError(
return missingArgError('Template:Format link')
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
end
 
return p._hatnote(s, {
return p._formatLink{
extraclasses = args.extraclasses,
link = link,
selfref = args.selfref
display = args[2] or args.display,
})
target = target,
italicizePage = yesno(args.italicizepage),
italicizeSection = yesno(args.italicizesection),
categorizeMissing = args.categorizemissing
}
end
end


function p._formatLink(options)
function p._hatnote(s, options)
-- The formatLink export function, for use in modules.
checkType('_hatnote', 1, s, 'string')
checkType('_formatLink', 1, options, 'table')
checkType('_hatnote', 2, options, 'table', true)
local function check(key, expectedType) --for brevity
options = options or {}
checkTypeForNamedArg(
local inline = options.inline
'_formatLink', key, options[key], expectedType or 'string', true
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
)
local extraclasses
end
if type(options.extraclasses) == 'string' then
check('link')
extraclasses = options.extraclasses
check('display')
check('target')
check('italicizePage', 'boolean')
check('italicizeSection', 'boolean')
check('categorizeMissing')
 
-- Normalize link and target and check that at least one is present
if options.link == '' then options.link = nil end
if options.target == '' then options.target = nil end
if not (options.link or options.target) then
return missingArgError('Module:Format link')
end
 
local parsed = parseLink(options.link)
local display = options.display or parsed.display
local catMissing = options.categorizeMissing
local category = ''
 
-- Find the display text
if not display then display = formatDisplay(parsed, options) end
 
-- Handle the target option if present
if options.target then
local parsedTarget = parseLink(options.target)
parsed.link = parsedTarget.link
parsed.page = parsedTarget.page
end
end


-- Test if page exists if a diagnostic category is specified
hatnote
if catMissing and (mw.ustring.len(catMissing) > 0) then
:attr('role', 'note')
local title = nil
:addClass(p.defaultClasses(inline))
if parsed.page then title = mw.title.new(parsed.page) end
:addClass(extraclasses)
if title and (not title.isExternal) then
:addClass(options.selfref and 'selfref' or nil)
local success, exists = pcall(function() return title.exists end)
:wikitext(s)
if success and not exists then
category = mw.ustring.format('[[Category:%s]]', catMissing)
end
end
end
-- Format the result as a link
if parsed.link == display then
return mw.ustring.format('[[:%s]]%s', parsed.link, category)
else
return mw.ustring.format('[[:%s|%s]]%s', parsed.link, display, category)
end
end


--------------------------------------------------------------------------------
return mw.getCurrentFrame():extensionTag{
-- Derived convenience functions
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
--------------------------------------------------------------------------------
} .. tostring(hatnote)
 
function p.formatPages(options, pages)
-- Formats an array of pages using formatLink and the given options table,
-- and returns it as an array. Nil values are not allowed.
local ret = {}
for i, page in ipairs(pages) do
ret[i] = p._formatLink{
link = page,
categorizeMissing = options.categorizeMissing,
italicizePage = options.italicizePage,
italicizeSection = options.italicizeSection
}
end
return ret
end
end


return p
return p

Revision as of 18:18, 5 September 2022

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 formatLink -- lazily initialise [[Module:Format link]] ._formatLink

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.defaultClasses(inline)
	-- Provides the default hatnote classes as a space-separated string; useful
	-- for hatnote-manipulation modules like [[Module:Hatnote group]].
	return
		(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' ..
		'navigation-not-searchable'
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 mw.ustring.format('%s (%s)', page, disambiguator)
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.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 = mw.ustring.format(
			'[[%s:%s]]',
			mw.site.namespaces[14].name,
			category
		)
	else
		category = ''
	end
	return mw.ustring.format(
		'<strong class="error">Error: %s%s.</strong>%s',
		msg,
		helpText,
		category
	)
end

local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
	--Default missing target category, exported for use in related modules
	((curNs ==  0) or (curNs == 14)) and
	'Articles with hatnote templates targeting a nonexistent page' or nil

function p.quote(title)
	--Wraps titles in quotation marks. If the title starts/ends with a quotation
	--mark, kerns that side as with {{-'}}
	local quotationMarks = {
		["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
	}
	local quoteLeft, quoteRight = -- Test if start/end are quotation marks
		quotationMarks[string.sub(title,  1,  1)],
		quotationMarks[string.sub(title, -1, -1)]
	if quoteLeft or quoteRight then
		title = mw.html.create("span"):wikitext(title)
	end
	if quoteLeft  then title:css("padding-left",  "0.15em") end
	if quoteRight then title:css("padding-right", "0.15em") end
	return '"' .. tostring(title) .. '"'
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',
			'Template:Hatnote#Errors',
			args.category
		)
	end
	return p._hatnote(s, {
		extraclasses = args.extraclasses,
		selfref = args.selfref
	})
end

function p._hatnote(s, options)
	checkType('_hatnote', 1, s, 'string')
	checkType('_hatnote', 2, options, 'table', true)
	options = options or {}
	local inline = options.inline
	local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
	local extraclasses
	if type(options.extraclasses) == 'string' then
		extraclasses = options.extraclasses
	end

	hatnote
		:attr('role', 'note')
		:addClass(p.defaultClasses(inline))
		:addClass(extraclasses)
		:addClass(options.selfref and 'selfref' or nil)
		:wikitext(s)

	return mw.getCurrentFrame():extensionTag{
		name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
	} .. tostring(hatnote)
end

return p