Module:Hatnote: Difference between revisions
Jump to navigation
Jump to search
Content deleted Content added
Added a simple p.disambiguate(page [, disambiguator]) helper function |
m 1 revision imported from wikipedia:Module:Hatnote |
||
(24 intermediate revisions by 10 users not shown) | |||
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]] |
||
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink |
|||
local p = {} |
local p = {} |
||
Line 28: | 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 48: | Line 67: | ||
end |
end |
||
return 0 |
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 |
end |
||
Line 93: | Line 87: | ||
-- Make the category text. |
-- Make the category text. |
||
local category |
local category |
||
if not title.isTalkPage |
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 = |
category = mw.ustring.format( |
||
'[[%s:%s]]', |
'[[%s:%s]]', |
||
mw.site.namespaces[14].name, |
mw.site.namespaces[14].name, |
||
Line 103: | Line 100: | ||
category = '' |
category = '' |
||
end |
end |
||
return |
return mw.ustring.format( |
||
'<strong class="error">Error: %s%s.</strong>%s', |
'<strong class="error">Error: %s%s.</strong>%s', |
||
msg, |
msg, |
||
Line 111: | Line 108: | ||
end |
end |
||
local curNs = mw.title.getCurrentTitle().namespace |
|||
function p.disambiguate(page, disambiguator) |
|||
p.missingTargetCat = |
|||
-- Formats a page title with a disambiguation parenthetical, |
|||
--Default missing target category, exported for use in related modules |
|||
-- i.e. "Example" → "Example (disambiguation)". |
|||
((curNs == 0) or (curNs == 14)) and |
|||
checkType('disambiguate', 1, page, 'string') |
|||
'Articles with hatnote templates targeting a nonexistent page' or nil |
|||
checkType('disambiguate', 2, disambiguator, 'string', true) |
|||
disambiguator = disambiguator or 'disambiguation' |
|||
return string.format('%s (%s)', page, disambiguator) |
|||
end |
|||
function p.quote(title) |
|||
-------------------------------------------------------------------------------- |
|||
--Wraps titles in quotation marks. If the title starts/ends with a quotation |
|||
-- Format link |
|||
--mark, kerns that side as with {{-'}} |
|||
-- |
|||
local quotationMarks = { |
|||
-- Makes a wikilink from the given link and display values. Links are escaped |
|||
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true |
|||
-- with colons if necessary, and links to sections are detected and displayed |
|||
} |
|||
-- with " § " as a separator rather than the standard MediaWiki "#". Used in |
|||
local quoteLeft, quoteRight = -- Test if start/end are quotation marks |
|||
-- the {{format hatnote link}} template. |
|||
quotationMarks[string.sub(title, 1, 1)], |
|||
-------------------------------------------------------------------------------- |
|||
quotationMarks[string.sub(title, -1, -1)] |
|||
if quoteLeft or quoteRight then |
|||
function p.formatLink(frame) |
|||
title = mw.html.create("span"):wikitext(title) |
|||
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]]', link, display) |
|||
else |
|||
return string.format('[[:%s]]', link) |
|||
end |
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 183: | Line 140: | ||
local args = getArgs(frame) |
local args = getArgs(frame) |
||
local s = args[1] |
local s = args[1] |
||
local options = {} |
|||
if not s then |
if not s then |
||
return p.makeWikitextError( |
return p.makeWikitextError( |
||
Line 191: | Line 147: | ||
) |
) |
||
end |
end |
||
return p._hatnote(s, { |
|||
options.extraclasses = args.extraclasses |
|||
extraclasses = args.extraclasses, |
|||
selfref = args.selfref |
|||
return p._hatnote(s, options) |
|||
}) |
|||
end |
end |
||
Line 200: | Line 157: | ||
checkType('_hatnote', 2, options, 'table', true) |
checkType('_hatnote', 2, options, 'table', true) |
||
options = options or {} |
options = options or {} |
||
local |
local inline = options.inline |
||
local hatnote = mw.html.create(inline == 1 and 'span' or 'div') |
|||
local extraclasses = options.extraclasses |
|||
local |
local extraclasses |
||
if type(extraclasses) == 'string' then |
if type(options.extraclasses) == 'string' then |
||
extraclasses = options.extraclasses |
|||
end |
end |
||
if selfref then |
|||
hatnote |
|||
classes[#classes + 1] = 'selfref' |
|||
:attr('role', 'note') |
|||
end |
|||
:addClass(p.defaultClasses(inline)) |
|||
return string.format( |
|||
:addClass(extraclasses) |
|||
'<div role="note" class="%s">%s</div>', |
|||
:addClass(options.selfref and 'selfref' or nil) |
|||
table.concat(classes, ' '), |
|||
s |
:wikitext(s) |
||
) |
|||
return mw.getCurrentFrame():extensionTag{ |
|||
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } |
|||
} .. tostring(hatnote) |
|||
end |
end |
||
Latest revision as of 13:51, 1 December 2022
This module is invoked by the {{Hatnote}} template, which is used by a number of Notice templates.
--------------------------------------------------------------------------------
-- 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