Difference between revisions of "Module:Hatnote"
Jump to navigation
Jump to search
m (1 revision imported) |
m (1 revision imported) |
||
(3 intermediate revisions by 3 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 17: | 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 48: | Line 56: | ||
end | end | ||
return 0 | return 0 | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
Line 93: | Line 76: | ||
-- Make the category text. | -- Make the category text. | ||
local category | local category | ||
− | if not title.isTalkPage and yesno(addTrackingCategory) ~= false then | + | 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 89: | ||
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 117: | Line 103: | ||
checkType('disambiguate', 2, disambiguator, 'string', true) | checkType('disambiguate', 2, disambiguator, 'string', true) | ||
disambiguator = disambiguator or 'disambiguation' | disambiguator = disambiguator or 'disambiguation' | ||
− | return | + | return mw.ustring.format('%s (%s)', page, disambiguator) |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
Line 187: | Line 115: | ||
local args = getArgs(frame) | local args = getArgs(frame) | ||
local s = args[1] | local s = args[1] | ||
− | |||
if not s then | if not s then | ||
return p.makeWikitextError( | return p.makeWikitextError( | ||
Line 195: | Line 122: | ||
) | ) | ||
end | end | ||
− | + | return p._hatnote(s, { | |
− | + | extraclasses = args.extraclasses, | |
− | + | selfref = args.selfref | |
+ | }) | ||
end | end | ||
Line 204: | Line 132: | ||
checkType('_hatnote', 2, options, 'table', true) | checkType('_hatnote', 2, options, 'table', true) | ||
options = options or {} | options = options or {} | ||
− | local | + | local inline = options.inline |
− | local | + | local hatnote = mw.html.create(inline == 1 and 'span' or 'div') |
− | + | local extraclasses | |
− | if type(extraclasses) == 'string' then | + | if type(options.extraclasses) == 'string' then |
− | + | extraclasses = options.extraclasses | |
end | end | ||
− | + | ||
− | + | hatnote | |
− | + | :attr('role', 'note') | |
− | return | + | :addClass(inline == 1 and 'hatnote-inline' or 'hatnote') |
− | ' | + | :addClass('navigation-not-searchable') |
− | + | :addClass(extraclasses) | |
− | + | :addClass(options.selfref and 'selfref') | |
− | + | :wikitext(s) | |
+ | |||
+ | return mw.getCurrentFrame():extensionTag{ | ||
+ | name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } | ||
+ | } .. tostring(hatnote) | ||
end | end | ||
return p | return p |
Latest revision as of 15:54, 19 February 2022
Documentation for this module may be created at Module:Hatnote/doc
-------------------------------------------------------------------------------- -- 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 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) -- 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.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 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 -------------------------------------------------------------------------------- -- 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(inline == 1 and 'hatnote-inline' or 'hatnote') :addClass('navigation-not-searchable') :addClass(extraclasses) :addClass(options.selfref and 'selfref') :wikitext(s) return mw.getCurrentFrame():extensionTag{ name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } } .. tostring(hatnote) end return p