Synth DIY Wiki

Module:Hatnote: Difference between revisions

Module Talk

Module:Hatnote (view source)

Revision as of 17:41, 4 January 2022

1,314 bytes removed ,  2 years ago
Updated from sandbox with namespace filtering for maintenance category
m (1 revision)
(Updated from sandbox with namespace filtering for maintenance category)
Line 3:
-- --
-- This module produces hatnote links and links to related articles. It --
-- implements the {{hatnote}} and {{format hatnote link}} meta-templates, and includes --
-- 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 = {}
Line 17 ⟶ 19:
-- 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)
Line 34 ⟶ 42:
-- 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 truefalse.
checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
Line 50 ⟶ 58:
end
 
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
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)
-- Formats an error message to be returned to wikitext. If
-- addTrackingCategory is not false after being returned from
Line 83 ⟶ 66:
checkType('makeWikitextError', 2, helpLink, 'string', true)
yesno = require('Module:Yesno')
local title = title or mw.title.getCurrentTitle()
-- Make the help link text.
local helpText
Line 93 ⟶ 76:
-- Make the category text.
local category
if not title.isTalkPage and-- yesno(addTrackingCategory)Don't ~=categorise falsetalk thenpages
and title.namespace ~= 2 -- Don't categorise userspace
and yesno(addTrackingCategory) ~= false -- Allow opting out
then
category = 'Hatnote templates with errors'
category = stringmw.ustring.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
Line 103 ⟶ 89:
category = ''
end
return stringmw.ustring.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
Line 111 ⟶ 97:
end
 
function p.disambiguate(page, disambiguator)
--------------------------------------------------------------------------------
-- Formats a page title with a disambiguation parenthetical,
-- Format link
-- i.e. "Example" → "Example (disambiguation)".
--
checkType('disambiguate', 1, page, 'string')
-- Makes a wikilink from the given link and display values. Links are escaped
checkType('disambiguate', 2, disambiguator, 'string', true)
-- with colons if necessary, and links to sections are detected and displayed
disambiguator = disambiguator or 'disambiguation'
-- with " § " as a separator rather than the standard MediaWiki "#". Used in
return mw.ustring.format('%s (%s)', page, disambiguator)
-- 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)
-- 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, false)
local colon
if namespace == 6 or namespace == 14 then
colon = ':'
else
colon = ''
end
 
-- 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|%s]]', colon, link, display)
else
return string.format('[[%s%s]]', colon, link)
end
end
 
Line 182 ⟶ 115:
local args = getArgs(frame)
local s = args[1]
local options = {}
if not s then
return p.makeWikitextError(
Line 190 ⟶ 122:
)
end
return p._hatnote(s, {
options.extraclasses = args.extraclasses
options.selfref extraclasses = args.selfrefextraclasses,
selfref = args.selfref
return p._hatnote(s, options)
})
end
 
Line 198 ⟶ 131:
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local classes = {'hatnote'}
local extraclassesinline = options.extraclassesinline
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
local selfref = options.selfref
iflocal type(extraclasses) == 'string' then
if type(options.extraclasses) == 'string' then
classes[#classes + 1] = extraclasses
extraclasses = options.extraclasses
end
 
if selfref then
hatnote
classes[#classes + 1] = 'selfref'
:attr('role', 'note')
end
:addClass(inline == 1 and 'hatnote-inline' or 'hatnote')
return string.format(
:addClass('navigation-not-searchable')
'<div class="%s">%s</div>',
:addClass(extraclasses)
table.concat(classes, ' '),
:addClass(options.selfref and 'selfref')
s
:wikitext(s)
)
return mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
} .. tostring(hatnote)
end
 
Anonymous user
Retrieved from "https://sdiy.info/wiki/Special:MobileDiff/19666"