Difference between revisions of "Module:Hatnote"
m (52 revisions imported) |
(Blackwikiadmin changed the content model of the page Module:Hatnote from "wikitext" to "Scribunto") Tag: content model change |
||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | < | + | -------------------------------------------------------------------------------- |
| − | {{ | + | -- 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 p = {} | ||
| + | |||
| + | -------------------------------------------------------------------------------- | ||
| + | -- Helper functions | ||
| + | -------------------------------------------------------------------------------- | ||
| + | |||
| + | 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.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 | ||
| + | |||
| + | 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 = 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 | ||
| + | |||
| + | -------------------------------------------------------------------------------- | ||
| + | -- 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 "#". 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), | ||
| + | } | ||
| + | end | ||
| + | |||
| + | local function italicize(s) | ||
| + | -- Italicize a string. | ||
| + | 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 | ||
| + | |||
| + | return string.format('[[:%s|%s]]', parsed.link, display) | ||
| + | end | ||
| + | |||
| + | -------------------------------------------------------------------------------- | ||
| + | -- Hatnote | ||
| + | -- | ||
| + | -- Produces standard hatnote text. Implements the {{hatnote}} template. | ||
| + | -------------------------------------------------------------------------------- | ||
| + | |||
| + | function p.hatnote(frame) | ||
| + | local args = getArgs(frame) | ||
| + | local s = args[1] | ||
| + | local options = {} | ||
| + | if not s then | ||
| + | return p.makeWikitextError( | ||
| + | 'no text specified', | ||
| + | 'Template:Hatnote#Errors', | ||
| + | args.category | ||
| + | ) | ||
| + | end | ||
| + | options.extraclasses = args.extraclasses | ||
| + | options.selfref = args.selfref | ||
| + | return p._hatnote(s, options) | ||
| + | end | ||
| + | |||
| + | function p._hatnote(s, options) | ||
| + | checkType('_hatnote', 1, s, 'string') | ||
| + | checkType('_hatnote', 2, options, 'table', true) | ||
| + | options = options or {} | ||
| + | local classes = {'hatnote', 'navigation-not-searchable'} | ||
| + | local extraclasses = options.extraclasses | ||
| + | local selfref = options.selfref | ||
| + | if type(extraclasses) == 'string' then | ||
| + | classes[#classes + 1] = extraclasses | ||
| + | end | ||
| + | if selfref then | ||
| + | classes[#classes + 1] = 'selfref' | ||
| + | end | ||
| + | return string.format( | ||
| + | '<div role="note" class="%s">%s</div>', | ||
| + | table.concat(classes, ' '), | ||
| + | s | ||
| + | ) | ||
| + | end | ||
| + | |||
| + | return p | ||
Latest revision as of 14:29, 22 September 2020
| This Lua module is used on approximately 1,420,000 pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. Transclusion count updated automatically (see documentation). |
| This module depends on the following other modules: |
This template produces formatted text, following the guideline for a Wikipedia hatnote.
{{hatnote|Example hatnote text.}}→
Broadly speaking, a hatnote should answer a reader's question (maybe preemptively): Am I on the right page?
Function
This template is primarily used to add a correctly formatted hatnote to a page. Often, but not always, this is a disambiguation link at the top of article pages. It places an HTML div- / div block around the text entered as its only argument, which provides standardized formatting (contents are indented and italicized in most displays); it also isolates the contained code to make sure that it is interpreted correctly.
This template is also used as the "meta-template" for additional specialized disambiguation link templates; see Category:Hatnote templates for a list.
The template does not automatically create links of any kind. Links and other desired formatting must be explicitly added, using normal Wikipedia markup.
Usage
- Basic usage
{{hatnote|text}}
- All parameters
{{hatnote|text|extraclasses=extra classes|selfref=yes|category=no}}
Parameters
This template accepts the following parameters:
1– the hatnote text (required)extraclasses– any extra CSS classes to be added, for example, the {{see also}} template adds the classes "|extraclasses=boilerplate seealso".selfref– If set to "yes", "y", "true" or "1", adds the CSS class "selfref". This is used to denote self-references to Wikipedia. See Template:Selfref for more information.category– If set to "no", "n", "false", or "0", suppresses the error tracking category (Category:Hatnote templates with errors). This has an effect only if the leftmost parameter (the hatnote text) is omitted.
Example
{{hatnote|Example hatnote text}}→
Errors
If no hatnote text is supplied, the template will output the following message:
- Error: no text specified (help).
If you see this error message, it is for one of four reasons:
- No parameters were specified (the template code was
{{hatnote}}). Please use{{hatnote|text}}instead. - Some parameters were specified, but the hatnote text wasn't included. For example, the template text
{{hatnote|extraclasses=seealso}}will produce this error. Please use (for example){{hatnote|text|extraclasses=seealso}}instead. - The hatnote text was specified, but that text contains an equals sign ("="). The equals sign has a special meaning in template code, and because of this it cannot be used in template parameters that do not specify a parameter name. For example, the template code
{{hatnote|2+2=4}}will produce this error. To work around this, you can specify the parameter name explicitly by using1=before the hatnote text, like this:{{hatnote|1=2+2=4}}. - You tried to access Module:Hatnote directly by using
{{#invoke:hatnote|hatnote|text}}. Use of #invoke in this way has been disabled for performance reasons. Please use{{hatnote|text}}instead.
If you see this error message and are unsure of what to do, please post a message on Template talk:Hatnote, and someone should be able to help you.
Pages that contain this error message are tracked in Category:Hatnote templates with errors.
Technical details
The HTML code produced by this template looks like this:
<div role="note" class="hatnote">hatnote text</div>
The code is produced by Module:Hatnote.
See also
- {{For}}
TemplateData documentation used by VisualEditor and other tools
| |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
See the monthly parameter usage report for this template.
TemplateData for Hatnote Template for creating a standard Wikipedia hatnote. A hatnote is a short note placed at the top of an article to provide disambiguation of closely related terms or summarise a topic, explaining its boundaries.
| |||||||||||||||||||||||||
--------------------------------------------------------------------------------
-- 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 p = {}
--------------------------------------------------------------------------------
-- Helper functions
--------------------------------------------------------------------------------
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.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
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 = 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
--------------------------------------------------------------------------------
-- 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 "#". 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),
}
end
local function italicize(s)
-- Italicize a string.
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
return string.format('[[:%s|%s]]', parsed.link, display)
end
--------------------------------------------------------------------------------
-- Hatnote
--
-- Produces standard hatnote text. Implements the {{hatnote}} template.
--------------------------------------------------------------------------------
function p.hatnote(frame)
local args = getArgs(frame)
local s = args[1]
local options = {}
if not s then
return p.makeWikitextError(
'no text specified',
'Template:Hatnote#Errors',
args.category
)
end
options.extraclasses = args.extraclasses
options.selfref = args.selfref
return p._hatnote(s, options)
end
function p._hatnote(s, options)
checkType('_hatnote', 1, s, 'string')
checkType('_hatnote', 2, options, 'table', true)
options = options or {}
local classes = {'hatnote', 'navigation-not-searchable'}
local extraclasses = options.extraclasses
local selfref = options.selfref
if type(extraclasses) == 'string' then
classes[#classes + 1] = extraclasses
end
if selfref then
classes[#classes + 1] = 'selfref'
end
return string.format(
'<div role="note" class="%s">%s</div>',
table.concat(classes, ' '),
s
)
end
return p