CivWiki

Module:Hatnote: Difference between revisions

Module Discussion

Module:Hatnote (view source)

Revision as of 18:14, 5 May 2021

314 bytes removed ,  3 years ago
m
51 revisions imported from wikipedia:Module:Hatnote
(factor out some of the main code to a shared function)
m (51 revisions imported from wikipedia:Module:Hatnote)
 
(45 intermediate revisions by 9 users not shown)
Line 3:
-- --
-- This module produces hatnote links and links to related articles. It --
-- implements the {{rellinkhatnote}} and {{hatnoteformat link}} meta-templates, and a few of includes --
-- helper functions for other Lua hatnote modules. --
-- the more popular templates they depend on, including {{main}}, --
-- {{see also}}, {{further}} and {{details}}. --
--------------------------------------------------------------------------------
 
local mTableToolslibraryUtil = require('Module:TableToolslibraryUtil')
local checkType = libraryUtil.checkType
local mArguments = require('Module:Arguments')
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg
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 makeInvokeFunctionremoveInitialColon(funcs)
-- 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
 
function p.findNamespaceId(link, removeColon)
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
 
local function findNamespaceId(link)
-- 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. or ifColons
-- theare linktrimmed hasfrom beenthe escapedstart withof the colonlink trickby 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
Line 50 ⟶ 51:
end
 
local function formatLinkp.formatPages(link, display...)
-- 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
-- values are not allowed.
Line 89 ⟶ 57:
local ret = {}
for i, page in ipairs(pages) do
ret[i] = formatLink(p._formatLink{link = page)}
end
return ret
end
 
local function p.formatPageTables(pages...)
-- 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] = formatLink(p._formatLink{link = link, display) = display}
end
return links
end
 
local 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
return string.format('<strong class="error">Error: %s.</strong>', msg)
-- [[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 = 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
 
--------------------------------------------------------------------------------
-- HatnoteFormat link
--
-- Makes a wikilink from the given link and display values. Links are escaped
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- 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 link}} template.
--------------------------------------------------------------------------------
 
function p._hatnoteformatLink(sframe)
-- The formatLink export function, for use in templates.
return string.format('<div class="dablink">%s</div>', s)
yesno = require('Module:Yesno')
local args = getArgs(frame)
local link = args[1]
if not link then
return p.makeWikitextError(
'no link specified',
'Template:Format link#Errors',
args.category
)
end
return p._formatLink{
link = link,
display = args[2],
italicizePage = yesno(args.italicizepage),
italicizeSection = yesno(args.italicizesection),
}
end
 
local function f.hatnoteitalicize(argss)
-- Italicize a string.
local s = args[1]
return '<i>' .. s .. '</i>'
if not s then
return makeWikitextError('no text specified')
end
return p._hatnote(s)
end
 
local function maybeItalicize(s, shouldItalicize)
p.hatnote = makeInvokeFunction(f.hatnote)
-- italicize s if s is a string and the shouldItalicize parameter is true.
 
if s and shouldItalicize then
--------------------------------------------------------------------------------
return italicize(s)
-- Rellink
--
-- Produces a standard link to a related article. Implements the {{rellink}}
-- template.
--------------------------------------------------------------------------------
 
function p._rellink(s, extraclasses)
if extraclasses then
extraclasses = ' ' .. extraclasses
else
return s
extraclasses = ''
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end
 
local function f.rellinkparseLink(argslink)
-- Parse a link and return a table with the link's components.
local s = args[1]
-- These components are:
local extraclasses = args.extraclasses
-- - link: the link, stripped of any initial colon (always present)
if not s then
-- - page: the page name (always present)
return makeWikitextError('no text specified')
-- - section: the page name (may be nil)
end
-- - display: the display text, if manually entered after a pipe (may be nil)
return p._rellink(s, extraclasses)
link = removeInitialColon(link)
end
 
-- Find whether a faux display value has been added with the {{!}} magic
p.rellink = makeInvokeFunction(f.rellink)
-- word.
local prePipe, display = link:match('^(.-)|(.*)$')
link = prePipe or link
 
-- Find the page, if it exists.
--------------------------------------------------------------------------------
-- For links like [[#Bar]], the page will be nil.
-- Details
local preHash, postHash = link:match('^(.-)#(.*)$')
--
local page
-- Produces a "For more details on this topic" link. the first parameter is the
if not preHash then
-- page linked to, and if the second parameter is present it is used instead
-- ofWe thehave "thisa topic"link textlike [[Foo]].
page = link
--------------------------------------------------------------------------------
elseif preHash ~= '' then
 
-- We have a link like [[Foo#Bar]].
function p._details(page, topic)
page = formatLink(page)preHash
end
topic = topic or 'this topic'
local text = string.format('For more details on %s, see %s.', topic, page)
local extraclasses = 'boilerplate seealso'
return p._rellink(text, extraclasses)
end
 
-- Find the section, if it exists.
function f.details(args)
local page = args[1]section
if postHash and postHash ~= '' then
local topic = args[2]
section = postHash
if not page then
return makeWikitextError('no page specified')
end
return p._details(page, topic)
return {
link = link,
page = page,
section = section,
display = display,
}
end
 
function p._formatLink(options)
p.details = makeInvokeFunction(f.details)
-- The formatLink export function, for use in modules.
checkType('_formatLink', 1, options, 'table')
checkTypeForNamedArg('_formatLink', 'link', options.link, 'string', false)
checkTypeForNamedArg(
'_formatLink',
'display',
options.display,
'string',
true
)
checkTypeForNamedArg(
'_formatLink',
'italicizePage',
options.italicizePage,
'boolean',
true
)
checkTypeForNamedArg(
'_formatLink',
'italicizeSection',
options.italicizeSection,
'boolean',
true
)
 
local parsed = parseLink(options.link)
--------------------------------------------------------------------------------
local display = options.display or parsed.display
-- Further
--
-- Deal with the case where we don't have to pipe the link
-- Produces a "Further information: a, b and c" link. It accepts an unlimited
if not display and not parsed.section and not options.italicizePage then
-- number of positional parameters, each of which is a page name.
return string.format('[[:%s]]', parsed.link)
--------------------------------------------------------------------------------
 
function p._further(...)
local links = formatPages(...)
local text = 'Further information: ' .. mw.text.listToText(links)
return p._rellink(text)
end
 
function f.further(args)
local pages = mTableTools.compressSparseArray(args)
if #pages < 1 then
return makeWikiTextError('no pages specified')
end
return p._further(unpack(pages))
-- Find the display text for piped links
if not display then
local page = maybeItalicize(parsed.page, options.italicizePage)
local section = maybeItalicize(parsed.section, options.italicizeSection)
if not page then
display = string.format('§&nbsp;%s', section)
elseif section then
display = string.format('%s §&nbsp;%s', page, section)
else
display = page
end
end
return string.format('[[:%s|%s]]', parsed.link, display)
end
 
p.further = makeInvokeFunction(f.further)
 
--------------------------------------------------------------------------------
-- MainHatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- Produces a link to a main article or articles. If used in category or
-- category talk space, produces "The main article for this category is xxx".
-- Otherwise, produces "Main article: xxx". Accepts an unlimited number of
-- page/display tables. Non-table inputs will result in an error. The first
-- value in the table should be the page name. Omitting this will result in an
-- error, except in the case of the first table, which uses the page name as a
-- fallaback. The second value in the table is an optional display value for
-- the link. If the first page name is not in mainspace, the output uses "page"
-- instead of "article". If more than one page is specified, the function uses
-- plural forms.
--------------------------------------------------------------------------------
 
function p._mainhatnote(...frame)
local args = getArgs(frame)
-- Get the list of pages. If no first page was specified we use the current
local s = args[1]
-- page name.
local pagesoptions = {...}
if not s then
local currentTitle = mw.title.getCurrentTitle()
return p.makeWikitextError(
local firstPageTable = pages[1]
'no text specified',
local firstPage
'Template:Hatnote#Errors',
if firstPageTable then
args.category
firstPage = firstPageTable[1]
)
else
firstPage = currentTitle.text
firstPageTable = {firstPage}
pages[1] = firstPageTable
end
options.extraclasses = args.extraclasses
 
options.selfref = args.selfref
-- Find the pagetype.
return p._hatnote(s, options)
local firstPageNs = findNamespaceId(firstPage)
local pagetype = firstPageNs == 0 and 'article' or 'page'
 
-- Make the formatted link text
local links = formatPageTables(pages)
links = mw.text.listToText(links)
 
-- Build the text.
local isPlural = #pages > 1
local currentNs = currentTitle.namespace
local isCategoryNamespace = currentNs - currentNs % 2 == 14
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
 
function fp.main_hatnote(argss, options)
checkType('_hatnote', 1, s, 'string')
local pages = {}
checkType('_hatnote', 2, options, 'table', true)
for k, v in pairs(args) do
options = options or {}
if type(k) == 'number' then
local classes = {'hatnote', 'navigation-not-searchable'}
local display = args['l' .. tostring(k)]
local pageextraclasses = {v, display}options.extraclasses
local selfref = options.selfref
pages[k] = page
if type(extraclasses) == 'string' then
end
classes[#classes + 1] = extraclasses
end
if selfref then
pages = mTableTools.compressSparseArray(pages)
classes[#classes + 1] = 'selfref'
return p._main(unpack(pages))
end
return string.format(
'<div role="note" class="%s">%s</div>',
table.concat(classes, ' '),
s
)
end
 
p.main = makeInvokeFunction(f.main)
 
return p
Retrieved from "https://civwiki.org/wiki/Special:MobileDiff/29011...29055"