imported>Dabao qian：/* 格式页面 */ // Edit via Wikiplus

2024-10-31T05:51:10Z

格式页面： // Edit via Wikiplus

新页面

{{high-risk|162777}}
{{module rating|protected}}

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.

== 通过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.

== 通过其他Lua模块调用==

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.

=== 题注 ===

<syntaxhighlight lang="lua">
mHatnote._hatnote(s, options)
</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:
* <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]]))
The CSS of the hatnote class is defined in [[MediaWiki:Common.css]].

; 例甲

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

Produces:
{{tag|div|content=This is a hatnote.|params=class="hatnote"}}

Displays as:
{{hatnote|This is a hatnote.}}

; 例乙

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

Produces:
{{tag|div|content=This is a hatnote.|params=class="hatnote boilerplate seealso selfref"}}

Displayed as:
{{hatnote|This is a hatnote.|extraclasses=boilerplate seealso|selfref=true}}

=== 查找名字空间id ===

<syntaxhighlight lang="lua">
mHatnote.findNamespaceId(link, removeColon)
</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.

;Examples:
: {{code|mHatnote.findNamespaceId('Lion')|lua}} → 0
: {{code|mHatnote.findNamespaceId('Category:Lions')|lua}} → 14
: {{code|mHatnote.findNamespaceId(':Category:Lions')|lua}} → 14
: {{code|mHatnote.findNamespaceId(':Category:Lions', false)|lua}} → 0 (the namespace is detected as ":Category", rather than "Category")

=== 显示wikitext错误 ===

<syntaxhighlight lang="lua">
mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
</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|有错误的顶注模板}}; 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}}.

样例:
:{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} → <strong class="error">错误：出现了一个错误。</strong>
:{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} → <strong class="error">错误：出现了一个错误（[[Template:Example#Errors|帮助]]）。</strong>

== 样例 ==

For examples of how this module is used in other Lua modules, see the following (listed in order of complexity):
* [[Module:Main]]
<includeonly>{{Sandbox other||

[[Category:顶注模块| ]]
[[Category:添加追踪分类的模块]]
}}</includeonly>

模块:Hatnote/doc - 版本历史

imported>Dabao qian：​/* 格式页面 */ // Edit via Wikiplus

imported>Dabao qian：/* 格式页面 */ // Edit via Wikiplus