Template:Hatnote/doc

From Brighter Shores Wiki
Jump to navigation Jump to search
This is a documentation subpage for Template:Hatnote.
It contains usage information, categories, and other content that is not part of the original template page.
Template:Hatnote invokes function hatnote in Module:Hatnote using Lua.

The hatnote template produces formatted text for the purpose of redirecting the reader to another page if needed.

It adds the hatnote class which indents and italicises the text and the navigation-not-searchable class which excludes the content from search snippets in Special:Search.

Generally the template should not be used directly on articles, instead one of the following templates can be used:

Usage

{{Hatnote|Further reading: [[Account]]}}

would produce the following:

Template data

Show/hide template's data

The following information is used by extensions and applications, such as VisualEditor, to help users implement this template onto pages. Please ensure that it is up-to-date.

Template that produces formatted text for the purpose of redirecting the reader to another page if needed.

Template parameters

ParameterDescriptionTypeStatus
Text1

Text that will be displayed in the hatnote.

Stringrequired
Extra classesextraclasses

Extra classes to be added to the <div> tags surrounding the hatnote text.

Lineoptional