Difference between revisions of "Module:Main"
m (Protected Module:Main: High-risk Lua module ([Edit=Allow only template editors and admins] (indefinite) [Move=Allow only template editors and admins] (indefinite))) |
(Removed extraclasses option; those classes appear to be deprecated) |
||
Line 9: | Line 9: | ||
local mHatnote = require('Module:Hatnote') | local mHatnote = require('Module:Hatnote') | ||
− | local | + | local mHatlist = require('Module:Hatnote list') |
local mArguments -- lazily initialise | local mArguments -- lazily initialise | ||
− | |||
local p = {} | local p = {} | ||
function p.main(frame) | function p.main(frame) | ||
− | |||
mArguments = require('Module:Arguments') | mArguments = require('Module:Arguments') | ||
local args = mArguments.getArgs(frame, {parentOnly = true}) | local args = mArguments.getArgs(frame, {parentOnly = true}) | ||
Line 21: | Line 19: | ||
for k, v in pairs(args) do | for k, v in pairs(args) do | ||
if type(k) == 'number' then | if type(k) == 'number' then | ||
− | local display = args['l' .. | + | local display = args['label ' .. k] or args['l' .. k] |
− | local page = | + | local page = display and |
− | pages[ | + | string.format('%s|%s', string.gsub(v, '|.*$', ''), display) or v |
+ | pages[#pages + 1] = page | ||
end | end | ||
end | end | ||
− | pages = | + | if #pages == 0 and mw.title.getCurrentTitle().namespace == 0 then |
+ | return mHatnote.makeWikitextError( | ||
+ | 'no page names specified', | ||
+ | 'Template:Main#Errors', | ||
+ | args.category | ||
+ | ) | ||
+ | end | ||
local options = { | local options = { | ||
selfref = args.selfref | selfref = args.selfref | ||
} | } | ||
− | return p._main(options | + | return p._main(pages, options) |
end | end | ||
− | function p._main(options | + | function p._main(args, options) |
-- Get the list of pages. If no first page was specified we use the current | -- Get the list of pages. If no first page was specified we use the current | ||
-- page name. | -- page name. | ||
− | |||
local currentTitle = mw.title.getCurrentTitle() | local currentTitle = mw.title.getCurrentTitle() | ||
− | + | if #args == 0 then args = {currentTitle.text} end | |
− | + | local firstPage = string.gsub(args[1], '|.*$', '') | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
-- Find the pagetype. | -- Find the pagetype. | ||
− | local | + | local pageType = mHatnote.findNamespaceId(firstPage) == 0 and 'article' or 'page' |
− | |||
− | |||
-- Make the formatted link text | -- Make the formatted link text | ||
− | + | list = mHatlist.andList(args, true) | |
− | |||
− | |||
-- Build the text. | -- Build the text. | ||
− | local isPlural = # | + | local isPlural = #args > 1 |
− | local | + | local mainForm |
− | + | local curNs = currentTitle.namespace | |
− | + | if (curNs == 14) or (curNs == 15) then --category/talk namespaces | |
− | + | mainForm = isPlural and | |
− | + | 'The main %ss for this [[Wikipedia:Categorization|category]] are %s' | |
− | + | or | |
− | + | 'The main %s for this [[Wikipedia:Categorization|category]] is %s' | |
− | |||
− | |||
− | |||
− | |||
else | else | ||
− | + | mainForm = isPlural and 'Main %ss: %s' or 'Main %s: %s' | |
− | |||
− | |||
− | |||
− | |||
end | end | ||
− | local text = string.format( | + | local text = string.format(mainForm, pageType, list) |
− | |||
-- Process the options and pass the text to the _rellink function in | -- Process the options and pass the text to the _rellink function in | ||
-- [[Module:Hatnote]]. | -- [[Module:Hatnote]]. | ||
options = options or {} | options = options or {} | ||
local hnOptions = { | local hnOptions = { | ||
− | |||
selfref = options.selfref | selfref = options.selfref | ||
} | } |
Revision as of 00:34, 29 June 2016
This module produces a link to a main article or articles. It implements the {{main}} template. Normally, it produces a link like "Main article: A". If used in the category namespace, it produces a link like "The main article for this category is A". It is possible to specify multiple articles, and in this case plural wording is used automatically. If the first link is not an article, the module uses the wording "Main page" instead of "Main article".
Contents
Usage from wikitext
This module cannot be accessed directly from #invoke. Instead, it can only be used through the {{main}} template. Please see the template page for documentation.
Usage from other Lua modules
Load the module:
local mMain = require('Module:Main')
You can then use the _main function like this:
mMain._main(options, ...)
The parameters following options are a list of link/display tables, used to generate the links. The first value in each table is the link, and is required. The second value in each table is the display value, and is optional. Category or file links are automatically escaped using the colon trick. If a link includes a section name, and no display value is set, links are automatically formatted as page § section, rather than the MediaWiki default of page#section.
The options table can be used to configure the function's output. At current, the only option available is "selfref", which is used when the output is a self-reference to Wikipedia. to set this option, use {selfref = true}
. (See the {{selfref}} template for more details on self-references.)
Example 1
mMain._main(nil, {'A'})
Produces:
<div role="note" class="hatnote relarticle mainarticle">Main article: [[A]]</div>
Displays as:
Example 2
mMain._main(nil, {'Wikipedia:Categorization'}, {'Help:Category'}, {'Category:Wikipedia categories'})
Produces:
<div role="note" class="hatnote relarticle mainarticle">Main pages: [[Wikipedia:Categorization]], [[Help:Category]] and [[:Category:Wikipedia categories]]</div>
Displays as:
Example 3
mMain._main(nil, {'A', 'the letter "A"'}, {'B', 'the letter "B"'}, {'C', 'the letter "C"'})
Produces:
<div role="note" class="hatnote relarticle mainarticle">Main articles: [[A|the letter "A"]], [[B|the letter "B"]] and [[C|the letter "C"]]</div>
Displays as:
Example 4
mMain._main({selfref = true}, {'Wikipedia:Verifiability#Burden'})
Produces:
<div role="note" class="hatnote relarticle mainarticle selfref">Main article: [[Wikipedia:Verifiability#Burden|Wikipedia:Verifiability § Burden]]</div>
Displays as:
Example 5 (if used in the category namespace)
mMain._main(nil, {'A'})
Produces:
<div role="note" class="hatnote relarticle mainarticle">The main article for this [[Wikipedia:Categorization|category]] is [[A]]</div>
Displays as:
Technical details
This module uses Module:Hatnote to format the hatnote text, Module:TableTools to process the list of links, and Module:Arguments to fetch the arguments from wikitext.
--[[ -- This module produces a link to a main article or articles. It implements the -- template {{main}}. -- -- If the module is used in category or category talk space, it produces "The -- main article for this category is xxx". Otherwise, it produces -- "Main article: xxx". --]] local mHatnote = require('Module:Hatnote') local mHatlist = require('Module:Hatnote list') local mArguments -- lazily initialise local p = {} function p.main(frame) mArguments = require('Module:Arguments') local args = mArguments.getArgs(frame, {parentOnly = true}) local pages = {} for k, v in pairs(args) do if type(k) == 'number' then local display = args['label ' .. k] or args['l' .. k] local page = display and string.format('%s|%s', string.gsub(v, '|.*$', ''), display) or v pages[#pages + 1] = page end end if #pages == 0 and mw.title.getCurrentTitle().namespace == 0 then return mHatnote.makeWikitextError( 'no page names specified', 'Template:Main#Errors', args.category ) end local options = { selfref = args.selfref } return p._main(pages, options) end function p._main(args, options) -- Get the list of pages. If no first page was specified we use the current -- page name. local currentTitle = mw.title.getCurrentTitle() if #args == 0 then args = {currentTitle.text} end local firstPage = string.gsub(args[1], '|.*$', '') -- Find the pagetype. local pageType = mHatnote.findNamespaceId(firstPage) == 0 and 'article' or 'page' -- Make the formatted link text list = mHatlist.andList(args, true) -- Build the text. local isPlural = #args > 1 local mainForm local curNs = currentTitle.namespace if (curNs == 14) or (curNs == 15) then --category/talk namespaces mainForm = isPlural and 'The main %ss for this [[Wikipedia:Categorization|category]] are %s' or 'The main %s for this [[Wikipedia:Categorization|category]] is %s' else mainForm = isPlural and 'Main %ss: %s' or 'Main %s: %s' end local text = string.format(mainForm, pageType, list) -- Process the options and pass the text to the _rellink function in -- [[Module:Hatnote]]. options = options or {} local hnOptions = { selfref = options.selfref } return mHatnote._hatnote(text, hnOptions) end return p