|
-- --
-- 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 formatLink -- lazily initialise [[Module:Format link]] ._formatLink
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.defaultClasses(inline)
--------------------------------------------------------------------------------
-- Provides the default hatnote classes as a space-separated string; useful
-- Helper functions
-- 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
local 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. 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
end
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
local function formatLink(link, display)
-- Formats an error message to be returned to wikitext. If
-- Makes a wikilink from the given link and display values. Links are
-- addTrackingCategory is not false after being returned from
-- escaped with colons if necessary, and links to sections are detected
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
-- and displayed with " § " as a separator rather than the standard
-- MediaWikiis "#"added.
checkType('makeWikitextError', 1, msg, 'string')
checkType('makeWikitextError', 2, helpLink, 'string', true)
-- Find whether we need to use the colon trick or not. We need to use the
yesno = require('Module:Yesno')
-- colon trick for categories and files, as otherwise category links
title = title or mw.title.getCurrentTitle()
-- categorise the page and file links display the file.
-- Make the help link text.
link = link:match('^:?(.*)') -- Remove initial colon if specified.
local helpText
local namespace = findNamespaceId(link)
if helpLink then
local colon
helpText = ' ([[' .. helpLink .. '|help]])'
if namespace == 6 or namespace == 14 then
colon = ':'
else
colonhelpText = ''
end
-- Make the category text.
local category
-- Find the display value.
if not title.isTalkPage -- Don't categorise talk pages
if not display then
and title.namespace ~= 2 -- Don't categorise userspace
local page, section = link:match('^(.-)#(.*)$')
and yesno(addTrackingCategory) ~= false -- Allow opting out
if page then
then
display = page .. ' § ' .. section
category = 'Hatnote templates with errors'
end
category = mw.ustring.format(
end
'[[%s:%s]]',
mw.site.namespaces[14].name,
-- Assemble the link.
category
if display then
)
return string.format('[[%s%s|%s]]', colon, link, display)
else
category = ''
return string.format('[[%s%s]]', colon, link)
end
return mw.ustring.format(
'<strong class="error">Error: %s%s.</strong>%s',
msg,
helpText,
category
)
end
local curNs = mw.title.getCurrentTitle().namespace
local function formatPages(...)
p.missingTargetCat =
-- Formats a list of pages using formatLink and returns it as an array. Nil
--Default missing target category, exported for use in related modules
-- values are not allowed.
((curNs == 0) or (curNs == 14)) and
local pages = {...}
'Articles with hatnote templates targeting a nonexistent page' or nil
local ret = {}
for i, page in ipairs(pages) do
ret[i] = formatLink(page)
end
return ret
end
local function formatPageTablesp.quote(pagestitle)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
-- Takes a list of page/display tables and returns it as a list of
--mark, kerns that side as with {{-'}}
-- formatted links. Nil values are not allowed.
local linksquotationMarks = {}
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
for i, t in ipairs(pages) do
}
local link = t[1]
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
local display = t[2]
quotationMarks[string.sub(title, 1, 1)],
links[i] = formatLink(link, display)
quotationMarks[string.sub(title, -1, -1)]
if quoteLeft or quoteRight then
title = mw.html.create("span"):wikitext(title)
end
if quoteLeft then title:css("padding-left", "0.15em") end
return links
if quoteRight then title:css("padding-right", "0.15em") end
end
return '"' .. tostring(title) .. '"'
local function makeWikitextError(msg)
-- Formats an error message to be returned to wikitext.
return string.format('<strong class="error">Error: %s.</strong>', msg)
end
--------------------------------------------------------------------------------
function p._hatnotehatnote(sframe)
local args = getArgs(frame)
return string.format('<div class="dablink">%s</div>', s)
end
function f.hatnote(args)
local s = args[1]
if not s then
return p.makeWikitextError('no text specified')
'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)
p.hatnote = makeInvokeFunction(f.hatnote)
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
--------------------------------------------------------------------------------
options = options or {}
-- Rellink
local inline = options.inline
--
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
-- Produces a standard link to a related article. Implements the {{rellink}}
local extraclasses
-- template.
if type(options.extraclasses) == 'string' then
--------------------------------------------------------------------------------
extraclasses = options.extraclasses
function p._rellink(s, extraclasses)
if extraclasses then
extraclasses = ' ' .. extraclasses
else
extraclasses = ''
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end
hatnote
function f.rellink(args)
:attr('role', 'note')
local s = args[1]
:addClass(p.defaultClasses(inline))
local extraclasses = args.extraclasses
:addClass(extraclasses)
if not s then
:addClass(options.selfref and 'selfref' or nil)
return makeWikitextError('no text specified')
:wikitext(s)
end
return p._rellink(s, extraclasses)
end
return mw.getCurrentFrame():extensionTag{
p.rellink = makeInvokeFunction(f.rellink)
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
} .. tostring(hatnote)
--------------------------------------------------------------------------------
-- Details
--
-- Produces a "For more details on this topic" link. the first parameter is the
-- page linked to, and if the second parameter is present it is used instead
-- of the "this topic" text.
--------------------------------------------------------------------------------
function p._details(page, topic)
page = formatLink(page)
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
function f.details(args)
local page = args[1]
local topic = args[2]
if not page then
return makeWikitextError('no page specified')
end
return p._details(page, topic)
end
p.details = makeInvokeFunction(f.details)
--------------------------------------------------------------------------------
-- Further
--
-- 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._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))
end
p.further = makeInvokeFunction(f.further)
--------------------------------------------------------------------------------
-- Main
--
-- 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._main(...)
-- Get the list of pages. If no first page was specified we use the current
-- page name.
local pages = {...}
local currentTitle = mw.title.getCurrentTitle()
local firstPageTable = pages[1]
local firstPage
if firstPageTable then
firstPage = firstPageTable[1]
else
firstPage = currentTitle.text
firstPageTable = {firstPage}
pages[1] = firstPageTable
end
-- Find the pagetype.
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 f.main(args)
local pages = {}
for k, v in pairs(args) do
if type(k) == 'number' then
local display = args['l' .. tostring(k)]
local page = {v, display}
pages[k] = page
end
end
pages = mTableTools.compressSparseArray(pages)
return p._main(unpack(pages))
end
p.main = makeInvokeFunction(f.main)
--------------------------------------------------------------------------------
-- See also
--
-- Produces a "See also: a, b and c" link. The first parameter is an optional
-- alternative for the "See also" text. The following parameters are an
-- unlimited number of page/display tables. The first entry in the table is the
-- page name, and the second entry in the table is the display text.
--------------------------------------------------------------------------------
function p._seealso(altphrase, ...)
altphrase = altphrase or 'See also'
local pages = {...}
local links = formatPageTables(pages)
links = mw.text.listToText(links)
local text = altphrase .. ': ' .. links
local extraclasses = 'boilerplate seealso'
return p._rellink(text, extraclasses)
end
function f.seealso(args)
local pages = {}
for k, v in pairs(args) do
if type(k) == 'number' then
local numstring = tostring(k)
local display = args['label ' .. numstring]
or args['l' .. numstring]
local page = {v, display}
pages[k] = page
end
end
pages = mTableTools.compressSparseArray(pages)
if not pages[1] then
return makeWikitextError(
'[[Template:See also|'
.. 'Template must be given at least one article name]]'
)
end
local altphrase = args.altphrase
return p._seealso(altphrase, unpack(pages))
end
p.seealso = makeInvokeFunction(f.seealso)
return p
| 