Module:Hatnote: Difference between revisions

Jump to navigation Jump to search

Module:Hatnote (view source)

Revision as of 03:11, 24 April 2014

5,144 bytes removed ,  24 April 2014
split main, see also, further and details out into their own templates, make formatLink available from #invoke, make other helper functions available from other Lua modules, and add type checks
>Mr. Stradivarius
m (fix typo in function name)
>Mr. Stradivarius
(split main, see also, further and details out into their own templates, make formatLink available from #invoke, make other helper functions available from other Lua modules, and add type checks)
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 {{rellink}} and {{hatnote}} meta-templates, and includes   --
-- the more popular templates they depend on, including {{main}},            --
-- helper functions for other Lua modules to format hatnote links.           --
-- {{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 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, removeColon)
-- 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. If the
-- function will not work if the link is enclosed in double brackets. If the
-- removeColon parameter is set to true, the function will remove initial
-- removeColon parameter is set to true, the function will remove initial
-- colons from the link.
-- colons from the link.
checkType('_findNamespaceId', 1, link, 'string')
checkType('_findNamespaceId', 2, removeColon, 'boolean', true)
if removeColon then
if removeColon then
link = link:match('^:?(.*)')
link = removeInitialColon(link)
end
end
local namespace = link:match('^(.-):')
local namespace = link:match('^(.-):')
Line 54: Line 49:
end
end


local function formatLink(link, display)
function p._formatPages(...)
-- Makes a wikilink from the given link and display values. Links are
-- Formats a list of pages using formatLink and returns it as an array. Nil
-- escaped with colons if necessary, and links to sections are detected
-- values are not allowed.
-- and displayed with " § " as a separator rather than the standard
local pages = {...}
-- MediaWiki "#".
local ret = {}
for i, page in ipairs(pages) do
ret[i] = p._formatLink(page)
end
return ret
end
 
function p._formatPageTables(pages)
-- Takes a list of page/display tables and returns it as a list of
-- formatted links. Nil values are not allowed.
checkType('_formatPageTables', 1, pages, 'table')
local links = {}
for i, t in ipairs(pages) do
local link = t[1]
local display = t[2]
links[i] = p._formatLink(link, display)
end
return links
end


function p._makeWikitextError(msg)
-- Formats an error message to be returned to wikitext.
checkType('_makeWikitextError', 1, msg, 'string')
return string.format('<strong class="error">Error: %s.</strong>', msg)
end
--------------------------------------------------------------------------------
-- Format link
--
-- 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 "#".
--------------------------------------------------------------------------------
function p.formatLink(frame)
local args = getArgs(frame)
local link = args[1]
local display = args[2]
if not link then
return p._makeWikitextError('no link specified')
end
return p._formatLink(link, display)
end
function p._formatLink(link, display)
-- Find whether we need to use the colon trick or not. We need to use the
-- 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
-- colon trick for categories and files, as otherwise category links
-- categorise the page and file links display the file.
-- categorise the page and file links display the file.
link = link:match('^:?(.*)') -- Remove initial colon if specified.
checkType('_formatLink', 1, link, 'string')
local namespace = findNamespaceId(link)
checkType('_formatLink', 2, display, 'string', true)
link = removeInitialColon(link)
local namespace = p._findNamespaceId(link)
local colon
local colon
if namespace == 6 or namespace == 14 then
if namespace == 6 or namespace == 14 then
Line 86: Line 126:
return string.format('[[%s%s]]', colon, link)
return string.format('[[%s%s]]', colon, link)
end
end
end
local function formatPages(...)
-- Formats a list of pages using formatLink and returns it as an array. Nil
-- values are not allowed.
local pages = {...}
local ret = {}
for i, page in ipairs(pages) do
ret[i] = formatLink(page)
end
return ret
end
local function formatPageTables(pages)
-- Takes a list of page/display tables and returns it as a list of
-- formatted links. Nil values are not allowed.
local links = {}
for i, t in ipairs(pages) do
local link = t[1]
local display = t[2]
links[i] = formatLink(link, display)
end
return links
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 122: Line 134:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._hatnote(s)
function p.hatnote(frame)
return string.format('<div class="dablink">%s</div>', s)
local args = getArgs(frame)
end
 
function f.hatnote(args)
local s = args[1]
local s = args[1]
if not s then
if not s then
return makeWikitextError('no text specified')
return p._makeWikitextError('no text specified')
end
end
return p._hatnote(s)
return p._hatnote(s)
end
end


p.hatnote = makeInvokeFunction(f.hatnote)
function p._hatnote(s)
checkType('_hatnote', 1, s, 'string')
return string.format('<div class="dablink">%s</div>', s)
end


--------------------------------------------------------------------------------
--------------------------------------------------------------------------------
Line 143: Line 155:
--------------------------------------------------------------------------------
--------------------------------------------------------------------------------


function p._rellink(s, extraclasses)
function p.rellink(frame)
if extraclasses then
local args = getArgs(frame)
extraclasses = ' ' .. extraclasses
else
extraclasses = ''
end
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
end
 
function f.rellink(args)
local s = args[1]
local s = args[1]
local extraclasses = args.extraclasses
local extraclasses = args.extraclasses
if not s then
if not s then
return makeWikitextError('no text specified')
return p._makeWikitextError('no text specified')
end
end
return p._rellink(s, extraclasses)
return p._rellink(s, extraclasses)
end
end


p.rellink = makeInvokeFunction(f.rellink)
function p._rellink(s, extraclasses)
 
checkType('_rellink', 1, s, 'string')
--------------------------------------------------------------------------------
checkType('_rellink', 2, extraclasses, 'string', true)
-- Details
if extraclasses then
--
extraclasses = ' ' .. extraclasses
-- 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
else
firstPage = currentTitle.text
extraclasses = ''
firstPageTable = {firstPage}
pages[1] = firstPageTable
end
end
 
return string.format('<div class="rellink%s">%s</div>', extraclasses, s)
-- Find the pagetype.
local firstPageNs = findNamespaceId(firstPage, true)
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
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
return p
Anonymous user
Retrieved from "https://wiki.randomisland.ca/wiki/Special:MobileDiff/3188"

Navigation menu