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.
−
end
+
-- Functions for use from other Lua modules have names beginning with an
−
 
+
-- underscore.  
−
local function removeInitialColon(s)
+
--]]
−
-- Removes the initial colon from a string, if present.
+
local p, f = {}, {}
−
return s:match('^:?(.*)')
 
−
end
 
−
 
 
−
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. Colons
 
−
-- 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('^(.-):')
 
−
if namespace then
 
−
local nsTable = mw.site.namespaces[namespace]
 
−
if nsTable then
 
−
return nsTable.id
 
−
end
 
−
end
 
−
return 0
 
−
end
 
  
−
function p.formatPages(...)
+
local function makeInvokeFunction(func)
−
-- Formats a list of pages using formatLink and returns it as an array. Nil
+
return function(frame)
−
-- values are not allowed.
+
local args = mArguments.getArgs(frame, {parentOnly = true})
−
local pages = {...}
+
return func(args)
−
local ret = {}
 
−
for i, page in ipairs(pages) do
 
−
ret[i] = p._formatLink(page)
 
 
end
 
end
−
return ret
 
−
end
 
−
 
−
function p.formatPageTables(...)
 
−
-- 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] = p._formatLink(link, display)
 
−
end
 
−
return links
 
−
end
 
−
 
−
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
 
−
-- [[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
 
−
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
 
end
  
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
−
-- Format link
+
-- Helper functions
−
--
 
−
-- 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 hatnote link}} template.
 
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
function p.formatLink(frame)
+
local function formatLink(link, display)
−
local args = getArgs(frame)
+
-- Makes a wikilink from the given link and display values. Links are
−
local link = args[1]
+
-- escaped with colons if necessary, and links to sections are detected
−
local display = args[2]
+
-- and displayed with " § " as a separator rather than the standard
−
if not link then
+
-- MediaWiki "#".
−
return p.makeWikitextError(
 
−
'no link specified',
 
−
'Template:Format hatnote link#Errors',
 
−
args.category
 
−
)
 
−
end
 
−
return p._formatLink(link, display)
 
−
end
 
−
 
 
−
function p._formatLink(link, display)
 
−
checkType('_formatLink', 1, link, 'string')
 
−
checkType('_formatLink', 2, display, 'string', true)
 
  
−
-- Remove the initial colon for links where it was specified manually.
+
-- Find whether we need to use the colon trick or not. We need to use the
−
link = removeInitialColon(link)
+
-- colon trick for categories and files, as otherwise category links
−
 
+
-- categorise the page and file links display the file.
−
-- Find whether a faux display value has been added with the {{!}} magic
+
local namespace = link:match('^(.-):')
−
-- word.
+
local colon
−
if not display then
+
if namespace and mw.site.namespaces[namespace] then
−
local prePipe, postPipe = link:match('^(.-)|(.*)$')
+
-- The start of the link is a valid namespace name; check whether it is
−
link = prePipe or link
+
-- a category or a file.
−
display = postPipe
+
local nsid = mw.site.namespaces[namespace].id
 +
if nsid == 6 or nsid == 14 then
 +
colon = ':'
 +
end
 
end
 
end
 +
colon = colon or ''
  
 
-- Find the display value.
 
-- Find the display value.
Line 162: Line 61:
 
local page, section = link:match('^(.-)#(.*)$')
 
local page, section = link:match('^(.-)#(.*)$')
 
if page then
 
if page then
−
display = page .. ' §&nbsp;' .. section
+
display = page .. ' § ' .. section
 
end
 
end
 
end
 
end
Line 168: Line 67:
 
-- Assemble the link.
 
-- Assemble the link.
 
if display then
 
if display then
−
return string.format(
+
return string.format('[[%s%s|%s]]', colon, link, display)
−
'[[:%s|%s]]',
 
−
string.gsub(link, '|(.*)$', ''), --display overwrites manual piping
 
−
display
 
−
)
 
 
else
 
else
−
return string.format('[[:%s]]', link)
+
return string.format('[[%s%s]]', colon, link)
 
end
 
end
 +
end
 +
 +
local function makeWikitextError(msg)
 +
-- Formats an error message to be returned to wikitext.
 +
return string.format('<strong class="error">Error: %s.</strong>', msg)
 
end
 
end
  
Line 184: Line 84:
 
--------------------------------------------------------------------------------
 
--------------------------------------------------------------------------------
  
−
function p.hatnote(frame)
+
function p._hatnote(s)
−
local args = getArgs(frame)
+
return string.format('<div class="dablink">%s</div>', s)
 +
end
 +
 
 +
function f.hatnote(args)
 
local s = args[1]
 
local s = args[1]
−
local options = {}
 
 
if not s then
 
if not s then
−
return p.makeWikitextError(
+
return makeWikitextError('no text specified')
−
'no text specified',
 
−
'Template:Hatnote#Errors',
 
−
args.category
 
−
)
 
 
end
 
end
−
options.extraclasses = args.extraclasses
+
return p._hatnote(s)
−
options.selfref = args.selfref
 
−
return p._hatnote(s, options)
 
 
end
 
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 classes = {'hatnote', 'navigation-not-searchable'}
+
--
−
local extraclasses = options.extraclasses
+
-- Produces a standard link to a related article. Implements the {{rellink}}
−
local selfref = options.selfref
+
-- template.
−
if type(extraclasses) == 'string' then
+
--------------------------------------------------------------------------------
−
classes[#classes + 1] = extraclasses
+
 
 +
function p._rellink(s, extraclasses)
 +
if extraclasses then
 +
extraclasses = ' ' .. extraclasses
 +
else
 +
extraclasses = ''
 
end
 
end
−
if selfref then
+
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
−
classes[#classes + 1] = 'selfref'
+
end
 +
 
 +
function f.rellink(args)
 +
local s = args[1]
 +
local extraclasses = args.extraclasses
 +
if not s then
 +
return makeWikitextError('no text specified')
 
end
 
end
−
return string.format(
+
return p._rellink(s, extraclasses)
−
'<div role="note" class="%s">%s</div>',
 
−
table.concat(classes, ' '),
 
−
s
 
−
)
 
 
end
 
end
 +
 +
p.rellink = makeInvokeFunction(f.rellink)
  
 
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"