Module:Hatnote: Difference between revisions

Jump to navigation Jump to search

Module:Hatnote (view source)

Revision as of 17:19, 2 October 2022

546 bytes added ,  2 October 2022
m
1 revision imported
>Mr. Stradivarius
(merge rellink into hatnote, use an options table to pass options to the hatnote function, and add a tracking category for errors)
m (1 revision imported)
 
(38 intermediate revisions by 12 users not shown)
Line 3: Line 3:
--                                                                            --
--                                                                            --
-- This module produces hatnote links and links to related articles. It      --
-- This module produces hatnote links and links to related articles. It      --
-- implements the {{rellink}} and {{hatnote}} meta-templates, and includes   --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua modules to format hatnote links.           --
-- helper functions for other Lua hatnote modules.                           --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


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


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


function p._findNamespaceId(link, removeColon)
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
-- 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
-- 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
-- are trimmed from the start of the link by default. To skip colon
-- trimming, set the removeColon parameter to true.
-- trimming, set the removeColon parameter to false.
checkType('_findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 1, link, 'string')
checkType('_findNamespaceId', 2, removeColon, 'boolean', true)
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
if removeColon ~= false then
if removeColon ~= false then
link = removeInitialColon(link)
link = removeInitialColon(link)
Line 49: Line 69:
end
end


function p._formatPages(...)
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Formats a list of pages using formatLink and returns it as an array. Nil
-- Formats an error message to be returned to wikitext. If
-- values are not allowed.
-- addTrackingCategory is not false after being returned from
local pages = {...}
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
local ret = {}
-- is added.
for i, page in ipairs(pages) do
checkType('makeWikitextError', 1, msg, 'string')
ret[i] = p._formatLink(page)
checkType('makeWikitextError', 2, helpLink, 'string', true)
end
yesno = require('Module:Yesno')
return ret
title = title or mw.title.getCurrentTitle()
end
-- Make the help link text.
 
local helpText
function p._formatPageTables(...)
if helpLink then
-- Takes a list of page/display tables and returns it as a list of
helpText = ' ([[' .. helpLink .. '|help]])'
-- formatted links. Nil values are not allowed.
else
local pages = {...}
helpText = ''
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
end
return links
-- Make the category text.
end
local category
 
if not title.isTalkPage -- Don't categorise talk pages
function p._makeWikitextError(msg)
and title.namespace ~= 2 -- Don't categorise userspace
-- Formats an error message to be returned to wikitext.
and yesno(addTrackingCategory) ~= false -- Allow opting out
checkType('_makeWikitextError', 1, msg, 'string')
then
local errorCategory = 'Hatnote templates with errors'
category = 'Hatnote templates with errors'
local errorCategoryLink = errorCategory
category = mw.ustring.format(
and string.format(
'[[%s:%s]]',
'[[%s:%s]]',
mw.site.namespaces[14].name,
mw.site.namespaces[14].name,
errorCategory
category
)
)
or ''
else
return string.format(
category = ''
'<strong class="error">Error: %s.</strong>%s',
end
return mw.ustring.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
msg,
errorCategoryLink
helpText,
category
)
)
end
end


--------------------------------------------------------------------------------
local curNs = mw.title.getCurrentTitle().namespace
-- Format link
p.missingTargetCat =
--
--Default missing target category, exported for use in related modules
-- Makes a wikilink from the given link and display values. Links are escaped
((curNs ==  0) or (curNs == 14)) and
-- with colons if necessary, and links to sections are detected and displayed
'Articles with hatnote templates targeting a nonexistent page' or nil
-- with " § " as a separator rather than the standard MediaWiki "#".
--------------------------------------------------------------------------------


function p.formatLink(frame)
function p.quote(title)
local args = getArgs(frame)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
local link = args[1]
--mark, kerns that side as with {{-'}}
local display = args[2]
local quotationMarks = {
if not link then
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
return p._makeWikitextError('no link specified')
}
end
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
return p._formatLink(link, display)
quotationMarks[string.sub(title,  1,  1)],
end
quotationMarks[string.sub(title, -1, -1)]
 
if quoteLeft or quoteRight then
function p._formatLink(link, display)
title = mw.html.create("span"):wikitext(title)
-- 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 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
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 150: 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('no text specified')
return p.makeWikitextError(
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
end
options.extraclasses = args.extraclasses
return p._hatnote(s, {
options.selfref = args.selfref
extraclasses = args.extraclasses,
return p._hatnote(s, options)
selfref = args.selfref
})
end
end


Line 162: Line 156:
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
checkType('_hatnote', 2, options, 'table', true)
local classes = {'rellink'}
options = options or {}
local extraclasses = options.extraclasses
local inline = options.inline
local selfref = options.selfref
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
if type(extraclasses) == 'string' then
local extraclasses
classes[#classes + 1] = extraclasses
if type(options.extraclasses) == 'string' then
extraclasses = options.extraclasses
end
end
if selfref then
 
classes[#classes + 1] = 'selfref'
hatnote
end
:attr('role', 'note')
return string.format(
:addClass(p.defaultClasses(inline))
'<div class="%s">%s</div>',
:addClass(extraclasses)
table.concat(classes, ' '),
:addClass(options.selfref and 'selfref' or nil)
s
:wikitext(s)
)
 
return mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
} .. tostring(hatnote)
end
end


return p
return p
Retrieved from "https://wiki.randomisland.ca/wiki/Special:MobileDiff/3193...13170"

Navigation menu