Module:Hatnote/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 00:57, 14 August 2023

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 module uses TemplateStyles:

Module:Hatnote/styles.css

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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[edit]

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]]}}
-This is a meta-module that provides various functions for making hatnotes. It implements the {{tl|hatnote}} template, for use in disambiguation hatnotes at the top of pages, and the {{tl|rellink}} template, for use in making links to related articles directly under section headings. It also implements the {{tl|format hatnote link}} template, which is used to format a wikilink for use in hatnotes.
+{{module rating|protected}}
+{{Lua|Module:Yesno|Module:Arguments}}
+{{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.
 == 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]], [[Template:Rellink]] and [[Template:Format hatnote 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 9: / Line 13: @@
 To load this module from another Lua module, use the following code.
-<source lang="lua">
+<syntaxhighlight lang="lua">
 local mHatnote = require('Module:Hatnote')
+</syntaxhighlight>
-</source>
 You can then use the functions as documented below.
@@ Line 17: / Line 21: @@
 === Hatnote ===
-<source lang="lua">
+<syntaxhighlight lang="lua">
-mHatnote._hatnote(s)
+mHatnote._hatnote(s, options)
+</syntaxhighlight>
-</source>
-Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="dablink"}}. The CSS of the dablink class is defined in [[MediaWiki:Common.css]].
+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]]))
+The CSS of the hatnote class is defined in [[Module:Hatnote/styles.css]].
-; Example
+; Example 1
-<source lang="lua">
+<syntaxhighlight lang="lua">
 mHatnote._hatnote('This is a hatnote.')
+</syntaxhighlight>
-</source>
 Produces:
-{{tag|div|content=This is a hatnote.|params=class="dablink"}}
+{{tag|div|content=This is a hatnote.|params=class="hatnote"}}
 Displays as:
 {{hatnote|This is a hatnote.}}
-=== Rellink ===
-<source lang="lua">
-mHatnote._rellink(s, extraclasses)
-</source>
-Formats the string <var>s</var> as a "related articles" link. This encloses <var>s</var> in the tags {{tag|div|params=class="rellink"}}. The CSS of the dablink class is defined in [[MediaWiki:Common.css]]. Extra classes can be added as the string <var>extraclasses</var>.
-; Example 1
-<source lang="lua">
-mHatnote._rellink('This is a related article link.')
-</source>
-Produces:
-{{tag|div|content=This is a related article link.|params=class="rellink"}}
-Displays as:
-{{rellink|This is a related article link.}}
 ; Example 2
-<source lang="lua">
+<syntaxhighlight lang="lua">
-mHatnote._rellink('This is a related article link.', 'boilerplate seealso')
+mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
+</syntaxhighlight>
-</source>
 Produces:
-{{tag|div|content=This is a related article link.|params=class="rellink boilerplate seealso"}}
+{{tag|div|content=This is a hatnote.|params=class="hatnote boilerplate seealso selfref"}}
 Displayed as:
-{{rellink|This is a related article link.|extraclasses=boilerplate seealso}}
+{{hatnote|This is a hatnote.|extraclasses=boilerplate seealso|selfref=true}}
-=== Format link ===
-<source lang="lua">
-mHatnote._formatLink(link, display)
-</source>
-Formats <var>link</var> as a wikilink for display in hatnote templates, with optional display value <var>display</var>. Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''.
-;Examples:
-: {{code|mHatnote._formatLink('Lion')|lua}} &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}
-: {{code|mHatnote._formatLink('Lion#Etymology')|lua}} &rarr; <nowiki>[[Lion#Etymology|Lion § Etymology]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology}}
-: {{code|mHatnote._formatLink('Category:Lions')|lua}} &rarr; <nowiki>[[:Category:Lions]]</nowiki> &rarr; {{format hatnote link|Category:Lions}}
-: {{code|mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')|lua}} &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}
-=== Format pages ===
-<source lang="lua">
-mHatnote._formatPages(...)
-</source>
-Formats a list of pages using the [[#Format link|_formatLink]] function, and returns the result as an array. For example, the code {{code|mHatnote._formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}.
-=== Format page tables ===
-<source lang="lua">
-mHatnote._formatPageTables(...)
-</source>
-Takes a list of page/display tables, formats them with the [[#Format link|_formatLink]] function, and returns the result as an array. Each item in the list must be a table. The first value in the table is the link, and is required. The second value in the table is the display value, and is optional. For example, the code {{code|mHatnote._formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code|{'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}|lua}}.
 === Find namespace id ===
-<source lang="lua">
+<syntaxhighlight lang="lua">
-mHatnote._findNamespaceId(link, removeColon)
+mHatnote.findNamespaceId(link, removeColon)
+</syntaxhighlight>
-</source>
 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.
 ;Examples:
-: {{code|mHatnote._findNamespaceId('Lion')|lua}} &rarr; 0
+: {{code|mHatnote.findNamespaceId('Lion')|lua}} &rarr; 0
-: {{code|mHatnote._findNamespaceId('Category:Lions')|lua}} &rarr; 14
+: {{code|mHatnote.findNamespaceId('Category:Lions')|lua}} &rarr; 14
-: {{code|mHatnote._findNamespaceId(':Category:Lions')|lua}} &rarr; 14
+: {{code|mHatnote.findNamespaceId(':Category:Lions')|lua}} &rarr; 14
-: {{code|mHatnote._findNamespaceId(':Category:Lions', false)|lua}} &rarr; 0 (the namespace is detected as ":Category", rather than "Category")
+: {{code|mHatnote.findNamespaceId(':Category:Lions', false)|lua}} &rarr; 0 (the namespace is detected as ":Category", rather than "Category")
 === Make wikitext error ===
-<source lang="lua">
+<syntaxhighlight lang="lua">
-mHatnote._makeWikitextError(msg)
+mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
+</syntaxhighlight>
-</source>
-Formats the string <var>msg</var> as a red wikitext error message.
+Formats the string <var>msg</var> as a red wikitext error message, with optional link to a help page <var>helpLink</var>. Normally this function also adds {{clc|Hatnote templates with errors}}. To suppress categorization, pass <code>false</code> as third parameter of the function (<code>addTrackingCategory</code>).
+Examples:
-Example:
-:{{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')|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>
 == Examples ==
-For examples of how this module is used in other Lua modules, see:
+For an example of how this module is used in other Lua modules, see [[Module:Labelled list hatnote]]
+<includeonly>{{Sandbox other||
-* [[Module:Main]]
-* [[Module:See also]]
-* [[Module:Details]]
-* [[Module:Further]]
-<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
 <!-- Categories go here and interwikis go in Wikidata. -->
+[[Category:Hatnote modules| ]]
+[[Category:Modules that add a tracking category]]
 }}</includeonly>