Nonbinary Wiki

Module:Hatnote: Difference between revisions

Module Discussion

Module:Hatnote (edit)

Revision as of 09:59, 16 November 2019

1,725 bytes removed ,  4 years ago
m
49 revisions imported from templatewiki:Module:Hatnote
m>Mr. Stradivarius
(update main function description)
m (49 revisions imported from templatewiki:Module:Hatnote)
 
(43 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 {{rellink}} and {{hatnote}} meta-templates, and a few of    --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- the more popular templates they depend on, including {{main}},            --
-- helper functions for other Lua hatnote modules.                           --
-- {{see also}}, {{further}} and {{details}}.                                 --
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


local mTableTools = require('Module:TableTools')
local libraryUtil = require('libraryUtil')
local mArguments = require('Module:Arguments')
local checkType = libraryUtil.checkType
local mArguments -- lazily initialise [[Module:Arguments]]
local yesno -- lazily initialise [[Module:Yesno]]
 
local p = {}


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Argument processing
-- Helper functions
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


--[[
local function getArgs(frame)
-- The p table is for functions to be returned from #invoke, and for functions
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- to be used from other Lua modules. The f table is for functions acting as a
-- blanks are removed.
-- bridge between #invoke functions and Lua module functions. #invoke functions
mArguments = require('Module:Arguments')
-- are connected to f table functions through the makeInvokeFunction function.
return mArguments.getArgs(frame, {parentOnly = true})
-- Functions for use from other Lua modules have names beginning with an
end
-- underscore.  
--]]
local p, f = {}, {}


local function makeInvokeFunction(func)
local function removeInitialColon(s)
return function(frame)
-- Removes the initial colon from a string, if present.
local args = mArguments.getArgs(frame, {parentOnly = true})
return s:match('^:?(.*)')
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 or if
-- function will not work if the link is enclosed in double brackets. Colons
-- the link has been escaped with the colon trick.
-- 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


local function formatLink(link, display)
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] = formatLink(page)
ret[i] = p._formatLink(page)
end
end
return ret
return ret
end
end


local function makeWikitextError(msg)
function p.formatPageTables(...)
-- Formats an error message to be returned to wikitext.
-- Takes a list of page/display tables and returns it as a list of
return string.format('<strong class="error">Error: %s.</strong>', msg)
-- 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
end


--------------------------------------------------------------------------------
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Hatnote
-- Formats an error message to be returned to wikitext. If
--
-- addTrackingCategory is not false after being returned from
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
--------------------------------------------------------------------------------
-- is added.
 
checkType('makeWikitextError', 1, msg, 'string')
function p._hatnote(s)
checkType('makeWikitextError', 2, helpLink, 'string', true)
return string.format('<div class="dablink">%s</div>', s)
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
end


function f.hatnote(args)
function p.disambiguate(page, disambiguator)
local s = args[1]
-- Formats a page title with a disambiguation parenthetical,
if not s then
-- i.e. "Example" → "Example (disambiguation)".
return makeWikitextError('no text specified')
checkType('disambiguate', 1, page, 'string')
end
checkType('disambiguate', 2, disambiguator, 'string', true)
return p._hatnote(s)
disambiguator = disambiguator or 'disambiguation'
return string.format('%s (%s)', page, disambiguator)
end
end
p.hatnote = makeInvokeFunction(f.hatnote)


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Rellink
-- Format link
--
--
-- Produces a standard link to a related article. Implements the {{rellink}}
-- Makes a wikilink from the given link and display values. Links are escaped
-- 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 hatnote link}} template.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._rellink(s, extraclasses)
function p.formatLink(frame)
if extraclasses then
local args = getArgs(frame)
extraclasses = ' ' .. extraclasses
local link = args[1]
else
local display = args[2]
extraclasses = ''
if not link then
return p.makeWikitextError(
'no link specified',
'Template:Format hatnote link#Errors',
args.category
)
end
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
return p._formatLink(link, display)
end
end


function f.rellink(args)
function p._formatLink(link, display)
local s = args[1]
checkType('_formatLink', 1, link, 'string')
local extraclasses = args.extraclasses
checkType('_formatLink', 2, display, 'string', true)
if not s then
return makeWikitextError('no text specified')
end
return p._rellink(s, extraclasses)
end


p.rellink = makeInvokeFunction(f.rellink)
-- 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
-- Details
-- word.
--
if not display then
-- Produces a "For more details on this topic" link. the first parameter is the
local prePipe, postPipe = link:match('^(.-)|(.*)$')
-- page linked to, and if the second parameter is present it is used instead
link = prePipe or link
-- of the "this topic" text.
display = postPipe
--------------------------------------------------------------------------------
end


function p._details(page, topic)
-- Find the display value.
page = formatLink(page)
if not display then
topic = topic or 'this topic'
local page, section = link:match('^(.-)#(.*)$')
local text = string.format('For more details on %s, see %s.', topic, page)
if page then
local extraclasses = 'boilerplate seealso'
display = page .. ' §&nbsp;' .. section
return p._rellink(text, extraclasses)
end
end
end


function f.details(args)
-- Assemble the link.
local page = args[1]
if display then
local topic = args[2]
return string.format(
if not page then
'[[:%s|%s]]',
return makeWikitextError('no page specified')
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping
display
)
else
return string.format('[[:%s]]', link)
end
end
return p._details(page, topic)
end
end
p.details = makeInvokeFunction(f.details)


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
-- Further
-- Hatnote
--
--
-- Produces a "Further information: a, b and c" link. It accepts an unlimited
-- Produces standard hatnote text. Implements the {{hatnote}} template.
-- number of positional parameters, each of which is a page name.
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._further(...)
function p.hatnote(frame)
local links = formatPages(...)
local args = getArgs(frame)
local text = 'Further information: ' .. mw.text.listToText(links)
local s = args[1]
return p._rellink(text)
local options = {}
end
if not s then
 
return p.makeWikitextError(
function f.further(args)
'no text specified',
local pages = mTableTools.compressSparseArray(args)
'Template:Hatnote#Errors',
if #pages < 1 then
args.category
return makeWikiTextError('no pages specified')
)
end
end
return p._further(unpack(pages))
options.extraclasses = args.extraclasses
options.selfref = args.selfref
return p._hatnote(s, options)
end
end


p.further = makeInvokeFunction(f.further)
function p._hatnote(s, options)
 
checkType('_hatnote', 1, s, 'string')
--------------------------------------------------------------------------------
checkType('_hatnote', 2, options, 'table', true)
-- Main
options = options or {}
--
local classes = {'hatnote', 'navigation-not-searchable'}
-- Produces a link to a main article or articles. If used in category or
local extraclasses = options.extraclasses
-- category talk space, produces "The main article for this category is xxx".
local selfref = options.selfref
-- Otherwise, produces "Main article: xxx". Accepts a table of arguments.
if type(extraclasses) == 'string' then
-- Numerical keys for this table are the page names. If the first page name is
classes[#classes + 1] = extraclasses
-- not in mainspace, uses "page" instead of "article". If more than one page is
-- specified, the function uses plural forms. Display names can be specified for
-- each page name by using the arguments l1, l2, etc.
--------------------------------------------------------------------------------
 
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
for i, num in ipairs(nums) do
if selfref then
local link = args[num]
classes[#classes + 1] = 'selfref'
local display = args['l' .. tostring(num)]
links[#links + 1] = formatLink(link, display)
end
 
-- Find the pagetype.
local firstPageNs = findNamespaceId(firstPage)
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
end
local text = string.format(stringToFormat, pagetype, links)
return string.format(
 
'<div role="note" class="%s">%s</div>',
-- Pass the text to p._rellink.
table.concat(classes, ' '),
local extraclasses = 'relarticle mainarticle'
s
return p._rellink(text, extraclasses)
)
end
end
p.main = makeInvokeFunction(p._main)


return p
return p
Retrieved from "https://nonbinary.wiki/wiki/Special:MobileDiff/20242...20284"