Module:Hatnote/doc

This is an old revision of this page, as edited by Mr. Stradivarius (talk | contribs) at 11:35, 24 April 2014 (add hatnote function). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in disambiguation hatnotes at the top of pages, and the {{rellink}} template, for use in making links to related articles directly under section headings. It also implements the {{format hatnote link}} template, which is used to format a wikilink for use in hatnotes.

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.

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)

Formats the string s as a hatnote. This encloses s in the tags <div class="dablink">...</div>. The CSS of the dablink class is defined in MediaWiki:Common.css.