Modul:Hatnote/doc: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
imported>Oetterer Keine Bearbeitungszusammenfassung |
||
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) | |||
| Zeile 12: | Zeile 12: | ||
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. | ||
| Zeile 20: | Zeile 20: | ||
=== 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: | ||
| Zeile 31: | Zeile 31: | ||
; Example 1 | ; Example 1 | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote._hatnote('This is a hatnote.') | mHatnote._hatnote('This is a hatnote.') | ||
</ | </syntaxhighlight> | ||
Produces: | Produces: | ||
| Zeile 43: | Zeile 43: | ||
; 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: | ||
| Zeile 55: | Zeile 55: | ||
=== Format link === | === Format link === | ||
< | <syntaxhighlight lang="lua"> | ||
mHatnote._formatLink(link, display) | mHatnote._formatLink(link, display) | ||
</ | </syntaxhighlight> | ||
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 [[wpen: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 [[wpen:Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. | ||
| Zeile 69: | Zeile 69: | ||
=== 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 snippet|mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code snippet|{'[[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 snippet|mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code snippet|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}. | ||
| Zeile 77: | Zeile 77: | ||
=== 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 snippet|mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code snippet|{'[[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 snippet|mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})|lua}} would produce an array like {{code snippet|{'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}|lua}}. | ||
| Zeile 85: | Zeile 85: | ||
=== 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. | ||
| Zeile 99: | Zeile 99: | ||
=== 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 snippet|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 snippet|false|lua}}. | ||
| Zeile 119: | Zeile 119: | ||
<!-- Categories go here and interwikis go in Wikidata. --> | <!-- Categories go here and interwikis go in Wikidata. --> | ||
}}</includeonly> | }}</includeonly><!-- null edit comment; remove --> | ||
Aktuelle Version vom 5. Oktober 2022, 15:04 Uhr
 | This is a documentation subpage for Modul:Hatnote. It contains usage information, categories and other content that is not part of the original modul page. |
 | This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This is a meta-module that provides various functions for making hatnotes. It implements the {{hatnote}} template, for use in hatnotes at the top of pages. 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 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, options)
Formats the string s as a hatnote. This encloses s in the tags <div class="hatnote">...</div>. 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
mHatnote._hatnote('This is a hatnote.')
Produces:
<div class="dablink">This is a hatnote.</div>
Displays as:
- Example 2
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
Produces:
<div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>
Displayed as:
Format link
mHatnote._formatLink(link, display)
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
mHatnote._formatLink('Lion')→ [[Lion]] → ...missingmHatnote._formatLink('Lion#Etymology')→ [[Lion#Etymology|Lion § Etymology]] → ...missingmHatnote._formatLink('Category:Lions')→ [[:Category:Lions]] → ...missingmHatnote._formatLink('Lion#Etymology', 'Etymology of lion')→ [[Lion#Etymology|Etymology of lion]] → ...missing
Format pages
mHatnote.formatPages(...)
Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology') would produce an array like {'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}.
Format page tables
mHatnote.formatPageTables(...)
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 mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'}) would produce an array like {'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}.
Find namespace id
mHatnote.findNamespaceId(link, removeColon)
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
mHatnote.findNamespaceId('Lion')→ 0mHatnote.findNamespaceId('Category:Lions')→ 14mHatnote.findNamespaceId(':Category:Lions')→ 14mHatnote.findNamespaceId(':Category:Lions', false)→ 0 (the namespace is detected as ":Category", rather than "Category")
Make wikitext error
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:Hatnote templates with errors; 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 false.
Examples:
mHatnote.makeWikitextError('an error has occurred')→ Error: an error has occurred.mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')→ 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):