Module:Main list: Difference between revisions
hp>MusikAnimal m Protected "Module:Main list": High-risk module ([Edit=Require autoconfirmed or confirmed access] (indefinite)) |
Humanipedia (talk | contribs) m 1 revision imported |
(No difference)
|
Latest revision as of 00:36, 28 January 2025
This module produces a "For a more comprehensive list, see [...]" link. It implements the {{main list}} template.
Use from wikitext[edit source]
This module cannot be used directly from #invoke. Instead, it can only be used through the {{main list}} template. Please see the template page for documentation.
Use from other Lua modules[edit source]
Load the module:
<syntaxhighlight lang="lua"> local mMainList = require('Module:Main list') </syntaxhighlight>
You can then use the _mainList function like this:
<syntaxhighlight lang="lua"> mMainList._mainList (page1, page2) </syntaxhighlight>
The page1 variable is the page to be linked to, and is required. The page name can include a section link if desired. If the page includes a section link, it is automatically formatted as page § section, rather than the MediaWiki default of page#section.
The page2 variable is optional; it is a second page link.
Example 1[edit source]
<syntaxhighlight lang="lua"> mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates') </syntaxhighlight> Produces:
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]].</div>
Displays as:
Example 2[edit source]
<syntaxhighlight lang="lua"> mMainList._mainList ('Wikipedia:Hatnote#Hatnote templates','Wikipedia:Template messages/Cleanup#Cleanup') </syntaxhighlight> Produces:
<div class="hatnote">For a more comprehensive list, see [[Wikipedia:Hatnote#Hatnote templates|Wikipedia:Hatnote § Hatnote templates]] and [[Wikipedia:Template messages/Cleanup#Cleanup|Wikipedia:Template messages/Cleanup § Cleanup]].</div>
Displays as:
Technical details[edit source]
This module uses Module:Hatnote to format the hatnote text and Module:Arguments to fetch the arguments from wikitext.
--[[
-- This module produces a "For more details on this topic" link. It implements
-- the {{Main list}} template.
--]]
local mHatnote = require('Module:Hatnote')
local mHatlist = require('Module:Hatnote list')
local mArguments -- lazily initialise
local mTableTools -- lazily initialise
local p = {}
function p.mainList(frame)
mArguments = require('Module:Arguments')
mTableTools = require('Module:TableTools')
local args = mArguments.getArgs(frame, {parentOnly = true})
if not args[1] then
return mHatnote.makeWikitextError(
'no page name specified',
'Template:Main list#Errors',
args.category
)
end
return p._mainList(mTableTools.compressSparseArray(args))
end
function p._mainList(args)
local pages = mHatlist.andList(args, true)
local text = string.format('For a more comprehensive list, see %s.', pages)
return mHatnote._hatnote(text)
end
return p