Thadius856: Creation

2022-01-22T11:54:42Z

Creation

New page

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, and the {{tl|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 [[Wikipedia:Template:Hatnote]] and [[Wikipedia:Template:Format link]] for documentation.

== Use from other Lua modules ==
To load this module from another Lua module, use the following code:

<code>local mHatnote = require('Module:Hatnote')</code>

You can then use the functions as documented below.

=== Hatnote ===
<code>mHatnote._hatnote(s, options)</code>

Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags <div 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 [[Wikipedia:Template:Selfref]]))
The CSS of the hatnote class is defined in [[Module:Hatnote/styles.css]].

; Example 1
<code>mHatnote._hatnote('This is a hatnote.')</code>

Produces:
<div class="hatnote">This is a hatnote.</div>

Displays as:
{{hatnote|This is a hatnote.}}

==See also==
* [[Wikipedia:Module:Hatnote]]

<includeonly>

[[Category:Hatnote modules| ]]
[[Category:Modules that add a tracking category]]
</includeonly>

Module:Hatnote/doc - Revision history

Thadius856: Creation