TechInfoDepot

Module:Hatnote: Difference between revisions

Module Discussion

Module:Hatnote (edit)

Revision as of 13:05, 22 December 2023

423 bytes added ,  22 December 2023
m
1 revision imported
(Reordered helper functions (first by export status, then alphabetically) and migrated p.quote upstream from Module:Redirect hatnote (includes contributions by Tamzin and Nihiltres))
m (1 revision imported)
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 {{hatnote}} and {{format link}} meta-templates and includes --
-- implements the {{hatnote}} and {{format hatnote link}} meta-templates, and --
-- helper functions for other Lua hatnote modules.                           --
-- includes 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 yesno -- lazily initialise [[Module:Yesno]]
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink


local p = {}
local p = {}
Line 30: Line 28:
-- 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 53: Line 34:
-- 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 false.
-- trimming, set the removeColon parameter to true.
checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 1, link, 'string')
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
checkType('findNamespaceId', 2, removeColon, 'boolean', true)
Line 69: Line 50:
end
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
-- Formats an error message to be returned to wikitext. If
-- addTrackingCategory is not false after being returned from
-- addTrackingCategory is not false after being returned from
Line 77: Line 83:
checkType('makeWikitextError', 2, helpLink, 'string', true)
checkType('makeWikitextError', 2, helpLink, 'string', true)
yesno = require('Module:Yesno')
yesno = require('Module:Yesno')
title = title or mw.title.getCurrentTitle()
local title = mw.title.getCurrentTitle()
-- Make the help link text.
-- Make the help link text.
local helpText
local helpText
Line 87: Line 93:
-- Make the category text.
-- Make the category text.
local category
local category
if not title.isTalkPage -- Don't categorise talk pages
if not title.isTalkPage and yesno(addTrackingCategory) ~= false then
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 = mw.ustring.format(
category = string.format(
'[[%s:%s]]',
'[[%s:%s]]',
mw.site.namespaces[14].name,
mw.site.namespaces[14].name,
Line 100: Line 103:
category = ''
category = ''
end
end
return mw.ustring.format(
return string.format(
'<strong class="error">Error: %s%s.</strong>%s',
'<strong class="error">Error: %s%s.</strong>%s',
msg,
msg,
Line 108: Line 111:
end
end


local curNs = mw.title.getCurrentTitle().namespace
--------------------------------------------------------------------------------
p.missingTargetCat =
-- Format link
--Default missing target category, exported for use in related modules
--
((curNs ==  0) or (curNs == 14)) and
-- Makes a wikilink from the given link and display values. Links are escaped
'Articles with hatnote templates targeting a nonexistent page' or nil
-- 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.quote(title)
function p.formatLink(frame)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
local args = getArgs(frame)
--mark, kerns that side as with {{-'}}
local link = args[1]
local quotationMarks = {
local display = args[2]
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
if not link then
}
return p.makeWikitextError(
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
'no link specified',
quotationMarks[string.sub(title,  1,  1)],
'Template:Format hatnote link#Errors',
quotationMarks[string.sub(title, -1, -1)]
args.category
if quoteLeft or quoteRight then
)
title = mw.html.create("span"):wikitext(title)
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
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 140: Line 182:
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 147: Line 190:
)
)
end
end
return p._hatnote(s, {
options.extraclasses = args.extraclasses
extraclasses = args.extraclasses,
options.selfref = args.selfref
selfref = args.selfref
return p._hatnote(s, options)
})
end
end


Line 156: Line 198:
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local classes = {'hatnote'}
local inline = options.inline
local extraclasses = options.extraclasses
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
local selfref = options.selfref
local extraclasses
if type(extraclasses) == 'string' then
if type(options.extraclasses) == 'string' then
classes[#classes + 1] = extraclasses
extraclasses = options.extraclasses
end
if selfref then
classes[#classes + 1] = 'selfref'
end
end
 
return string.format(
hatnote
'<div class="%s">%s</div>',
:attr('role', 'note')
table.concat(classes, ' '),
:addClass(p.defaultClasses(inline))
s
: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
end


return p
return p
Retrieved from "http://darkhaven.org/mediawiki/index.php?title=Special:MobileDiff/5449"