Module:Hatnote - Revision history

Cyclops: 1 revision imported

2023-05-22T19:58:02Z

1 revision imported

← Older revision

Revision as of 19:58, 22 May 2023

wikipedia>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)

2022-09-05T18:18:32Z

Reordered helper functions (first by export status, then alphabetically) and migrated p.quote upstream from Module:Redirect hatnote (includes contributions by Tamzin and Nihiltres)

← Older revision		Revision as of 18:18, 5 September 2022
Line 19:		Line 19:
	-- Helper functions		-- Helper functions
	--------------------------------------------------------------------------------		--------------------------------------------------------------------------------

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

	local function getArgs(frame)		local function getArgs(frame)
Line 36:		Line 30:
	-- Removes the initial colon from a string, if present.		-- Removes the initial colon from a string, if present.
	return s:match('^:?(.*)')		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		end

Line 97:		Line 108:
	end		end

	function p.~~disambiguate~~(~~page, disambiguator~~)		local curNs = mw.title.getCurrentTitle().namespace
	-- ~~Formats a page~~ title with a ~~disambiguation parenthetical,~~		p.missingTargetCat =
	-- ~~i.e.~~ "~~Example~~" → "~~Example (disambiguation)".~~		--Default missing target category, exported for use in related modules
	~~checkType(~~'~~disambiguate~~', ~~1, page~~, '~~string~~')		((curNs == 0) or (curNs == 14)) and
	~~checkType~~(~~'disambiguate'~~, 2, ~~disambiguator~~, 'string', ~~true~~)		'Articles with hatnote templates targeting a nonexistent page' or nil
	~~disambiguator = disambiguator~~ or ~~'disambiguation'~~
	~~return~~ mw.~~ustring~~.~~format~~(~~'%s~~ (%s)', ~~page~~, ~~disambiguator~~)		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

Line 141:		Line 166:
	hatnote		hatnote
	:attr('role', 'note')		:attr('role', 'note')
	:addClass(inline ~~== 1 and 'hatnote-inline' or 'hatnote'~~)		:addClass(p.defaultClasses(inline))
	~~:addClass('navigation-not-searchable'~~)
	:addClass(extraclasses)		:addClass(extraclasses)
	:addClass(options.selfref and 'selfref' or nil)		:addClass(options.selfref and 'selfref' or nil)
	:wikitext(s)		:wikitext(s)

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

Cyclops: 1 revision imported

2022-07-26T20:50:18Z

1 revision imported

← Older revision

Revision as of 20:50, 26 July 2022

wikipedia>Nihiltres: Fix for fragile conditional

2022-06-06T04:14:36Z

Fix for fragile conditional

Show changes

Cyclops: 1 revision imported

2017-03-08T17:52:34Z

1 revision imported

New page

--------------------------------------------------------------------------------
-- 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 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(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, 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 and yesno(addTrackingCategory) ~= false 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 hatnote link}} template.
--------------------------------------------------------------------------------

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',
'Template:Format hatnote link#Errors',
args.category
)
end
return p._formatLink(link, display)
end

function p._formatLink(link, display)
checkType('_formatLink', 1, link, 'string')
checkType('_formatLink', 2, display, 'string', true)

-- Remove the initial colon for links where it was specified manually.
link = removeInitialColon(link)

-- Find whether a faux display value has been added with the {{!}} magic
-- word.
if not display then
local prePipe, postPipe = link:match('^(.-)|(.*)$')
link = prePipe or link
display = postPipe
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]]',
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping
display
)
else
return string.format('[[:%s]]', link)
end
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'}
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