Module:Hatnote/doc

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.

&#x3c;syntaxhighlight lang="lua"&#x3e; local mHatnote = require('Module:Hatnote') &#x3c;/syntaxhighlight&#x3e;

You can then use the functions as documented below.

Hatnote
&#x3c;syntaxhighlight lang="lua"&#x3e; mHatnote._hatnote(s, options) &#x3c;/syntaxhighlight&#x3e;

Formats the string &#x3c;var&#x3e;s&#x3c;/var&#x3e; as a hatnote. This encloses &#x3c;var&#x3e;s&#x3c;/var&#x3e; in the tags. Options are provided in the &#x3c;var&#x3e;options&#x3c;/var&#x3e; table. Options include: The CSS of the hatnote class is defined in Module:Hatnote/styles.css.
 * &#x3c;var&#x3e;options.extraclasses&#x3c;/var&#x3e; - a string of extra classes to provide
 * &#x3c;var&#x3e;options.selfref&#x3c;/var&#x3e; - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see Template:Selfref))


 * Example 1

&#x3c;syntaxhighlight lang="lua"&#x3e; mHatnote._hatnote('This is a hatnote.') &#x3c;/syntaxhighlight&#x3e;

Produces: This is a hatnote.

Displays as:


 * Example 2

&#x3c;syntaxhighlight lang="lua"&#x3e; mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) &#x3c;/syntaxhighlight&#x3e;

Produces: This is a hatnote.

Displayed as:

Find namespace id
&#x3c;syntaxhighlight lang="lua"&#x3e; mHatnote.findNamespaceId(link, removeColon) &#x3c;/syntaxhighlight&#x3e;

Finds the namespace id of the string &#x3c;var&#x3e;link&#x3c;/var&#x3e;, 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 &#x3c;var&#x3e;removeColon&#x3c;/var&#x3e; to false.


 * Examples:
 * mHatnote.findNamespaceId('Lion') &#x26;rarr; 0
 * mHatnote.findNamespaceId('Category:Lions') &#x26;rarr; 14
 * mHatnote.findNamespaceId(':Category:Lions') &#x26;rarr; 14
 * mHatnote.findNamespaceId(':Category:Lions', false) &#x26;rarr; 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error
&#x3c;syntaxhighlight lang="lua"&#x3e; mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) &#x3c;/syntaxhighlight&#x3e;

Formats the string &#x3c;var&#x3e;msg&#x3c;/var&#x3e; as a red wikitext error message, with optional link to a help page &#x3c;var&#x3e;helpLink&#x3c;/var&#x3e;. Normally this function also adds. To suppress categorization, pass &#x3c;code&#x3e;false&#x3c;/code&#x3e; as third parameter of the function (&#x3c;code&#x3e;addTrackingCategory&#x3c;/code&#x3e;).

Examples:
 * mHatnote.makeWikitextError('an error has occurred') &#x26;rarr; &#x3c;strong class="error"&#x3e;Error: an error has occurred.&#x3c;/strong&#x3e;
 * mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors') &#x26;rarr; &#x3c;strong class="error"&#x3e;Error: an error has occurred (help).&#x3c;/strong&#x3e;

Examples
For an example of how this module is used in other Lua modules, see Module:Main &#x3c;includeonly&#x3e;&#x3c;/includeonly&#x3e;