Diferencia entre revisiones de «Módulo:Hatnote/doc»
(add the underscores back to formatLink, as they are necessary there) |
m (26 revisiones importadas) |
||
| (No se muestran 11 ediciones intermedias de 7 usuarios) | |||
| Línea 1: | Línea 1: | ||
| − | This is a meta-module that provides various functions for making hatnotes. It implements the {{tl|hatnote}} template, for use in | + | {{high-risk|960,000+}} |
| + | |||
| + | 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. | ||
== Use from wikitext == | == 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 | + | 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 == | == Use from other Lua modules == | ||
| Línea 21: | Línea 23: | ||
</source> | </source> | ||
| − | Formats the string <var>s</var> as a hatnote. This encloses <var>s</var> in the tags {{tag|div|params=class=" | + | 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 | + | The CSS of the hatnote class is defined in [[MediaWiki:Common.css]]. |
; Example 1 | ; Example 1 | ||
| Línea 33: | Línea 35: | ||
Produces: | Produces: | ||
| − | {{tag|div|content=This is a hatnote.|params=class=" | + | {{tag|div|content=This is a hatnote.|params=class="hatnote"}} |
Displays as: | Displays as: | ||
| Línea 45: | Línea 47: | ||
Produces: | Produces: | ||
| − | {{tag|div|content=This is a hatnote.|params=class=" | + | {{tag|div|content=This is a hatnote.|params=class="hatnote boilerplate seealso selfref"}} |
Displayed as: | Displayed as: | ||
| Línea 97: | Línea 99: | ||
<source lang="lua"> | <source lang="lua"> | ||
| − | mHatnote.makeWikitextError(msg, | + | mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) |
</source> | </source> | ||
| − | Formats the string <var>msg</var> as a red wikitext error message. Normally this function also adds [[:Category:Hatnote templates with errors]]; however, if <var> | + | 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}}. |
| − | + | Examples: | |
:{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} → <strong class="error">Error: an error has occurred.</strong> | :{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} → <strong class="error">Error: an error has occurred.</strong> | ||
| + | :{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} → <strong class="error">Error: an error has occurred ([[Template:Example#Errors|help]]).</strong> | ||
== Examples == | == Examples == | ||
| Línea 116: | Línea 119: | ||
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox|| | <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> | ||
Revisión actual del 13:33 31 may 2016
| 40px | This template is used on 960 000+ pages. To avoid large-scale disruption and unnecessary server load, any changes to this template should first be tested in its /sandbox or /testcases subpages, or in your own user subpage. The tested changes can then be added to this page in one single edit. Please consider discussing any changes on the talk page before implementing them. |
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.
Contenido
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.
<source lang="lua"> local mHatnote = require('Module:Hatnote') </source>
You can then use the functions as documented below.
Hatnote
<source lang="lua"> mHatnote._hatnote(s, options) </source>
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
<source lang="lua"> mHatnote._hatnote('This is a hatnote.') </source>
Produces:
<div class="hatnote">This is a hatnote.</div>
Displays as:
- Example 2
<source lang="lua"> mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true}) </source>
Produces:
<div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>
Displayed as:
Format link
<source lang="lua"> mHatnote._formatLink(link, display) </source>
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
- <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote._formatLink('Lion')</syntaxhighlight> → [[Lion]] → Lion
- <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote._formatLink('Lion#Etymology')</syntaxhighlight> → [[Lion#Etymology|Lion § Etymology]] → Lion § Etymology
- <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote._formatLink('Category:Lions')</syntaxhighlight> → [[:Category:Lions]] → Category:Lions
- <syntaxhighlight lang="lua" class="" id="" style="" inline="1">mHatnote._formatLink('Lion#Etymology', 'Etymology of lion')</syntaxhighlight> → [[Lion#Etymology|Etymology of lion]] → Etymology of lion
Format pages
<source lang="lua"> mHatnote.formatPages(...) </source>
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
<source lang="lua"> mHatnote.formatPageTables(...) </source>
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
<source lang="lua"> mHatnote.findNamespaceId(link, removeColon) </source>
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
<source lang="lua"> mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory) </source>
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 <syntaxhighlight lang="lua" class="" id="" style="" inline="1">false</syntaxhighlight>.
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 examples of how this module is used in other Lua modules, see the following (listed in order of complexity):
