Module:Hatnote: Difference between revisions
From Roses, Tulips, & Liberty
Content added Content deleted
m (1 revision imported) |
(Reordered helper functions (first by export status, then alphabetically) and migrated p.quote upstream from Module:Redirect hatnote (includes contributions by Tamzin and Nihiltres)) |
||
Line 12: | Line 12: | ||
local mArguments -- lazily initialise [[Module:Arguments]] |
local mArguments -- lazily initialise [[Module:Arguments]] |
||
local yesno -- lazily initialise [[Module:Yesno]] |
local yesno -- lazily initialise [[Module:Yesno]] |
||
local formatLink -- lazily initialise [[Module:Format link]] ._formatLink |
|||
local p = {} |
local p = {} |
||
Line 29: | Line 30: | ||
-- Removes the initial colon from a string, if present. |
-- Removes the initial colon from a string, if present. |
||
return s:match('^:?(.*)') |
return s:match('^:?(.*)') |
||
end |
|||
function p.defaultClasses(inline) |
|||
-- Provides the default hatnote classes as a space-separated string; useful |
|||
-- for hatnote-manipulation modules like [[Module:Hatnote group]]. |
|||
return |
|||
(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' .. |
|||
'navigation-not-searchable' |
|||
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 mw.ustring.format('%s (%s)', page, disambiguator) |
|||
end |
end |
||
Line 49: | Line 67: | ||
end |
end |
||
return 0 |
return 0 |
||
end |
|||
function p.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] = p._formatLink{link = page} |
|||
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 = link, display = display} |
|||
end |
|||
return links |
|||
end |
end |
||
Line 99: | Line 92: | ||
then |
then |
||
category = 'Hatnote templates with errors' |
category = 'Hatnote templates with errors' |
||
category = |
category = mw.ustring.format( |
||
'[[%s:%s]]', |
'[[%s:%s]]', |
||
mw.site.namespaces[14].name, |
mw.site.namespaces[14].name, |
||
Line 107: | Line 100: | ||
category = '' |
category = '' |
||
end |
end |
||
return |
return mw.ustring.format( |
||
'<strong class="error">Error: %s%s.</strong>%s', |
'<strong class="error">Error: %s%s.</strong>%s', |
||
msg, |
msg, |
||
Line 115: | Line 108: | ||
end |
end |
||
local curNs = mw.title.getCurrentTitle().namespace |
|||
function p.disambiguate(page, disambiguator) |
|||
p.missingTargetCat = |
|||
-- Formats a page title with a disambiguation parenthetical, |
|||
--Default missing target category, exported for use in related modules |
|||
-- i.e. "Example" → "Example (disambiguation)". |
|||
((curNs == 0) or (curNs == 14)) and |
|||
checkType('disambiguate', 1, page, 'string') |
|||
'Articles with hatnote templates targeting a nonexistent page' or nil |
|||
checkType('disambiguate', 2, disambiguator, 'string', true) |
|||
disambiguator = disambiguator or 'disambiguation' |
|||
return string.format('%s (%s)', page, disambiguator) |
|||
end |
|||
function p.quote(title) |
|||
-------------------------------------------------------------------------------- |
|||
--Wraps titles in quotation marks. If the title starts/ends with a quotation |
|||
-- Format link |
|||
--mark, kerns that side as with {{-'}} |
|||
-- |
|||
local quotationMarks = { |
|||
-- Makes a wikilink from the given link and display values. Links are escaped |
|||
["'"]=true, ['"']=true, ['“']=true, ["‘"]=true, ['”']=true, ["’"]=true |
|||
-- 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 link}} template. |
|||
-------------------------------------------------------------------------------- |
|||
function p.formatLink(frame) |
|||
-- The formatLink export function, for use in templates. |
|||
yesno = require('Module:Yesno') |
|||
local args = getArgs(frame) |
|||
local link = args[1] |
|||
if not link then |
|||
return p.makeWikitextError( |
|||
'no link specified', |
|||
'Template:Format link#Errors', |
|||
args.category |
|||
) |
|||
end |
|||
return p._formatLink{ |
|||
link = link, |
|||
display = args[2], |
|||
italicizePage = yesno(args.italicizepage), |
|||
italicizeSection = yesno(args.italicizesection), |
|||
} |
} |
||
local quoteLeft, quoteRight = -- Test if start/end are quotation marks |
|||
end |
|||
quotationMarks[string.sub(title, 1, 1)], |
|||
quotationMarks[string.sub(title, -1, -1)] |
|||
local function italicize(s) |
|||
if quoteLeft or quoteRight then |
|||
-- Italicize a string. |
|||
title = mw.html.create("span"):wikitext(title) |
|||
return '<i>' .. s .. '</i>' |
|||
end |
|||
local function maybeItalicize(s, shouldItalicize) |
|||
-- italicize s if s is a string and the shouldItalicize parameter is true. |
|||
if s and shouldItalicize then |
|||
return italicize(s) |
|||
else |
|||
return s |
|||
end |
|||
end |
|||
local function parseLink(link) |
|||
-- Parse a link and return a table with the link's components. |
|||
-- These components are: |
|||
-- - link: the link, stripped of any initial colon (always present) |
|||
-- - page: the page name (always present) |
|||
-- - section: the page name (may be nil) |
|||
-- - display: the display text, if manually entered after a pipe (may be nil) |
|||
link = removeInitialColon(link) |
|||
-- Find whether a faux display value has been added with the {{!}} magic |
|||
-- word. |
|||
local prePipe, display = link:match('^(.-)|(.*)$') |
|||
link = prePipe or link |
|||
-- Find the page, if it exists. |
|||
-- For links like [[#Bar]], the page will be nil. |
|||
local preHash, postHash = link:match('^(.-)#(.*)$') |
|||
local page |
|||
if not preHash then |
|||
-- We have a link like [[Foo]]. |
|||
page = link |
|||
elseif preHash ~= '' then |
|||
-- We have a link like [[Foo#Bar]]. |
|||
page = preHash |
|||
end |
|||
-- Find the section, if it exists. |
|||
local section |
|||
if postHash and postHash ~= '' then |
|||
section = postHash |
|||
end |
|||
return { |
|||
link = link, |
|||
page = page, |
|||
section = section, |
|||
display = display, |
|||
} |
|||
end |
|||
function p._formatLink(options) |
|||
-- The formatLink export function, for use in modules. |
|||
checkType('_formatLink', 1, options, 'table') |
|||
checkTypeForNamedArg('_formatLink', 'link', options.link, 'string', false) |
|||
checkTypeForNamedArg( |
|||
'_formatLink', |
|||
'display', |
|||
options.display, |
|||
'string', |
|||
true |
|||
) |
|||
checkTypeForNamedArg( |
|||
'_formatLink', |
|||
'italicizePage', |
|||
options.italicizePage, |
|||
'boolean', |
|||
true |
|||
) |
|||
checkTypeForNamedArg( |
|||
'_formatLink', |
|||
'italicizeSection', |
|||
options.italicizeSection, |
|||
'boolean', |
|||
true |
|||
) |
|||
local parsed = parseLink(options.link) |
|||
local display = options.display or parsed.display |
|||
-- Deal with the case where we don't have to pipe the link |
|||
if not display and not parsed.section and not options.italicizePage then |
|||
return string.format('[[:%s]]', parsed.link) |
|||
end |
|||
-- Find the display text for piped links |
|||
if not display then |
|||
local page = maybeItalicize(parsed.page, options.italicizePage) |
|||
local section = maybeItalicize(parsed.section, options.italicizeSection) |
|||
if not page then |
|||
display = string.format('§ %s', section) |
|||
elseif section then |
|||
display = string.format('%s § %s', page, section) |
|||
else |
|||
display = page |
|||
end |
|||
end |
end |
||
if quoteLeft then title:css("padding-left", "0.15em") end |
|||
if quoteRight then title:css("padding-right", "0.15em") end |
|||
return string.format('[[:%s|%s]]', parsed.link, display) |
|||
return '"' .. tostring(title) .. '"' |
|||
end |
end |
||
Line 266: | Line 140: | ||
local args = getArgs(frame) |
local args = getArgs(frame) |
||
local s = args[1] |
local s = args[1] |
||
local options = {} |
|||
if not s then |
if not s then |
||
return p.makeWikitextError( |
return p.makeWikitextError( |
||
Line 274: | Line 147: | ||
) |
) |
||
end |
end |
||
return p._hatnote(s, { |
|||
options.extraclasses = args.extraclasses |
|||
extraclasses = args.extraclasses, |
|||
selfref = args.selfref |
|||
return p._hatnote(s, options) |
|||
}) |
|||
end |
end |
||
Line 283: | Line 157: | ||
checkType('_hatnote', 2, options, 'table', true) |
checkType('_hatnote', 2, options, 'table', true) |
||
options = options or {} |
options = options or {} |
||
local inline = options.inline |
|||
local classes = {'hatnote', 'navigation-not-searchable'} |
|||
local hatnote = mw.html.create(inline == 1 and 'span' or 'div') |
|||
local extraclasses = options.extraclasses |
|||
local |
local extraclasses |
||
if type(extraclasses) == 'string' then |
if type(options.extraclasses) == 'string' then |
||
extraclasses = options.extraclasses |
|||
end |
end |
||
if selfref then |
|||
hatnote |
|||
classes[#classes + 1] = 'selfref' |
|||
:attr('role', 'note') |
|||
end |
|||
:addClass(p.defaultClasses(inline)) |
|||
return string.format( |
|||
:addClass(extraclasses) |
|||
'%s<div role="note" class="%s">%s</div>', |
|||
:addClass(options.selfref and 'selfref' or nil) |
|||
mw.getCurrentFrame():extensionTag{ |
|||
:wikitext(s) |
|||
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } |
|||
}, |
|||
return mw.getCurrentFrame():extensionTag{ |
|||
table.concat(classes, ' '), |
|||
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } |
|||
s |
|||
} .. tostring(hatnote) |
|||
) |
|||
end |
end |
||