Editing Module:Hatnote

From MINR.ORG WIKI

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
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 {{hatnote}} and {{format link}} meta-templates and includes --
+
-- implements the {{rellink}} and {{hatnote}} meta-templates, and a few of    --
−
-- helper functions for other Lua hatnote modules.                           --
+
-- the more popular templates they depend on, including {{main}},            --
 +
-- {{see also}}, {{further}} and {{details}}.                                 --
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
local libraryUtil = require('libraryUtil')
+
local mTableTools = require('Module:TableTools')
−
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.
 +
-- Functions for use from other Lua modules have names beginning with an
 +
-- underscore.
 +
--]]
 +
local p, f = {}, {}
 +
 
 +
local function makeInvokeFunction(func)
 +
return function(frame)
 +
local args = mArguments.getArgs(frame, {parentOnly = true})
 +
return func(args)
 +
end
 
end
 
end
  
−
local function removeInitialColon(s)
+
--------------------------------------------------------------------------------
−
-- Removes the initial colon from a string, if present.
+
-- Helper functions
−
return s:match('^:?(.*)')
+
--------------------------------------------------------------------------------
−
end
 
  
−
function p.findNamespaceId(link, removeColon)
+
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. Colons
+
-- function will not work if the link is enclosed in double brackets or if
−
-- are trimmed from the start of the link by default. To skip colon
+
-- the link has been escaped with the colon trick.
−
-- 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(...)
+
local function formatLink(link, display)
−
-- Formats a list of pages using formatLink and returns it as an array. Nil
+
-- Makes a wikilink from the given link and display values. Links are
−
-- values are not allowed.
+
-- escaped with colons if necessary, and links to sections are detected
−
local pages = {...}
+
-- and displayed with " § " as a separator rather than the standard
−
local ret = {}
+
-- MediaWiki "#".
−
for i, page in ipairs(pages) do
+
 
−
ret[i] = p._formatLink(page)
+
-- 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
 
end
−
return ret
 
−
end
 
  
−
function p.formatPageTables(...)
+
-- Find the display value.
−
-- Takes a list of page/display tables and returns it as a list of
+
if not display then
−
-- formatted links. Nil values are not allowed.
+
local page, section = link:match('^(.-)#(.*)$')
−
local pages = {...}
+
if page then
−
local links = {}
+
display = page .. ' § ' .. section
−
for i, t in ipairs(pages) do
+
end
−
checkType('formatPageTables', i, t, 'table')
 
−
local link = t[1]
 
−
local display = t[2]
 
−
links[i] = p._formatLink(link, display)
 
 
end
 
end
−
return links
 
−
end
 
  
−
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
+
-- Assemble the link.
−
-- Formats an error message to be returned to wikitext. If
+
if display then
−
-- addTrackingCategory is not false after being returned from
+
return string.format('[[%s%s|%s]]', colon, link, display)
−
-- [[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
 
else
−
category = ''
+
return string.format('[[%s%s]]', colon, link)
 
end
 
end
−
return string.format(
 
−
'<strong class="error">Error: %s%s.</strong>%s',
 
−
msg,
 
−
helpText,
 
−
category
 
−
)
 
 
end
 
end
  
−
function p.disambiguate(page, disambiguator)
+
local function makeWikitextError(msg)
−
-- Formats a page title with a disambiguation parenthetical,
+
-- Formats an error message to be returned to wikitext.
−
-- i.e. "Example" → "Example (disambiguation)".
+
return string.format('<strong class="error">Error: %s.</strong>', msg)
−
checkType('disambiguate', 1, page, 'string')
 
−
checkType('disambiguate', 2, disambiguator, 'string', true)
 
−
disambiguator = disambiguator or 'disambiguation'
 
−
return string.format('%s (%s)', page, disambiguator)
 
 
end
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Format link
+
-- Hatnote
 
--
 
--
−
-- 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 hatnote link}} template.
 
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
function p.formatLink(frame)
+
function p._hatnote(s)
−
local args = getArgs(frame)
+
return string.format('<div class="dablink">%s</div>', s)
−
local link = args[1]
+
end
−
local display = args[2]
+
 
−
if not link then
+
function f.hatnote(args)
−
return p.makeWikitextError(
+
local s = args[1]
−
'no link specified',
+
if not s then
−
'Template:Format hatnote link#Errors',
+
return makeWikitextError('no text specified')
−
args.category
 
−
)
 
 
end
 
end
−
return p._formatLink(link, display)
+
return p._hatnote(s)
 
end
 
end
  
−
function p._formatLink(link, display)
+
p.hatnote = makeInvokeFunction(f.hatnote)
−
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)
+
-- Rellink
 +
--
 +
-- Produces a standard link to a related article. Implements the {{rellink}}
 +
-- template.
 +
--------------------------------------------------------------------------------
  
−
-- Find whether a faux display value has been added with the {{!}} magic
+
function p._rellink(s, extraclasses)
−
-- word.
+
if extraclasses then
−
if not display then
+
extraclasses = ' ' .. extraclasses
−
local prePipe, postPipe = link:match('^(.-)|(.*)$')
+
else
−
link = prePipe or link
+
extraclasses = ''
−
display = postPipe
 
 
end
 
end
 +
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
 +
end
  
−
-- Find the display value.
+
function f.rellink(args)
−
if not display then
+
local s = args[1]
−
local page, section = link:match('^(.-)#(.*)$')
+
local extraclasses = args.extraclasses
−
if page then
+
if not s then
−
display = page .. ' §&nbsp;' .. section
+
return makeWikitextError('no text specified')
−
end
 
 
end
 
end
 +
return p._rellink(s, extraclasses)
 +
end
 +
 +
p.rellink = makeInvokeFunction(f.rellink)
 +
 +
--------------------------------------------------------------------------------
 +
-- 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
  
−
-- 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
+
-- Further
 
--
 
--
−
-- 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.hatnote(frame)
+
function p._further(...)
−
local args = getArgs(frame)
+
local pages = {...}
−
local s = args[1]
+
local formattedPages = {}
−
local options = {}
+
for i, page in ipairs(pages) do
−
if not s then
+
formattedPages[i] = formatLink(page)
−
return p.makeWikitextError(
 
−
'no text specified',
 
−
'Template:Hatnote#Errors',
 
−
args.category
 
−
)
 
 
end
 
end
−
options.extraclasses = args.extraclasses
+
local text = 'Further information: ' .. mw.text.listToText(formattedPages)
−
options.selfref = args.selfref
+
return p._rellink(text)
−
return p._hatnote(s, options)
 
 
end
 
end
  
−
function p._hatnote(s, options)
+
function f.further(args)
−
checkType('_hatnote', 1, s, 'string')
+
local pages = mTableTools.compressSparseArray(args)
−
checkType('_hatnote', 2, options, 'table', true)
+
if #pages < 1 then
−
options = options or {}
+
return makeWikiTextError('no pages specified')
−
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
 
end
−
return string.format(
+
return p._further(unpack(pages))
−
'<div role="note" class="%s">%s</div>',
 
−
table.concat(classes, ' '),
 
−
s
 
−
)
 
 
end
 
end
 +
 +
p.further = makeInvokeFunction(f.further)
  
 
return p
 
return p

Please note that all contributions to MINR.ORG WIKI may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see MINR.ORG WIKI:Copyrights for details). Do not submit copyrighted work without permission!

Cancel Editing help (opens in new window)
Retrieved from "https://wiki.minr.org/Module:Hatnote"