« Module:Hatnote/doc » : différence entre les versions
mAucun résumé des modifications |
|||
| (11 versions intermédiaires par le même utilisateur non affichées) | |||
| Ligne 1 : | Ligne 1 : | ||
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 | <!--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. | ||
== Use from wikitext == | == Use from wikitext == | ||
| Ligne 9 : | Ligne 9 : | ||
To load this module from another Lua module, use the following code. | To load this module from another Lua module, use the following code. | ||
< | <syntaxhighlight lang="lua"> | ||
local mHatnote = require('Module:Hatnote') | local mHatnote = require('Module:Hatnote') | ||
</ | </syntaxhighlight> | ||
You can then use the functions as documented below. | You can then use the functions as documented below. | ||
| Ligne 17 : | Ligne 17 : | ||
=== Hatnote === | === Hatnote === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote._hatnote(s, options) | mHatnote._hatnote(s, options) | ||
</ | </syntaxhighlight> | ||
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: | ||
* <var>options.extraclasses</var> - a string of extra classes to provide | * <var>options.extraclasses</var> - a string of extra classes to provide | ||
The CSS of the hatnote class is defined in [[MediaWiki:Common.css]]. | The CSS of the hatnote class is defined in [[MediaWiki:Common.css]]. | ||
; Example 1 | ; Example 1 | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote._hatnote('This is a hatnote.') | mHatnote._hatnote('This is a hatnote.') | ||
</ | </syntaxhighlight> | ||
Produces: | Produces: | ||
| Ligne 40 : | Ligne 39 : | ||
; Example 2 | ; Example 2 | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) | mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) | ||
</ | </syntaxhighlight> | ||
Produces: | Produces: | ||
| Ligne 54 : | Ligne 53 : | ||
{{code|mHatnote._formatLink(link, display)|lua}} | {{code|mHatnote._formatLink(link, display)|lua}} | ||
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 [[wikipedia: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('SysAdmin')|lua}} → <nowiki>[[SysAdmin]]</nowiki> → {{format link|SysAdmin}} | ||
: {{code|mHatnote._formatLink(' | : {{code|mHatnote._formatLink('SysAdmin#Etymology')|lua}} → <nowiki>[[SysAdmin#Etymology|SysAdmin § Etymology]]</nowiki> → {{format link|SysAdmin#Etymology}} | ||
: {{code|mHatnote._formatLink('Category: | : {{code|mHatnote._formatLink('Category:SysAdmin')|lua}} → <nowiki>[[:Category:SysAdmin]]</nowiki> → {{format link|Category:SysAdmin}} | ||
: {{code|mHatnote._formatLink(' | : {{code|mHatnote._formatLink('SysAdmin#Etymology', 'Etymology of SysAdmin')|lua}} → <nowiki>[[SysAdmin#Etymology|Etymology of SysAdmin]]</nowiki> → {{format link|SysAdmin#Etymology|Etymology of SysAdmin}} | ||
=== Format pages === | === Format pages === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote.formatPages(...) | mHatnote.formatPages(...) | ||
</ | </syntaxhighlight> | ||
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(' | 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('SysAdmin', 'Category:SysAdmin', 'SysAdmin#Etymology')|lua}} would produce an array like {{code|{'[[SysAdmin]]', '[[:Category:SysAdmin]]', '[[SysAdmin#Etymology|SysAdmin § Etymology]]'}|lua}}. | ||
=== Format page tables === | === Format page tables === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote.formatPageTables(...) | mHatnote.formatPageTables(...) | ||
</ | </syntaxhighlight> | ||
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({' | 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({'SysAdmin', 'the SysAdmin article'}, {'Category:SysAdmin'}, {'SysAdmin#Etymology', 'the etymology of SysAdmin'})|lua}} would produce an array like {{code|{'[[SysAdmin|the SysAdmin article]]', '[[:Category:SysAdmin]]', '[[SysAdmin#Etymology|the etymology of SysAdmin]]'}|lua}}. | ||
=== Find namespace id === | === Find namespace id === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote.findNamespaceId(link, removeColon) | mHatnote.findNamespaceId(link, removeColon) | ||
</ | </syntaxhighlight> | ||
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. | ||
;Examples: | ;Examples: | ||
: {{code|mHatnote.findNamespaceId(' | : {{code|mHatnote.findNamespaceId('SysAdmin')|lua}} → 0 | ||
: {{code|mHatnote.findNamespaceId('Category: | : {{code|mHatnote.findNamespaceId('Category:SysAdmin')|lua}} → 14 | ||
: {{code|mHatnote.findNamespaceId(':Category: | : {{code|mHatnote.findNamespaceId(':Category:SysAdmin')|lua}} → 14 | ||
: {{code|mHatnote.findNamespaceId(':Category: | : {{code|mHatnote.findNamespaceId(':Category:SysAdmin', false)|lua}} → 0 (the namespace is detected as ":Category", rather than "Category") | ||
=== Make wikitext error === | === Make wikitext error === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) | mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) | ||
</ | </syntaxhighlight> | ||
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}}. | 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}}. | ||
| Ligne 113 : | Ligne 112 : | ||
* [[Module:Main]] | * [[Module:Main]] | ||
--> | |||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | ||
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- Categories go here and interwikis go in Wikidata. --> | ||
}}</includeonly> | }}</includeonly> | ||
Dernière version du 8 février 2023 à 08:00