Module:Hatnote/doc: Difference between revisions

Revision as of 13:41, 4 July 2020

Revision as of 13:20, 7 July 2020

Line 13:

To load this module from another Lua module, use the following code.

<sourcesyntaxhighlight lang="lua">

local mHatnote = require('Module:Hatnote')

</syntaxhighlight>

</source>

You can then use the functions as documented below.

Line 21:

=== Hatnote ===

<sourcesyntaxhighlight lang="lua">

mHatnote._hatnote(s, options)

</syntaxhighlight>

</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:

Line 32:

; Example 1

<sourcesyntaxhighlight lang="lua">

mHatnote._hatnote('This is a hatnote.')

</syntaxhighlight>

</source>

Produces:

Line 44:

; Example 2

<sourcesyntaxhighlight lang="lua">

mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})

</syntaxhighlight>

</source>

Produces:

Line 56:

=== Format link ===

<sourcesyntaxhighlight lang="lua">

mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true}

</syntaxhighlight>

</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''.

Line 65:

;Examples:

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</sourcesyntaxhighlight> &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</sourcesyntaxhighlight> &rarr; <nowiki>[[Lion#Etymology|Lion §&amp;nbsp;Etymology]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology}}

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</sourcesyntaxhighlight> &rarr; <nowiki>[[:Category:Lions]]</nowiki> &rarr; {{format hatnote link|Category:Lions}}

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</sourcesyntaxhighlight> &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</sourcesyntaxhighlight> &rarr; <nowiki>[[Quo warranto#Philippines|<i>Quo warranto</i> §&amp;nbsp;Philippines]]</nowiki> &rarr; {{format hatnote link|Quo warranto#Philippines|italicizepage=true}}

: <sourcesyntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true}</sourcesyntaxhighlight> &rarr; <nowiki>[[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&amp;nbsp;<i>Disini v. Secretary of Justice</i>]]</nowiki> &rarr; {{format hatnote link|Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|italicizesection=true}}

=== Format pages ===

<sourcesyntaxhighlight lang="lua">

mHatnote.formatPages(...)

</syntaxhighlight>

</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}}.

Line 82:

=== Format page tables ===

<sourcesyntaxhighlight lang="lua">

mHatnote.formatPageTables(...)

</syntaxhighlight>

</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}}.

Line 90:

=== Find namespace id ===

<sourcesyntaxhighlight lang="lua">

mHatnote.findNamespaceId(link, removeColon)

</syntaxhighlight>

</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.

Line 104:

=== Make wikitext error ===

<sourcesyntaxhighlight lang="lua">

mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)

</syntaxhighlight>

</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 {{clc|Hatnote templates with errors}}. To suppress categorization, pass <code>false</code> as third parameter of the function (<code>addTrackingCategory</code>).