Module:Hatnote: Difference between revisions
Content added Content deleted
(add Template:Main) |
m (49 revisions imported from templatewiki:Module:Hatnote) |
||
(44 intermediate revisions by 10 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 {{ |
-- implements the {{hatnote}} and {{format link}} meta-templates and includes -- |
||
-- helper functions for other Lua hatnote modules. -- |
|||
-- the more popular templates they depend on, including {{main}}, -- |
|||
-- {{see also}}, {{further}} and {{details}}. -- |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local |
local libraryUtil = require('libraryUtil') |
||
local checkType = libraryUtil.checkType |
|||
local mArguments = require('Module:Arguments') |
|||
local mArguments -- lazily initialise [[Module:Arguments]] |
|||
local yesno -- lazily initialise [[Module:Yesno]] |
|||
local p = {} |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- Helper functions |
|||
-- Argument processing |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local function getArgs(frame) |
|||
--[[ |
|||
-- Fetches the arguments from the parent frame. Whitespace is trimmed and |
|||
-- The p table is for functions to be returned from #invoke, and for functions |
|||
-- blanks are removed. |
|||
-- to be used from other Lua modules. The f table is for functions acting as a |
|||
mArguments = require('Module:Arguments') |
|||
-- bridge between #invoke functions and Lua module functions. #invoke functions |
|||
return mArguments.getArgs(frame, {parentOnly = true}) |
|||
-- are connected to f table functions through the makeInvokeFunction function. |
|||
end |
|||
-- Functions for use from other Lua modules have names beginning with an |
|||
-- underscore. |
|||
--]] |
|||
local p, f = {}, {} |
|||
local function |
local function removeInitialColon(s) |
||
-- Removes the initial colon from a string, if present. |
|||
return function(frame) |
|||
return s:match('^:?(.*)') |
|||
local args = mArguments.getArgs(frame, {parentOnly = true}) |
|||
return func(args) |
|||
end |
|||
end |
end |
||
function p.findNamespaceId(link, removeColon) |
|||
-------------------------------------------------------------------------------- |
|||
-- Helper functions |
|||
-------------------------------------------------------------------------------- |
|||
local function findNamespaceId(link) |
|||
-- 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 |
-- 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('^(.-):') |
local namespace = link:match('^(.-):') |
||
if namespace then |
if namespace then |
||
Line 50: | Line 50: | ||
end |
end |
||
function p.formatPages(...) |
|||
-- Makes a wikilink from the given link and display values. Links are |
|||
-- escaped with colons if necessary, and links to sections are detected |
|||
-- and displayed with " § " as a separator rather than the standard |
|||
-- MediaWiki "#". |
|||
-- 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. |
|||
local namespace = findNamespaceId(link) |
|||
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 |
|||
local function formatPages(...) |
|||
-- Formats a list of pages using formatLink and returns it as an array. Nil |
-- Formats a list of pages using formatLink and returns it as an array. Nil |
||
-- values are not allowed. |
-- values are not allowed. |
||
Line 89: | Line 56: | ||
local ret = {} |
local ret = {} |
||
for i, page in ipairs(pages) do |
for i, page in ipairs(pages) do |
||
ret[i] = |
ret[i] = p._formatLink(page) |
||
end |
end |
||
return ret |
return ret |
||
end |
end |
||
function p.formatPageTables(...) |
|||
-- Takes a list of page/display tables and returns it as a list of |
|||
-- Formats an error message to be returned to wikitext. |
|||
-- formatted links. Nil values are not allowed. |
|||
return string.format('<strong class="error">Error: %s.</strong>', msg) |
|||
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 |
||
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title) |
|||
-------------------------------------------------------------------------------- |
|||
-- Formats an error message to be returned to wikitext. If |
|||
-- Hatnote |
|||
-- addTrackingCategory is not false after being returned from |
|||
-- |
|||
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category |
|||
-- Produces standard hatnote text. Implements the {{hatnote}} template. |
|||
-- is added. |
|||
-------------------------------------------------------------------------------- |
|||
checkType('makeWikitextError', 1, msg, 'string') |
|||
checkType('makeWikitextError', 2, helpLink, 'string', true) |
|||
function p._hatnote(s) |
|||
yesno = require('Module:Yesno') |
|||
return string.format('<div class="dablink">%s</div>', s) |
|||
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 and yesno(addTrackingCategory) ~= false then |
|||
category = 'Hatnote templates with errors' |
|||
category = string.format( |
|||
'[[%s:%s]]', |
|||
mw.site.namespaces[14].name, |
|||
category |
|||
) |
|||
else |
|||
category = '' |
|||
end |
|||
return string.format( |
|||
'<strong class="error">Error: %s%s.</strong>%s', |
|||
msg, |
|||
helpText, |
|||
category |
|||
) |
|||
end |
end |
||
function |
function p.disambiguate(page, disambiguator) |
||
-- Formats a page title with a disambiguation parenthetical, |
|||
local s = args[1] |
|||
-- i.e. "Example" → "Example (disambiguation)". |
|||
if not s then |
|||
checkType('disambiguate', 1, page, 'string') |
|||
return makeWikitextError('no text specified') |
|||
checkType('disambiguate', 2, disambiguator, 'string', true) |
|||
end |
|||
disambiguator = disambiguator or 'disambiguation' |
|||
return p._hatnote(s) |
|||
return string.format('%s (%s)', page, disambiguator) |
|||
end |
end |
||
p.hatnote = makeInvokeFunction(f.hatnote) |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- |
-- Format link |
||
-- |
-- |
||
-- Makes a wikilink from the given link and display values. Links are escaped |
|||
-- Produces a standard link to a related article. Implements the {{rellink}} |
|||
-- with colons if necessary, and links to sections are detected and displayed |
|||
-- template. |
|||
-- with " § " as a separator rather than the standard MediaWiki "#". Used in |
|||
-- the {{format hatnote link}} template. |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
function p. |
function p.formatLink(frame) |
||
local args = getArgs(frame) |
|||
if extraclasses then |
|||
local link = args[1] |
|||
extraclasses = ' ' .. extraclasses |
|||
local display = args[2] |
|||
else |
|||
if not link then |
|||
extraclasses = '' |
|||
return p.makeWikitextError( |
|||
'no link specified', |
|||
'Template:Format hatnote link#Errors', |
|||
args.category |
|||
) |
|||
end |
end |
||
return p._formatLink(link, display) |
|||
return string.format('<div class="rellink%s">%s</div>', extraclasses, s) |
|||
end |
end |
||
function |
function p._formatLink(link, display) |
||
checkType('_formatLink', 1, link, 'string') |
|||
local s = args[1] |
|||
checkType('_formatLink', 2, display, 'string', true) |
|||
local extraclasses = args.extraclasses |
|||
if not s then |
|||
return makeWikitextError('no text specified') |
|||
end |
|||
return p._rellink(s, extraclasses) |
|||
end |
|||
-- Remove the initial colon for links where it was specified manually. |
|||
p.rellink = makeInvokeFunction(f.rellink) |
|||
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('^(.-)|(.*)$') |
|||
-- Produces a "For more details on this topic" link. the first parameter is the |
|||
link = prePipe or link |
|||
-- page linked to, and if the second parameter is present it is used instead |
|||
display = postPipe |
|||
-- of the "this topic" text. |
|||
end |
|||
-------------------------------------------------------------------------------- |
|||
-- Find the display value. |
|||
function p._details(page, topic) |
|||
if not display then |
|||
page = formatLink(page) |
|||
local page, section = link:match('^(.-)#(.*)$') |
|||
topic = topic or 'this topic' |
|||
if page then |
|||
local text = string.format('For more details on %s, see %s.', topic, page) |
|||
display = page .. ' § ' .. section |
|||
local extraclasses = 'boilerplate seealso' |
|||
end |
|||
return p._rellink(text, extraclasses) |
|||
end |
end |
||
-- Assemble the link. |
|||
function f.details(args) |
|||
if display then |
|||
local page = args[1] |
|||
return string.format( |
|||
local topic = args[2] |
|||
'[[:%s|%s]]', |
|||
if not page then |
|||
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping |
|||
return makeWikitextError('no page specified') |
|||
display |
|||
) |
|||
else |
|||
return string.format('[[:%s]]', link) |
|||
end |
end |
||
return p._details(page, topic) |
|||
end |
end |
||
p.details = makeInvokeFunction(f.details) |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
-- |
-- Hatnote |
||
-- |
-- |
||
-- Produces standard hatnote text. Implements the {{hatnote}} template. |
|||
-- Produces a "Further information: a, b and c" link. It accepts an unlimited |
|||
-- number of positional parameters, each of which is a page name. |
|||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
function p. |
function p.hatnote(frame) |
||
local |
local args = getArgs(frame) |
||
local s = args[1] |
|||
local text = 'Further information: ' .. mw.text.listToText(links) |
|||
local options = {} |
|||
return p._rellink(text) |
|||
if not s then |
|||
end |
|||
return p.makeWikitextError( |
|||
'no text specified', |
|||
function f.further(args) |
|||
'Template:Hatnote#Errors', |
|||
local pages = mTableTools.compressSparseArray(args) |
|||
args.category |
|||
if #pages < 1 then |
|||
) |
|||
return makeWikiTextError('no pages specified') |
|||
end |
end |
||
options.extraclasses = args.extraclasses |
|||
return p._further(unpack(pages)) |
|||
options.selfref = args.selfref |
|||
return p._hatnote(s, options) |
|||
end |
end |
||
function p._hatnote(s, options) |
|||
p.further = makeInvokeFunction(f.further) |
|||
checkType('_hatnote', 1, s, 'string') |
|||
checkType('_hatnote', 2, options, 'table', true) |
|||
-------------------------------------------------------------------------------- |
|||
options = options or {} |
|||
-- Main |
|||
local classes = {'hatnote', 'navigation-not-searchable'} |
|||
-- |
|||
local extraclasses = options.extraclasses |
|||
-- Produces a link to a main article or articles. If used in category or |
|||
local selfref = options.selfref |
|||
-- category talk space, produces "The main article for this category is xxx". |
|||
if type(extraclasses) == 'string' then |
|||
-- Otherwise, produces "Main article: xxx". Accepts an unlimited number of |
|||
classes[#classes + 1] = extraclasses |
|||
-- positional parameters, each of which is a page name. If the first positional |
|||
-- parameter is not in mainspace, uses "page" instead of "article". If more |
|||
-- than one page is specified, the function uses plural forms. |
|||
-------------------------------------------------------------------------------- |
|||
function p._main(args) |
|||
-- Initialize variables. |
|||
local links, firstPage |
|||
local currentTitle = mw.title.getCurrentTitle() |
|||
-- Make the list of formatted links and find the link for the first page. |
|||
local nums = mTableTools.numKeys(args) |
|||
if nums[1] then |
|||
firstPage = args[nums[1]] |
|||
links = {} |
|||
else |
|||
firstPage = currentTitle.text |
|||
links = {formatLink(firstPage)} |
|||
end |
end |
||
if selfref then |
|||
for i, num in ipairs(nums) do |
|||
classes[#classes + 1] = 'selfref' |
|||
local link = args[num] |
|||
local display = args['l' .. tostring(num)] |
|||
links[#links + 1] = formatLink(link, display) |
|||
end |
end |
||
return string.format( |
|||
'<div role="note" class="%s">%s</div>', |
|||
-- Find the pagetype. |
|||
table.concat(classes, ' '), |
|||
local firstPageNs = findNamespaceId(firstPage) |
|||
s |
|||
local pagetype = firstPageNs == 0 and 'article' or 'page' |
|||
) |
|||
-- Build the text. |
|||
local isPlural = #links > 1 |
|||
local currentNs = currentTitle.namespace |
|||
local isCategoryNamespace = currentNs - currentNs % 2 == 14 |
|||
links = mw.text.listToText(links) |
|||
local stringToFormat |
|||
if isCategoryNamespace then |
|||
if isPlural then |
|||
stringToFormat = 'The main %ss for this' |
|||
.. ' [[Wikipedia:Categorization|category]] are %s' |
|||
else |
|||
stringToFormat = 'The main %s for this' |
|||
.. ' [[Wikipedia:Categorization|category]] is %s' |
|||
end |
|||
else |
|||
if isPlural then |
|||
stringToFormat = 'Main %ss: %s' |
|||
else |
|||
stringToFormat = 'Main %s: %s' |
|||
end |
|||
end |
|||
local text = string.format(stringToFormat, pagetype, links) |
|||
-- Pass the text to p._rellink. |
|||
local extraclasses = 'relarticle mainarticle' |
|||
return p._rellink(text, extraclasses) |
|||
end |
end |
||
p.main = makeInvokeFunction(p._main) |
|||
return p |
return p |
Latest revision as of 16:55, 30 March 2021
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 mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
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.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.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, 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 and yesno(addTrackingCategory) ~= false then
category = 'Hatnote templates with errors'
category = string.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
category
)
else
category = ''
end
return string.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 string.format('%s (%s)', page, disambiguator)
end
--------------------------------------------------------------------------------
-- Format link
--
-- Makes a wikilink from the given link and display values. Links are escaped
-- 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.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)
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]]',
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping
display
)
else
return string.format('[[:%s]]', link)
end
end
--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------
function p.hatnote(frame)
local args = getArgs(frame)
local s = args[1]
local options = {}
if not s then
return p.makeWikitextError(
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
options.extraclasses = args.extraclasses
options.selfref = args.selfref
return p._hatnote(s, options)
end
function p._hatnote(s, options)
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local classes = {'hatnote', 'navigation-not-searchable'}
local extraclasses = options.extraclasses
local selfref = options.selfref
if type(extraclasses) == 'string' then
classes[#classes + 1] = extraclasses
end
if selfref then
classes[#classes + 1] = 'selfref'
end
return string.format(
'<div role="note" class="%s">%s</div>',
table.concat(classes, ' '),
s
)
end
return p