切換搜尋
切換菜單
711
1.3万
46
2.5万
索尼克百科
切換個人選單
尚未登入
如果您进行任何编辑，您的IP地址会公开展示。

「Module:Hatnote/doc」：修訂間差異

出自索尼克百科
更多語言
更多操作
互動式瀏覽歷史
新增的內容 刪去的內容
視覺化wikitext
imported>Wr
小 （导入1个版本）
imported>Wr
小 （页面内容被替换为“{{Documentation}} {{Wikipedia template}} '''Module:Hatnote''' 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.”）
 
（未顯示同一使用者於中間所作的 1 次修訂）
第1行：
{{Documentation}}
{{used in system|in [[MediaWiki:Wantedpages-summary]]}}
{{Wikipedia template}}
{{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'''Module:Hatnote''' 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 ==
 
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 <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 [[Module:Hatnote/styles.css]].
 
; Example 1
 
<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.}}
 
; Example 2
 
<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}}
 
=== Find namespace 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}} &rarr; 0
: {{code|mHatnote.findNamespaceId('Category:Lions')|lua}} &rarr; 14
: {{code|mHatnote.findNamespaceId(':Category:Lions')|lua}} &rarr; 14
: {{code|mHatnote.findNamespaceId(':Category:Lions', false)|lua}} &rarr; 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 <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:
:{{code|mHatnote.makeWikitextError('an error has occurred')|lua}} &rarr; <strong class="error">Error: an error has occurred.</strong>
:{{code|mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')|lua}} &rarr; <strong class="error">Error: an error has occurred ([[Template:Example#Errors|help]]).</strong>
 
== Examples ==
 
For an example of how this module is used in other Lua modules, see [[Module:Main]]
<includeonly>{{Sandbox other||
<!-- Categories go here and interwikis go in Wikidata. -->
[[Category:Hatnote modules| ]]
[[Category:Modules that add a tracking category]]
 
}}</includeonly>

於 2023年5月7日 (日) 16:02 的最新修訂

Module:Hatnote's function hatnote is invoked by Template:Hatnote.
Module:Hatnote 使用了 3 個模塊: Module:Arguments, Module:LibraryUtil, and Module:Yesno
Module:Hatnote is required by 8 modules: Module:About, Module:DependencyList, Module:Documentation, Module:For, Module:Hatnote list, Module:Labelled list hatnote, Module:Main, and Module:Redirect hatnote.
Module:Hatnote invokes Module:Hatnote/styles.css using TemplateStyles.
Function list
L 20 — getArgs
L 27 — removeInitialColon
L 32 — p.defaultClasses
L 40 — p.disambiguate
L 49 — p.findNamespaceId
L 69 — p.makeWikitextError
L 114 — p.quote
L 137 — decorateHatnote
L 138 — getIcon
L 161 — p.hatnote
L 177 — p._hatnote

Module:Hatnote 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.

取自 "https://sonicpedia.org/wiki/Module:Hatnote/doc?oldid=11132"
Cookies 幫助我們給予服務內容。依您有使用我們的服務，代表您同意我們使用 cookies。
更多資訊