Module:Hatnote/doc

This is the documentation page for Module:Hatnote

This Lua module is used in MediaWiki:Wantedpages-summary, and on approximately 1,570,000 pages, or roughly 16390% 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 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:

Lua error: bad argument #1 to "get" (not a valid title). 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, and the {{format link}} template, which is used to format a wikilink for use in hatnotes. 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:

Format link

mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true}

Formats link as a wikilink for display in hatnote templates, with optional display value display. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

If italicizePage is true then the page portion of the link is italicized, and if italicizeSection is true then the section portion of the link is italicized.

Examples: mHatnote._formatLink{link = 'Lion'} → [[Lion]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

mHatnote._formatLink{link = 'Lion#Etymology'} → [[Lion#Etymology|Lion § Etymology]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

mHatnote._formatLink{link = 'Category:Lions'} → [[:Category:Lions]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'} → [[Lion#Etymology|Etymology of lion]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true} → [[Quo warranto#Philippines|<i>Quo warranto</i> § Philippines]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true} → [[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 § <i>Disini v. Secretary of Justice</i>]] →

REDIRECT Template:Format link

From a page move: This is a redirect from a page that has been moved (renamed) or is the result of a page move. One reason this page was kept as a redirect is to avoid breaking links, both internal and external, that may have been made to the old page name. Any redirect with a page move logged on its history page should be tagged with this rcat template.

Format pages

mHatnote.formatPages(...)

Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology') would produce an array like {'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}.

Format page tables

mHatnote.formatPageTables(...)

Takes a list of page/display tables, formats them with the _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 mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'}) would produce an array like {'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}.

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:Main

This module (and the documentation) are based (partially) on Module:Hatnote/doc from the free encyclopedia wikipedia and is licensed under GNU license for free documentation and the Creative Commons Attribution/Share Alike. On wikipedia there is a List of authors accessible. More about importing from wikipedia on page Imedwiki:Importing from wikipedia.