Difference between revisions of "Module:Lua banner"
Jump to navigation
Jump to search
Mediawiki>MSGJ (show link to module sandbox, requested by User:Andrybak) |
Mediawiki>Achim55 m (Reverted edits by 154.239.164.4 (talk) to last revision by Tacsipacsi) |
||
Line 1: | Line 1: | ||
-- This module implements the {{lua}} template. | -- This module implements the {{lua}} template. | ||
+ | |||
local yesno = require('Module:Yesno') | local yesno = require('Module:Yesno') | ||
local mList = require('Module:List') | local mList = require('Module:List') | ||
local mTableTools = require('Module:TableTools') | local mTableTools = require('Module:TableTools') | ||
local mMessageBox = require('Module:Message box') | local mMessageBox = require('Module:Message box') | ||
+ | local TNT = require('Module:TNT') | ||
+ | local lang = mw.getCurrentFrame():preprocess('{{int:lang}}') | ||
local p = {} | local p = {} | ||
+ | |||
+ | local function format(msg) | ||
+ | return TNT.formatInLanguage(lang, 'I18n/Lua banner', msg) | ||
+ | end | ||
+ | |||
+ | local function getConfig() | ||
+ | return mw.loadData('Module:Lua banner/config') | ||
+ | end | ||
function p.main(frame) | function p.main(frame) | ||
Line 19: | Line 30: | ||
end | end | ||
− | function p._main(args) | + | function p._main(args, cfg) |
local modules = mTableTools.compressSparseArray(args) | local modules = mTableTools.compressSparseArray(args) | ||
− | local box = p.renderBox(modules) | + | local box = p.renderBox(modules, cfg) |
− | local trackingCategories = p.renderTrackingCategories(args, modules) | + | local trackingCategories = p.renderTrackingCategories(args, modules, nil, cfg) |
return box .. trackingCategories | return box .. trackingCategories | ||
end | end | ||
− | function p.renderBox(modules) | + | function p.renderBox(modules, cfg) |
local boxArgs = {} | local boxArgs = {} | ||
if #modules < 1 then | if #modules < 1 then | ||
− | boxArgs.text = '<strong class="error"> | + | cfg = cfg or getConfig() |
+ | if cfg['allow_wishes'] then | ||
+ | boxArgs.text = format('wishtext') | ||
+ | else | ||
+ | boxArgs.text = string.format('<strong class="error">%s</strong>', format('error_emptylist')) | ||
+ | end | ||
else | else | ||
local moduleLinks = {} | local moduleLinks = {} | ||
for i, module in ipairs(modules) do | for i, module in ipairs(modules) do | ||
moduleLinks[i] = string.format('[[:%s]]', module) | moduleLinks[i] = string.format('[[:%s]]', module) | ||
− | |||
− | |||
− | |||
− | |||
end | end | ||
local moduleList = mList.makeList('bulleted', moduleLinks) | local moduleList = mList.makeList('bulleted', moduleLinks) | ||
− | + | boxArgs.text = format('header') .. '\n' .. moduleList | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
boxArgs.type = 'notice' | boxArgs.type = 'notice' | ||
boxArgs.small = true | boxArgs.small = true | ||
− | boxArgs.image = '[[File:Lua-logo-nolabel.svg|30px|alt=|link=]]' | + | boxArgs.image = string.format( |
+ | '[[File:Lua-logo-nolabel.svg|30px|alt=%s|link=%s]]', | ||
+ | format('logo_alt'), | ||
+ | format('logo_link') | ||
+ | ) | ||
return mMessageBox.main('mbox', boxArgs) | return mMessageBox.main('mbox', boxArgs) | ||
end | end | ||
− | function p.renderTrackingCategories(args, modules, titleObj) | + | function p.renderTrackingCategories(args, modules, titleObj, cfg) |
if yesno(args.nocat) then | if yesno(args.nocat) then | ||
return '' | return '' | ||
end | end | ||
− | + | ||
+ | cfg = cfg or getConfig() | ||
+ | |||
local cats = {} | local cats = {} | ||
− | + | ||
-- Error category | -- Error category | ||
− | if #modules < 1 then | + | if #modules < 1 and not cfg['allow_wishes'] and cfg['error_category'] then |
− | cats[#cats + 1] = ' | + | cats[#cats + 1] = cfg['error_category'] |
end | end | ||
− | + | ||
-- Lua templates category | -- Lua templates category | ||
titleObj = titleObj or mw.title.getCurrentTitle() | titleObj = titleObj or mw.title.getCurrentTitle() | ||
− | + | if titleObj.namespace == 10 | |
− | + | and not cfg['subpage_blacklist'][titleObj.subpageText] | |
− | + | then | |
− | + | local category = args.category | |
− | + | if not category then | |
− | + | local pagename = modules[1] and mw.title.new(modules[1]) | |
− | + | category = pagename and cfg['module_categories'][pagename.text] | |
− | local | ||
− | if | ||
− | local category = | ||
if not category then | if not category then | ||
− | + | if cfg['allow_wishes'] and #modules < 1 then | |
− | + | category = cfg['wish_category'] | |
− | + | else | |
− | + | category = cfg['default_category'] | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
end | end | ||
end | end | ||
+ | end | ||
+ | if category then | ||
+ | cats[#cats + 1] = category | ||
end | end | ||
end | end | ||
+ | |||
for i, cat in ipairs(cats) do | for i, cat in ipairs(cats) do | ||
cats[i] = string.format('[[Category:%s]]', cat) | cats[i] = string.format('[[Category:%s]]', cat) |
Revision as of 16:08, 15 February 2021
This Lua module is used on many pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them. |
30px | Uses Lua: |
This module implements the {{lua}} template.
Usage from wikitext
This module cannot be used directly from wikitext. It can only be used through the {{lua}} template. Please see the template page for documentation.
Usage from Lua modules
To use this module from other Lua modules, first load the module.
local mLuaBanner = require('Module:Lua banner')
You can then generate a side box using the _main function.
mLuaBanner._main(args)
The args variable should be a table containing the arguments to pass to the module. To see the different arguments that can be specified and how they affect the module output, please refer to the {{lua}} template documentation.
Tracking category
-- This module implements the {{lua}} template.
local yesno = require('Module:Yesno')
local mList = require('Module:List')
local mTableTools = require('Module:TableTools')
local mMessageBox = require('Module:Message box')
local TNT = require('Module:TNT')
local lang = mw.getCurrentFrame():preprocess('{{int:lang}}')
local p = {}
local function format(msg)
return TNT.formatInLanguage(lang, 'I18n/Lua banner', msg)
end
local function getConfig()
return mw.loadData('Module:Lua banner/config')
end
function p.main(frame)
local origArgs = frame:getParent().args
local args = {}
for k, v in pairs(origArgs) do
v = v:match('^%s*(.-)%s*$')
if v ~= '' then
args[k] = v
end
end
return p._main(args)
end
function p._main(args, cfg)
local modules = mTableTools.compressSparseArray(args)
local box = p.renderBox(modules, cfg)
local trackingCategories = p.renderTrackingCategories(args, modules, nil, cfg)
return box .. trackingCategories
end
function p.renderBox(modules, cfg)
local boxArgs = {}
if #modules < 1 then
cfg = cfg or getConfig()
if cfg['allow_wishes'] then
boxArgs.text = format('wishtext')
else
boxArgs.text = string.format('<strong class="error">%s</strong>', format('error_emptylist'))
end
else
local moduleLinks = {}
for i, module in ipairs(modules) do
moduleLinks[i] = string.format('[[:%s]]', module)
end
local moduleList = mList.makeList('bulleted', moduleLinks)
boxArgs.text = format('header') .. '\n' .. moduleList
end
boxArgs.type = 'notice'
boxArgs.small = true
boxArgs.image = string.format(
'[[File:Lua-logo-nolabel.svg|30px|alt=%s|link=%s]]',
format('logo_alt'),
format('logo_link')
)
return mMessageBox.main('mbox', boxArgs)
end
function p.renderTrackingCategories(args, modules, titleObj, cfg)
if yesno(args.nocat) then
return ''
end
cfg = cfg or getConfig()
local cats = {}
-- Error category
if #modules < 1 and not cfg['allow_wishes'] and cfg['error_category'] then
cats[#cats + 1] = cfg['error_category']
end
-- Lua templates category
titleObj = titleObj or mw.title.getCurrentTitle()
if titleObj.namespace == 10
and not cfg['subpage_blacklist'][titleObj.subpageText]
then
local category = args.category
if not category then
local pagename = modules[1] and mw.title.new(modules[1])
category = pagename and cfg['module_categories'][pagename.text]
if not category then
if cfg['allow_wishes'] and #modules < 1 then
category = cfg['wish_category']
else
category = cfg['default_category']
end
end
end
if category then
cats[#cats + 1] = category
end
end
for i, cat in ipairs(cats) do
cats[i] = string.format('[[Category:%s]]', cat)
end
return table.concat(cats)
end
return p