Module:Hatnote/doc: Difference between revisions

Latest revision as of 18:15, 9 April 2025

This page uses Creative Commons Licensed content from Wikipedia (view authors).

‹ The template below (Module rating) is being considered for merging. See templates for discussion to help reach a consensus. ›

This module depends on the following other modules:

This module uses TemplateStyles:

Module:Hatnote/styles.css (sandbox)

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:

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:

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 (0). 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

@@ Line 1: / Line 1: @@
-{{used in system|in [[MediaWiki:Wantedpages-summary]]}}
+{{wikipedia|page name}}
 {{module rating|protected}}
 {{Lua|Module:Yesno|Module:Arguments|Module:Format link}}
 {{Uses TemplateStyles|Module:Hatnote/styles.css}}
-This is a meta-module that provides various functions for making [[Wikipedia:Hatnote|hatnotes]]. It implements the {{tl|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.
+This is a meta-module that provides various functions for making hatnotes. It implements the {{tl|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.
+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 ==
@@ Line 27: / Line 27: @@
 Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="hatnote"}}. Options are provided in the <var>options</var> table. Options include:
 * <var>options.extraclasses</var> - a string of extra classes to provide
-* <var>options.selfref</var> - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see [[Template:Selfref]]))
+* <var>options.selfref</var> - 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]].
+The CSS of the hatnote class is defined in Module:Hatnote/styles.css.
 ; Example 1
@@ Line 60: / Line 60: @@
 </syntaxhighlight>
-Finds the [[WP:NS|namespace id]] of the string <var>link</var>, 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 <var>removeColon</var> to false.
+Finds the namespace id of the string <var>link</var>, 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 <var>removeColon</var> to false.
 ;Examples:
@@ Line 78: / Line 78: @@
 Examples:
 :{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} &rarr; <strong class="error">Error: an error has occurred.</strong>
-:{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} &rarr; <strong class="error">Error: an error has occurred ([[Template:Example#Errors|help]]).</strong>
+:{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} &rarr; <strong class="error">Error: an error has occurred (help).</strong>
 == Examples ==
-For an example of how this module is used in other Lua modules, see [[Module:Labelled list hatnote]]
+For an example of how this module is used in other Lua modules, see Module:Labelled list hatnote
 <includeonly>{{Sandbox other||
 <!-- Categories go here and interwikis go in Wikidata. -->