fix undeclared page variable
|
Export default classes
|
||
(31 intermediate revisions by 5 users not shown) | |||
Line 9: | Line 9: | ||
local libraryUtil = require('libraryUtil') |
local libraryUtil = require('libraryUtil') |
||
local checkType = libraryUtil.checkType |
local checkType = libraryUtil.checkType |
||
local checkTypeForNamedArg = libraryUtil.checkTypeForNamedArg |
|||
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 17: | Line 19: | ||
-- Helper functions |
-- Helper functions |
||
-------------------------------------------------------------------------------- |
-------------------------------------------------------------------------------- |
||
local curNs = mw.title.getCurrentTitle().namespace |
|||
p.missingTargetCat = |
|||
--Default missing target category, exported for use in related modules |
|||
((curNs == 0) or (curNs == 14)) and |
|||
'Articles with hatnote templates targeting a nonexistent page' or nil |
|||
local function getArgs(frame) |
local function getArgs(frame) |
||
Line 22: | Line 30: | ||
-- blanks are removed. |
-- blanks are removed. |
||
mArguments = require('Module:Arguments') |
mArguments = require('Module:Arguments') |
||
return mArguments.getArgs(frame) |
return mArguments.getArgs(frame, {parentOnly = true}) |
||
end |
end |
||
Line 48: | Line 56: | ||
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(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, display) |
|||
end |
|||
return links |
|||
end |
end |
||
Line 93: | Line 76: | ||
-- Make the category text. |
-- Make the category text. |
||
local category |
local category |
||
if not title.isTalkPage |
if not title.isTalkPage -- Don't categorise talk pages |
||
and title.namespace ~= 2 -- Don't categorise userspace |
|||
and yesno(addTrackingCategory) ~= false -- Allow opting out |
|||
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 103: | Line 89: | ||
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 117: | Line 103: | ||
checkType('disambiguate', 2, disambiguator, 'string', true) |
checkType('disambiguate', 2, disambiguator, 'string', true) |
||
disambiguator = disambiguator or 'disambiguation' |
disambiguator = disambiguator or 'disambiguation' |
||
return |
return mw.ustring.format('%s (%s)', page, disambiguator) |
||
end |
end |
||
function p.defaultClasses(inline) |
|||
-------------------------------------------------------------------------------- |
|||
-- Provides the default hatnote classes as a space-separated string; useful |
|||
-- Format link |
|||
-- for hatnote-manipulation modules like [[Module:Hatnote group]]. |
|||
-- |
|||
return |
|||
-- Makes a wikilink from the given link and display values. Links are escaped |
|||
(inline == 1 and 'hatnote-inline' or 'hatnote') .. ' ' .. |
|||
-- with colons if necessary, and links to sections are detected and displayed |
|||
'navigation-not-searchable' |
|||
-- with『 § 』as a separator rather than the standard MediaWiki "#". Used in |
|||
-- the {{format hatnote link}} template. |
|||
-------------------------------------------------------------------------------- |
|||
function p.formatLink(frame) |
|||
local args = getArgs(frame) |
|||
local link = args[1] |
|||
local display = args[2] |
|||
local italicizearticle = args.italicizearticle |
|||
local italicizesection = args.italicizesection |
|||
if not link then |
|||
return p.makeWikitextError( |
|||
'no link specified', |
|||
'Template:Format hatnote link#Errors', |
|||
args.category |
|||
) |
|||
end |
|||
return p._formatLink(link, display, italicizearticle, italicizesection) |
|||
end |
|||
function p._formatLink(link, display, italicizearticle, italicizesection) |
|||
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) |
|||
|
|||
-- Find whether a faux display value has been added with the {{!}} magic |
|||
-- word. |
|||
local page |
|||
if not display then |
|||
local prePipe, postPipe = link:match('^(.-)|(.*)$') |
|||
link = prePipe or link |
|||
display = postPipe |
|||
-- Find the display value. |
|||
local page, section = link:match('^(.-)#(.*)$') |
|||
if page then |
|||
-- Italicize article title, if asked for. |
|||
if italicizearticle then |
|||
page = "''" .. page .. "''" |
|||
end |
|||
end |
|||
if section then |
|||
-- Italicize section name, if asked for. |
|||
if italicizesection then |
|||
display = page ..『 § ''』.. section .. "''" |
|||
else |
|||
display = page ..『 § 』.. section |
|||
end |
|||
end |
|||
end |
|||
|
|||
-- Assemble the link. |
|||
if display then |
|||
return string.format( |
|||
'[[:%s|%s]]', |
|||
string.gsub(link, "|(.*)$", ''), --display overwrites manual piping |
|||
display |
|||
) |
|||
elseif page then -- can happen when italicizearticle true |
|||
return string.format('[[:%s|%s]]', link, page) |
|||
else |
|||
return string.format('[[:%s]]', link) |
|||
end |
|||
end |
end |
||
Line 202: | Line 123: | ||
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 210: | Line 130: | ||
) |
) |
||
end |
end |
||
return p._hatnote(s, { |
|||
options.extraclasses = args.extraclasses |
|||
|
extraclasses = args.extraclasses, |
||
selfref = args.selfref |
|||
return p._hatnote(s, options) |
|||
}) |
|||
end |
end |
||
Line 219: | Line 140: | ||
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) |
|||
'<div role="note" class="%s">%s</div>', |
|||
:addClass(options.selfref and 'selfref' or nil) |
|||
table.concat(classes, ' '), |
|||
s |
:wikitext(s) |
||
) |
|||
return mw.getCurrentFrame():extensionTag{ |
|||
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' } |
|||
} .. tostring(hatnote) |
|||
end |
end |
||
This is the module sandbox page for Module:Hatnote (diff). See also the companion subpage for test cases (run). |
This Lua module is used in MediaWiki:Wantedpages-summary, and on approximately 1,950,000 pages, or roughly 3% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandboxor/testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This module depends on the following other modules:
|
This module uses TemplateStyles:
|
This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in hatnotes at the top of pages. It also contains a number of helper functions for use in other Lua hatnote modules.
The functions in this module cannot be used directly from #invoke, and must be used through templates instead. Please see Template:Hatnote and Template:Format link for documentation.
To load this module from another Lua module, use the following code.
local mHatnote = require('Module:Hatnote')
You can then use the functions as documented below.
mHatnote._hatnote(s, options)
Formats the string s as a hatnote. This encloses s in the tags <div class="hatnote">...</div>
. Options are provided in the options table. Options include:
The CSS of the hatnote class is defined in Module:Hatnote/styles.css.
mHatnote._hatnote('This is a hatnote.')
Produces:
<div class="hatnote">This is a hatnote.</div>
Displays as:
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
Produces:
<div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>
Displayed as:
mHatnote.findNamespaceId(link, removeColon)
Finds the namespace id of the string link, which should be a valid page name, with or without the section name. This function will not work if the page name is enclosed with square brackets. When trying to parse the namespace name, colons are removed from the start of the link by default. This is helpful if users have specified colons when they are not strictly necessary. If you do not need to check for initial colons, set removeColon to false.
mHatnote.findNamespaceId('Lion')
→ 0mHatnote.findNamespaceId('Category:Lions')
→ 14mHatnote.findNamespaceId(':Category:Lions')
→ 14mHatnote.findNamespaceId(':Category:Lions', false)
→ 0 (the namespace is detected as ":Category", rather than "Category")mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:Hatnote templates with errors (2). To suppress categorization, pass false
as third parameter of the function (addTrackingCategory
).
Examples:
mHatnote.makeWikitextError('an error has occurred')
→ Error: an error has occurred.mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')
→ Error: an error has occurred (help).For an example of how this module is used in other Lua modules, see Module:Labelled list hatnote
--------------------------------------------------------------------------------
-- Module:Hatnote --
-- --
-- This module produces hatnote links and links to related articles. It --
-- implements the {{hatnote}} and {{format link}} meta-templates and includes --
-- helper functions for other Lua hatnote modules. --
--------------------------------------------------------------------------------
local libraryUtil = require('libraryUtil')
local checkType = libraryUtil.checkType
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
--------------------------------------------------------------------------------
local curNs = mw.title.getCurrentTitle().namespace
p.missingTargetCat =
--Default missing target category, exported for use in related modules
((curNs == 0) or (curNs == 14)) and
'Articles with hatnote templates targeting a nonexistent page' or nil
local function getArgs(frame)
-- Fetches the arguments from the parent frame. Whitespace is trimmed and
-- blanks are removed.
mArguments = require('Module:Arguments')
return mArguments.getArgs(frame, {parentOnly = true})
end
local function removeInitialColon(s)
-- Removes the initial colon from a string, if present.
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.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 -- Don't categorise talk pages
and title.namespace ~= 2 -- Don't categorise userspace
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 = ''
end
return mw.ustring.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 mw.ustring.format('%s (%s)', page, disambiguator)
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
--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------
function p.hatnote(frame)
local args = getArgs(frame)
local s = args[1]
if not s then
return p.makeWikitextError(
'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)
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local inline = options.inline
local hatnote = mw.html.create(inline == 1 and 'span' or 'div')
local extraclasses
if type(options.extraclasses) == 'string' then
extraclasses = options.extraclasses
end
hatnote
:attr('role', 'note')
:addClass(p.defaultClasses(inline))
:addClass(extraclasses)
:addClass(options.selfref and 'selfref' or nil)
:wikitext(s)
return mw.getCurrentFrame():extensionTag{
name = 'templatestyles', args = { src = 'Module:Hatnote/styles.css' }
} .. tostring(hatnote)
end
return p