Module:Hatnote/doc: Difference between revisions

From escforumwiki
Jump to navigation Jump to search
VisualWikitext
m (1 revision imported)
 
en>Nihiltres
(Removed documentation for extracted/removed functionality)
Line 1: Line 1:
{{high-risk|1,000,000+}}
{{used in system|in [[MediaWiki:Wantedpages-summary]]}}
{{module rating|protected}}
{{module rating|protected}}
 
{{Lua|Module:Yesno|Module:Arguments}}
{{Uses TemplateStyles|Module:Hatnote/styles.css}}
This is a meta-module that provides various functions for making [[Wikipedia:Hatnote|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 [[Wikipedia:Hatnote|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.


Line 12: Line 13:
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">
<syntaxhighlight lang="lua">
local mHatnote = require('Module:Hatnote')
local mHatnote = require('Module:Hatnote')
</source>
</syntaxhighlight>


You can then use the functions as documented below.
You can then use the functions as documented below.
Line 20: Line 21:
=== Hatnote ===
=== Hatnote ===


<source lang="lua">
<syntaxhighlight lang="lua">
mHatnote._hatnote(s, options)
mHatnote._hatnote(s, options)
</source>
</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
* <var>options.selfref</var> - if this is not nil or false, adds the class "selfref", used to denote self-references to Wikipedia (see [[Template:Selfref]]))
* <var>options.selfref</var> - 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]].
The CSS of the hatnote class is defined in [[Module:Hatnote/styles.css]].


; Example 1
; Example 1


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


Produces:
Produces:
Line 43: Line 44:
; Example 2
; Example 2


<source lang="lua">
<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})
</source>
</syntaxhighlight>


Produces:
Produces:
Line 52: 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 ===
<source lang="lua">
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''.
;Examples:
: {{code|mHatnote._formatLink('Lion')|lua}} &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}
: {{code|mHatnote._formatLink('Lion#Etymology')|lua}} &rarr; <nowiki>[[Lion#Etymology|Lion § Etymology]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology}}
: {{code|mHatnote._formatLink('Category:Lions')|lua}} &rarr; <nowiki>[[:Category:Lions]]</nowiki> &rarr; {{format hatnote link|Category:Lions}}
: {{code|mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')|lua}} &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}
=== Format pages ===
<source lang="lua">
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}}.
=== Format page tables ===
<source lang="lua">
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}}.


=== Find namespace id ===
=== Find namespace id ===


<source lang="lua">
<syntaxhighlight lang="lua">
mHatnote.findNamespaceId(link, removeColon)
mHatnote.findNamespaceId(link, removeColon)
</source>
</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.
Line 99: Line 70:
=== Make wikitext error ===
=== Make wikitext error ===


<source lang="lua">
<syntaxhighlight lang="lua">
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
</source>
</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 {{clc|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 {{clc|Hatnote templates with errors}}. To suppress categorization, pass <code>false</code> as third parameter of the function (<code>addTrackingCategory</code>).


Examples:
Examples:
Line 111: Line 82:
== Examples ==
== Examples ==


For examples of how this module is used in other Lua modules, see the following (listed in order of complexity):
For an example of how this module is used in other Lua modules, see [[Module:Main]]
 
<includeonly>{{Sandbox other||
* [[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. -->
[[Category:Hatnote modules| ]]
[[Category:Hatnote modules| ]]

Revision as of 18:33, 26 December 2021

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:

This is a hatnote.
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:

This is a hatnote.

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') → 0
mHatnote.findNamespaceId('Category:Lions') → 14
mHatnote.findNamespaceId(':Category:Lions') → 14
mHatnote.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

Retrieved from "http://escforumwiki.com/index.php?title=Module:Hatnote/doc&oldid=105132"