Module:Hatnote/doc: Difference between revisions
MediaWiki:Common.css hasn't contained the hatnote css since 19 July |
Removed documentation for extracted/removed functionality |
||
| Line 53: | Line 53: | ||
Displayed as: |
Displayed as: |
||
{{hatnote|This is a hatnote.|extraclasses=boilerplate seealso|selfref=true}} |
{{hatnote|This is a hatnote.|extraclasses=boilerplate seealso|selfref=true}} |
||
=== Format link === |
|||
<syntaxhighlight lang="lua"> |
|||
mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true} |
|||
</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 [[Help:Colon trick|colon trick]], and links to sections are automatically formatted as ''page § section'', rather than the MediaWiki default of ''page#section''. |
|||
If <var>italicizePage</var> is true then the page portion of the link is italicized, and if <var>italicizeSection</var> is true then the section portion of the link is italicized. |
|||
;Examples: |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</syntaxhighlight> → <nowiki>[[Lion]]</nowiki> → {{format hatnote link|Lion}} |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</syntaxhighlight> → <nowiki>[[Lion#Etymology|Lion §&nbsp;Etymology]]</nowiki> → {{format hatnote link|Lion#Etymology}} |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</syntaxhighlight> → <nowiki>[[:Category:Lions]]</nowiki> → {{format hatnote link|Category:Lions}} |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</syntaxhighlight> → <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> → {{format hatnote link|Lion#Etymology|Etymology of lion}} |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</syntaxhighlight> → <nowiki>[[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]]</nowiki> → {{format hatnote link|Quo warranto#Philippines|italicizepage=true}} |
|||
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true}</syntaxhighlight> → <nowiki>[[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&nbsp;<i>Disini v. Secretary of Justice</i>]]</nowiki> → {{format hatnote link|Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|italicizesection=true}} |
|||
=== Format pages === |
|||
<syntaxhighlight lang="lua"> |
|||
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('Lion', 'Category:Lions', 'Lion#Etymology')|lua}} would produce an array like {{code|{'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}|lua}}. |
|||
=== Format page tables === |
|||
<syntaxhighlight lang="lua"> |
|||
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({'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}}. |
|||
=== Find namespace id === |
=== Find namespace id === |
||
Revision as of 18:33, 26 December 2021
 | This Lua module is used in MediaWiki:Wantedpages-summary, and on approximately 2,030,000 pages, or roughly 3% of all pages. Changes to it can cause immediate changes to the Wikipedia user interface. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Please discuss changes on the talk page before implementing them. |
 | This module depends on the following other modules: |
 | This module uses TemplateStyles: |
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, and the {{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
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.
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 Module:Hatnote/styles.css.
- Example 1
mHatnote._hatnote('This is a hatnote.')
Produces:
<div class="hatnote">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:
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 (5). To suppress categorization, pass false as third parameter of the function (addTrackingCategory).
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 an example of how this module is used in other Lua modules, see Module:Main