Editing Module:Hatnote/doc
Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.
The edit can be undone.
Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
| Latest revision | Your text | ||
| Line 1: | Line 1: | ||
| − | {{high-risk| | + | {{high-risk|840,000+}} |
| − | + | ||
| − | + | This is a meta-module that provides various functions for making 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. | |
| − | |||
| − | This is a meta-module that provides various functions for making | ||
== Use from wikitext == | == Use from wikitext == | ||
| Line 13: | Line 11: | ||
To load this module from another Lua module, use the following code. | To load this module from another Lua module, use the following code. | ||
| − | < | + | <source lang="lua"> |
local mHatnote = require('Module:Hatnote') | local mHatnote = require('Module:Hatnote') | ||
| − | </ | + | </source> |
You can then use the functions as documented below. | You can then use the functions as documented below. | ||
| Line 21: | Line 19: | ||
=== Hatnote === | === Hatnote === | ||
| − | < | + | <source lang="lua"> |
mHatnote._hatnote(s, options) | mHatnote._hatnote(s, options) | ||
| − | </ | + | </source> |
Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="hatnote"}}. Options are provided in the <var>options</var> table. Options include: | Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class="hatnote"}}. Options are provided in the <var>options</var> table. Options include: | ||
| Line 32: | Line 30: | ||
; Example 1 | ; Example 1 | ||
| − | < | + | <source lang="lua"> |
mHatnote._hatnote('This is a hatnote.') | mHatnote._hatnote('This is a hatnote.') | ||
| − | </ | + | </source> |
Produces: | Produces: | ||
| Line 44: | Line 42: | ||
; Example 2 | ; Example 2 | ||
| − | < | + | <source lang="lua"> |
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) | mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) | ||
| − | </ | + | </source> |
Produces: | Produces: | ||
| Line 56: | Line 54: | ||
=== Format link === | === Format link === | ||
| − | < | + | <source lang="lua"> |
| − | mHatnote._formatLink | + | mHatnote._formatLink(link, display) |
| − | </ | + | </source> |
Formats <var>link</var> as a wikilink for display in hatnote templates, with optional display value <var>display</var>. Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. | Formats <var>link</var> as a wikilink for display in hatnote templates, with optional display value <var>display</var>. Categories and files are automatically escaped with the [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. | ||
| − | |||
| − | |||
;Examples: | ;Examples: | ||
| − | : | + | : {{code|mHatnote._formatLink('Lion')|lua}} → <nowiki>[[Lion]]</nowiki> → {{format hatnote link|Lion}} |
| − | : | + | : {{code|mHatnote._formatLink('Lion#Etymology')|lua}} → <nowiki>[[Lion#Etymology|Lion § Etymology]]</nowiki> → {{format hatnote link|Lion#Etymology}} |
| − | : | + | : {{code|mHatnote._formatLink('Category:Lions')|lua}} → <nowiki>[[:Category:Lions]]</nowiki> → {{format hatnote link|Category:Lions}} |
| − | : | + | : {{code|mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')|lua}} → <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> → {{format hatnote link|Lion#Etymology|Etymology of lion}} |
| − | |||
| − | |||
=== Format pages === | === Format pages === | ||
| − | < | + | <source lang="lua"> |
mHatnote.formatPages(...) | mHatnote.formatPages(...) | ||
| − | </ | + | </source> |
Formats a list of pages using the [[#Format link|_formatLink]] function, and returns the result as an array. For example, the code {{code|mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}. | Formats a list of pages using the [[#Format link|_formatLink]] function, and returns the result as an array. For example, the code {{code|mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}. | ||
| Line 82: | Line 76: | ||
=== Format page tables === | === Format page tables === | ||
| − | < | + | <source lang="lua"> |
mHatnote.formatPageTables(...) | mHatnote.formatPageTables(...) | ||
| − | </ | + | </source> |
Takes a list of page/display tables, formats them with the [[#Format link|_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|mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code|{'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}|lua}}. | Takes a list of page/display tables, formats them with the [[#Format link|_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|mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code|{'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}|lua}}. | ||
| Line 90: | Line 84: | ||
=== Find namespace id === | === Find namespace id === | ||
| − | < | + | <source lang="lua"> |
mHatnote.findNamespaceId(link, removeColon) | mHatnote.findNamespaceId(link, removeColon) | ||
| − | </ | + | </source> |
Finds the [[WP:NS|namespace id]] of the string <var>link</var>, 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 <var>removeColon</var> to false. | Finds the [[WP:NS|namespace id]] of the string <var>link</var>, 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 <var>removeColon</var> to false. | ||
| Line 104: | Line 98: | ||
=== Make wikitext error === | === Make wikitext error === | ||
| − | < | + | <source lang="lua"> |
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) | mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) | ||
| − | </ | + | </source> |
| − | Formats the string <var>msg</var> as a red wikitext error message, with optional link to a help page <var>helpLink</var>. Normally this function also adds | + | Formats the string <var>msg</var> as a red wikitext error message, with optional link to a help page <var>helpLink</var>. Normally this function also adds [[:Category:Hatnote templates with errors]]; however, if <var>addTrackingCategory</var> is not false after being passed through [[Module:Yesno]], then the category is suppressed. This means that the category can be suppressed with <var>addTrackingCategory</var> values including "no", "n", 0, "false", and {{code|false|lua}}. |
Examples: | Examples: | ||
| Line 116: | Line 110: | ||
== Examples == | == Examples == | ||
| − | For | + | For examples of how this module is used in other Lua modules, see the following (listed in order of complexity): |
| − | <includeonly>{{ | + | |
| + | * [[Module:Details]] | ||
| + | * [[Module:Further]] | ||
| + | * [[Module:See also]] | ||
| + | * [[Module:Main]] | ||
| + | |||
| + | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- Categories go here and interwikis go in Wikidata. --> | ||
| − | |||
| − | |||
}}</includeonly> | }}</includeonly> | ||
