| 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
/sandbox
or
/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 depends on the following other modules:
|
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.
Use from wikitext
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.
Use from other Lua modules
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.
Hatnote
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:
- options.extraclasses
- a string of extra classes to provide
- options.selfref
- if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see
Template:Selfref
))
The CSS of the hatnote class is defined in
Module:Hatnote/styles.css
.
- Example 1
mHatnote
.
_hatnote
(
'This is a hatnote.'
)
Produces:
<div class="hatnote">This is a hatnote.</div>
Displays as:
This is a hatnote.
- Example 2
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:
This is a hatnote.
Find namespace id
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.
- Examples
mHatnote
.
findNamespaceId
(
'Lion'
)
→ 0
mHatnote
.
findNamespaceId
(
'Category:Lions'
)
→ 14
mHatnote
.
findNamespaceId
(
':Category:Lions'
)
→ 14
mHatnote
.
findNamespaceId
(
':Category:Lions'
,
false
)
→ 0 (the namespace is detected as ":Category", rather than "Category")
Make wikitext error
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
).
Examples
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
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
.
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
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
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
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
--------------------------------------------------------------------------------
-- 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