Module:Hatnote/doc

This is the documentation page for Module:Hatnote

Hēr is sīo meta-metod, sēo sylð feorran ðāra dǣla tō crǣften hatnotes. Hit fæstenen sēo {{hatnote}} bysen, for brūce on hætnotum æt þǣre heafod þæs sīdan. Hit eac inclyð swīðe gelǣrede funtoða for brūce on ōðre Lua hætnot metodum.

Use fram wikiscrypst[adiht fruman]

Ssēo functions in this module cannot be used directly from #invoke, and must be used through bysen instead. Please see Bysen:Hatnote ond Bysen:Format link for motung.

Use from other Lua modules[adiht fruman]

To load this module from another Lua module, use the following code.

local mHatnote = require('Module:Hatnote')

Þū mæġ þonne brūcan þā funtoða swā gescrypsted beneoþan.

Hatnote[adiht fruman]

mHatnote._hatnote(s, options)

Formats the string s as a hatnote. This encloses s in the tags Bysen:Tag. 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: Bysen:Tag

Displays as:

This is a hatnote.

Example 2

mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})

Produces: Bysen:Tag

Displayed as:

This is a hatnote.

Find namespace id[adiht fruman]

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: Bysen:Code → 0; Bysen:Code → 14; Bysen:Code → 14; Bysen:Code → 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error[adiht fruman]

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:

Bysen:Code → Error: an error has occurred.

Bysen:Code → Error: an error has occurred (help).

Examples[adiht fruman]

For an example of how this module is used in other Lua modules, see Module:Labelled list hatnote