CivWiki

Module:Hatnote: Difference between revisions

Module Discussion

Module:Hatnote (view source)

Revision as of 18:14, 5 May 2021

3,179 bytes added ,  3 years ago
m
51 revisions imported from wikipedia:Module:Hatnote
(add type check for makeWikitextError)
m (51 revisions imported from wikipedia:Module:Hatnote)
 
(32 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 includes --
-- helper functions for other Lua hatnote modules. to format hatnote links. --
--------------------------------------------------------------------------------
 
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 p = {}
Line 29 ⟶ 31:
end
 
function p._findNamespaceIdfindNamespaceId(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 truefalse.
checkType('_findNamespaceIdfindNamespaceId', 1, link, 'string')
checkType('_findNamespaceIdfindNamespaceId', 2, removeColon, 'boolean', true)
if removeColon ~= false then
link = removeInitialColon(link)
Line 49 ⟶ 51:
end
 
function p._formatPagesformatPages(...)
-- Formats a list of pages using formatLink and returns it as an array. Nil
-- values are not allowed.
Line 55 ⟶ 57:
local ret = {}
for i, page in ipairs(pages) do
ret[i] = p._formatLink({link = page)}
end
return ret
end
 
function p._formatPageTablesformatPageTables(...)
-- Takes a list of page/display tables and returns it as a list of
-- formatted links. Nil values are not allowed.
Line 66 ⟶ 68:
local links = {}
for i, t in ipairs(pages) do
checkType('_formatPageTablesformatPageTables', i, t, 'table')
local link = t[1]
local display = t[2]
links[i] = p._formatLink({link = link, display) = display}
end
return links
end
 
function p._makeWikitextErrormakeWikitextError(msg, demohelpLink, addTrackingCategory, title)
-- Formats an error message to be returned to wikitext. If demo is not nil
-- addTrackingCategory is not false after being returned from
-- or false, no error category is added.
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
checkType('_makeWikitextError', 1, msg, 'string')
-- is added.
checkType('_makeWikitextError', 2, demo, 'boolean', true)
checkType('makeWikitextError', 1, msg, 'string')
local errorCategory = 'Hatnote templates with errors'
checkType('makeWikitextError', 2, helpLink, 'string', true)
local errorCategoryLink
yesno = require('Module:Yesno')
if demo then
title = title or mw.title.getCurrentTitle()
errorCategoryLink = string.format(
-- 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
errorCategory
)
else
errorCategoryLinkcategory = ''
end
return string.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
helpText,
errorCategoryLink
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
 
Line 102 ⟶ 129:
-- 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 link}} template.
--------------------------------------------------------------------------------
 
function p.formatLink(frame)
-- The formatLink export function, for use in templates.
yesno = require('Module:Yesno')
local args = getArgs(frame)
local link = args[1]
local display = args[2]
if not link then
return p._makeWikitextErrormakeWikitextError('no link specified')
'no link specified',
'Template:Format link#Errors',
args.category
)
end
return p._formatLink(link, display){
link = link,
display = args[2],
italicizePage = yesno(args.italicizepage),
italicizeSection = yesno(args.italicizesection),
}
end
 
local function p._formatLinkitalicize(link, displays)
-- Italicize a string.
-- Find whether we need to use the colon trick or not. We need to use the
return '<i>' .. s .. '</i>'
-- colon trick for categories and files, as otherwise category links
end
-- categorise the page and file links display the file.
 
checkType('_formatLink', 1, link, 'string')
local function maybeItalicize(s, shouldItalicize)
checkType('_formatLink', 2, display, 'string', true)
-- italicize s if s is a string and the shouldItalicize parameter is true.
link = removeInitialColon(link)
if s and shouldItalicize then
local namespace = p._findNamespaceId(link, false)
return italicize(s)
local colon
if namespace == 6 or namespace == 14 then
colon = ':'
else
colonreturn = ''s
end
end
 
local function parseLink(link)
-- Find the display value.
-- Parse a link and return a table with the link's components.
if not display then
-- These components are:
local page, section = link:match('^(.-)#(.*)$')
-- - link: the link, stripped of any initial colon (always present)
if page then
display -- =- page: ..the ' §page 'name ..(always sectionpresent)
-- - section: the page name (may be nil)
end
-- - display: the display text, if manually entered after a pipe (may be nil)
link = removeInitialColon(link)
 
-- Find whether a faux display value has been added with the {{!}} magic
-- 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.
local preHash, postHash = link:match('^(.-)#(.*)$')
local page
if not preHash then
-- We have a link like [[Foo]].
page = link
elseif preHash ~= '' then
-- We have a link like [[Foo#Bar]].
page = preHash
end
 
-- AssembleFind the linksection, if it exists.
local section
if display then
if postHash and postHash ~= '' then
return string.format('[[%s%s|%s]]', colon, link, display)
section = postHash
else
return string.format('[[%s%s]]', colon, link)
end
return {
link = link,
page = page,
section = section,
display = display,
}
end
 
function p._formatLink(options)
-- 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
-- Deal with the case where we don't have to pipe the link
if not display and not parsed.section and not options.italicizePage then
return string.format('[[:%s]]', parsed.link)
end
-- 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
 
Line 157 ⟶ 268:
local options = {}
if not s then
return p._makeWikitextErrormakeWikitextError('no text specified')
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
options.extraclasses = args.extraclasses
Line 167 ⟶ 282:
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local classes = {'rellink'}
local classes = {'hatnote', 'navigation-not-searchable'}
local extraclasses = options.extraclasses
local selfref = options.selfref
Line 177 ⟶ 293:
end
return string.format(
'<div role="note" class="%s">%s</div>',
table.concat(classes, ' '),
s
Retrieved from "https://civwiki.org/wiki/Special:MobileDiff/29024...29055"