Difference between revisions of "Module:Hatnote/doc"

From All About Ayrshire
Jump to: navigation, search
m (1 revision)
en>Izno
(add dependencies)
Line 1: Line 1:
−
{{high-risk|840,000+}}
+
{{high-risk|1316323+}}
−
 
+
{{used in system|in [[MediaWiki:Wantedpages-summary]]}}
−
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.
+
{{module rating|protected}}
 +
{{Lua|Module:Yesno|Module:Arguments}}
 +
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.
  
 
== Use from wikitext ==
 
== Use from wikitext ==
Line 11: 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 19: 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:
Line 30: Line 32:
 
; 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 42: 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 54: Line 56:
 
=== Format link ===
 
=== Format link ===
  
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
−
mHatnote._formatLink(link, display)
+
mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true}
−
</source>
+
</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''.
 
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>italicizePage</var> is true then the section portion of the link is italicized.
  
 
;Examples:
 
;Examples:
−
: {{code|mHatnote._formatLink('Lion')|lua}} &rarr; <nowiki>[[Lion]]</nowiki> &rarr; {{format hatnote link|Lion}}
+
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</syntaxhighlight> &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}}
+
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</syntaxhighlight> &rarr; <nowiki>[[Lion#Etymology|Lion §&amp;nbsp;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}}
+
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</syntaxhighlight> &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}}
+
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</syntaxhighlight> &rarr; <nowiki>[[Lion#Etymology|Etymology of lion]]</nowiki> &rarr; {{format hatnote link|Lion#Etymology|Etymology of lion}}
 +
: <syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</syntaxhighlight> &rarr; <nowiki>[[Quo warranto#Philippines|<i>Quo warranto</i> §&amp;nbsp;Philippines]]</nowiki> &rarr; {{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> &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 ===
 
=== Format pages ===
  
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mHatnote.formatPages(...)
 
mHatnote.formatPages(...)
−
</source>
+
</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}}.
 
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 76: Line 82:
 
=== Format page tables ===
 
=== Format page tables ===
  
−
<source lang="lua">
+
<syntaxhighlight lang="lua">
 
mHatnote.formatPageTables(...)
 
mHatnote.formatPageTables(...)
−
</source>
+
</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}}.
 
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 84: Line 90:
 
=== 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 98: Line 104:
 
=== 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 [[: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 {{clc|Hatnote templates with errors}}. To suppress categorization, pass <code>false</code> as third parameter of the function (<code>addTrackingCategory</code>).
  
 
Examples:
 
Examples:
Line 110: Line 116:
 
== 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:Modules that add a tracking category]]
  
 
}}</includeonly>
 
}}</includeonly>

Revision as of 21:00, 27 November 2020

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.

<syntaxhighlight lang="lua"> local mHatnote = require('Module:Hatnote') </syntaxhighlight>

You can then use the functions as documented below.

Hatnote

<syntaxhighlight lang="lua"> mHatnote._hatnote(s, options) </syntaxhighlight>

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

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

Produces: <div class="hatnote">This is a hatnote.</div>

Displays as:

This is a hatnote.
Example 2

<syntaxhighlight lang="lua"> mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) </syntaxhighlight>

Produces: <div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>

Displayed as:

This is a hatnote.

Format link

<syntaxhighlight lang="lua"> mHatnote._formatLink{link = link, display = display, italicizePage = true, italicizeSection = true} </syntaxhighlight>

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.

If italicizePage is true then the page portion of the link is italicized, and if italicizePage is true then the section portion of the link is italicized.

Examples
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion'}</syntaxhighlight> → [[Lion]] → Lion
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology'}</syntaxhighlight> → [[Lion#Etymology|Lion §&nbsp;Etymology]] → Lion § Etymology
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Category:Lions'}</syntaxhighlight> → [[:Category:Lions]] → Category:Lions
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Lion#Etymology', display = 'Etymology of lion'}</syntaxhighlight> → [[Lion#Etymology|Etymology of lion]] → Etymology of lion
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Quo warranto#Philippines', italicizePage = true}</syntaxhighlight> → [[Quo warranto#Philippines|<i>Quo warranto</i> §&nbsp;Philippines]] → Quo warranto § Philippines
<syntaxhighlight lang="lua" inline>mHatnote._formatLink{link = 'Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice', italicizeSection = true}</syntaxhighlight> → [[Cybercrime Prevention Act of 2012#Disini v. Secretary of Justice|Cybercrime Prevention Act of 2012 §&nbsp;<i>Disini v. Secretary of Justice</i>]] → Cybercrime Prevention Act of 2012 § Disini v. Secretary of Justice

Format pages

<syntaxhighlight lang="lua"> mHatnote.formatPages(...) </syntaxhighlight>

Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')</syntaxhighlight> would produce an array like <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{'Lion', 'Category:Lions', 'Lion § Etymology'}</syntaxhighlight>.

Format page tables

<syntaxhighlight lang="lua"> mHatnote.formatPageTables(...) </syntaxhighlight>

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 <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})</syntaxhighlight> would produce an array like <syntaxhighlight lang="lua" class="" id="" style="" inline="1">{'the Lion article', 'Category:Lions', 'the etymology of lion'}</syntaxhighlight>.

Find namespace id

<syntaxhighlight lang="lua"> mHatnote.findNamespaceId(link, removeColon) </syntaxhighlight>

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
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Lion')</syntaxhighlight> → 0
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId('Category:Lions')</syntaxhighlight> → 14
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Category:Lions')</syntaxhighlight> → 14
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.findNamespaceId(':Category:Lions', false)</syntaxhighlight> → 0 (the namespace is detected as ":Category", rather than "Category")

Make wikitext error

<syntaxhighlight lang="lua"> mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) </syntaxhighlight>

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 (0). To suppress categorization, pass false as third parameter of the function (addTrackingCategory).

Examples:

<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('an error has occurred')</syntaxhighlight> → Error: an error has occurred.
<syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')</syntaxhighlight> → 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://igoaddons.eu.org/index.php?title=Module:Hatnote/doc&oldid=11060"