モジュール:Hatnote/doc

このページは、モジュール:Hatnoteの説明文を記述するページです。

This is a meta-module that provides various functions for making hatnotes. It implements the テンプレート:tl template, for use in hatnotes at the top of pages, and the テンプレート:tl 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.

<source lang="lua"> local mHatnote = require('Module:Hatnote') </source>

You can then use the functions as documented below.

Hatnote

<source lang="lua"> mHatnote._hatnote(s, options) </source>

Formats the string s as a hatnote. This encloses s in the tags テンプレート: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 MediaWiki:Common.css.

Example 1

<source lang="lua"> mHatnote._hatnote('This is a hatnote.') </source>

Produces: テンプレート:tag

Displays as: テンプレート:hatnote

Example 2

<source lang="lua"> mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) </source>

Produces: テンプレート:tag

Displayed as: テンプレート:hatnote

Format link

<source lang="lua"> mHatnote._formatLink(link, display) </source>

Formats link as a wikilink for display in hatnote templates, with optional display value display. Categories and files are automatically escaped with the colon trick, and links to sections are automatically formatted as page § section, rather than the MediaWiki default of page#section.

Examples: テンプレート:code → [[Lion]] → テンプレート:format hatnote link; テンプレート:code → [[Lion#Etymology|Lion § Etymology]] → テンプレート:format hatnote link; テンプレート:code → [[:Category:Lions]] → テンプレート:format hatnote link; テンプレート:code → [[Lion#Etymology|Etymology of lion]] → テンプレート:format hatnote link

Format pages

<source lang="lua"> mHatnote.formatPages(...) </source>

Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code テンプレート:code would produce an array like テンプレート:code.

Format page tables

<source lang="lua"> mHatnote.formatPageTables(...) </source>

Takes a list of page/display tables, formats them with the _formatLink function, and returns the result as an array. Each item in the list must be a table. The first value in the table is the link, and is required. The second value in the table is the display value, and is optional. For example, the code テンプレート:code would produce an array like テンプレート:code.

Find namespace id

<source lang="lua"> mHatnote.findNamespaceId(link, removeColon) </source>

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: テンプレート:code → 0; テンプレート:code → 14; テンプレート:code → 14; テンプレート:code → 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error

<source lang="lua"> mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) </source>

Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds テンプレート:clc; however, if addTrackingCategory is not false after being passed through Module:Yesno, then the category is suppressed. This means that the category can be suppressed with addTrackingCategory values including "no", "n", 0, "false", and テンプレート:code.

Examples:

テンプレート:code → Error: an error has occurred.

テンプレート:code → Error: an error has occurred (help).

Examples

For examples of how this module is used in other Lua modules, see the following (listed in order of complexity):