模組:Hatnote/doc
此頁面為 Module:Hatnote 的說明文件
此模組文件被引用於約239,000個頁面。 為了避免造成大規模的影響,所有對此模組文件的編輯應先於沙盒或測試樣例上測試。 測試後無誤的版本可以一次性地加入此模組文件中,但是修改前請務必於討論頁發起討論。 模板引用數量會自動更新。 |
此模組文件已被保護。此為高度可見模組文件,其已用於大量條目或被頻繁替換引用。由於破壞或失誤會影響諸多頁面,即便細小的改動也可能導致大量伺服器負載,因此已被保護,不可編輯。 |
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.
通過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.
local mHatnote = require('Module:Hatnote')
You can then use the functions as documented below.
題注
[編輯]mHatnote._hatnote(s, options)
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.
- 例甲
mHatnote._hatnote('This is a hatnote.')
Produces:
<div class="hatnote">This is a hatnote.</div>
Displays as:
- 例乙
mHatnote._hatnote('This is a hatnote.', {extraclasses = 'boilerplate seealso', selfref = true})
Produces:
<div class="hatnote boilerplate seealso selfref">This is a hatnote.</div>
Displayed as:
格式化連結
[編輯]mHatnote._formatLink(link, display)
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.
- 樣例
mHatnote._formatLink('Lion')
→ [[Lion]] → Template:Format hatnote linkmHatnote._formatLink('Lion#Etymology')
→ [[Lion#Etymology|Lion § Etymology]] → Template:Format hatnote linkmHatnote._formatLink('Category:獅')
→ [[:Category:Lions]] → Template:Format hatnote linkmHatnote._formatLink('Lion#Etymology', 'Etymology of lion')
→ [[Lion#Etymology|Etymology of lion]] → Template:Format hatnote link
格式頁面
[編輯]mHatnote.formatPages(...)
Formats a list of pages using the _formatLink function, and returns the result as an array. For example, the code mHatnote.formatPages('Lion', 'Category:Lions', 'Lion#Etymology')
would produce an array like {'[[Lion]]', '[[:Category:Lions]]', '[[Lion#Etymology|Lion § Etymology]]'}
.
格式頁面表格
[編輯]mHatnote.formatPageTables(...)
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 mHatnote.formatPages({'Lion', 'the Lion article'}, {'Category:Lions'}, {'Lion#Etymology', 'the etymology of lion'})
would produce an array like {'[[Lion|the Lion article]]', '[[:Category:Lions]]', '[[Lion#Etymology|the etymology of lion]]'}
.
查找名字空間id
[編輯]mHatnote.findNamespaceId(link, removeColon)
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
mHatnote.findNamespaceId('Lion')
→ 0mHatnote.findNamespaceId('Category:Lions')
→ 14mHatnote.findNamespaceId(':Category:Lions')
→ 14mHatnote.findNamespaceId(':Category:Lions', false)
→ 0 (the namespace is detected as ":Category", rather than "Category")
顯示wikitext錯誤
[編輯]mHatnote.makeWikitextError(msg, helpLink, addTrackingCategory)
Formats the string msg as a red wikitext error message, with optional link to a help page helpLink. Normally this function also adds Category:有錯誤的頂注模板(5); 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 false
.
樣例:
mHatnote.makeWikitextError('an error has occurred')
→ 錯誤:出現了一個錯誤。mHatnote.makeWikitextError('an error has occurred', 'Template:Example#Errors')
→ 錯誤:出現了一個錯誤(幫助)。
樣例
[編輯]For examples of how this module is used in other Lua modules, see the following (listed in order of complexity):