TEPwiki

Module:Hatnote: Difference between revisions

Module Discussion

Module:Hatnote (view source)

Revision as of 05:35, 15 October 2022

943 bytes added ,  1 year ago
m
10 revisions imported from wikipedia:Module:Hatnote
m (10 revisions imported from wikipedia:Module:Hatnote)
 
(63 intermediate revisions by 16 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 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
 
local function formatLinkp.disambiguate(linkpage, displaydisambiguator)
-- Formats a page title with a disambiguation parenthetical,
-- Makes a wikilink from the given link and display values. Links are
-- i.e. "Example" → "Example (disambiguation)".
-- escaped with colons if necessary, and links to sections are detected
checkType('disambiguate', 1, page, 'string')
-- and displayed with " § " as a separator rather than the standard
checkType('disambiguate', 2, disambiguator, 'string', true)
-- MediaWiki "#".
disambiguator = disambiguator or 'disambiguation'
return mw.ustring.format('%s (%s)', page, disambiguator)
end
 
function p.findNamespaceId(link, removeColon)
-- Find whether we need to use the colon trick or not. We need to use the
-- Finds the namespace id (namespace number) of a link or a pagename. This
-- colon trick for categories and files, as otherwise category links
-- function will not work if the link is enclosed in double brackets. Colons
-- categorise the page and file links display the file.
-- 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 colon
if local namespacensTable and= mw.site.namespaces[namespace] then
if nsTable then
-- The start of the link is a valid namespace name; check whether it is
return nsTable.id
-- a category or a file.
local nsid = mw.site.namespaces[namespace].id
if nsid == 6 or nsid == 14 then
colon = ':'
end
end
return 0
colon = colon or ''
end
 
function p.makeWikitextError(msg, helpLink, addTrackingCategory, title)
-- Find the display value.
-- Formats an error message to be returned to wikitext. If
if not display then
-- addTrackingCategory is not false after being returned from
local page, section = link:match('^(.-)#(.*)$')
-- [[Module:Yesno]], and if we are not on a talk page, a tracking category
if page then
-- is added.
display = page .. ' § ' .. section
checkType('makeWikitextError', 1, msg, 'string')
end
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
-- Assemble the link.
if not title.isTalkPage -- Don't categorise talk pages
if display then
and title.namespace ~= 2 -- Don't categorise userspace
return string.format('[[%s%s|%s]]', colon, link, display)
and yesno(addTrackingCategory) ~= false -- Allow opting out
then
category = 'Hatnote templates with errors'
category = mw.ustring.format(
'[[%s:%s]]',
mw.site.namespaces[14].name,
category
)
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 makeWikitextError(msg)
p.missingTargetCat =
-- Formats an error message to be returned to wikitext.
--Default missing target category, exported for use in related modules
return string.format('<strong class="error">Error: %s.</strong>', msg)
((curNs == 0) or (curNs == 14)) and
'Articles with hatnote templates targeting a nonexistent page' or nil
 
function p.quote(title)
--Wraps titles in quotation marks. If the title starts/ends with a quotation
--mark, kerns that side as with {{-'}}
local quotationMarks = {
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true
}
local quoteLeft, quoteRight = -- Test if start/end are quotation marks
quotationMarks[string.sub(title, 1, 1)],
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
if quoteRight then title:css("padding-right", "0.15em") end
return '"' .. tostring(title) .. '"'
end
 
Line 84 ⟶ 137:
--------------------------------------------------------------------------------
 
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)
 
return p
TheInferiorDyl
verified
2,504

edits

Retrieved from "https://tep.wiki/wiki/Special:MobileDiff/7645...60698"