Module:If preview: Difference between revisions
Jump to navigation
Jump to search
en>Primefac m (Changed protection level for "Module:If preview": High-risk Lua module ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite))) |
m (1 revision imported) |
||
(3 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
local p = {} | local p = {} | ||
local cfg = mw.loadData('Module:If preview/configuration') | |||
--[[ | --[[ | ||
main | main | ||
This function returns | This function returns either the first argument or second argument passed to | ||
this module, depending on whether the page is being previewed. | |||
]] | ]] | ||
function p.main(frame) | function p.main(frame) | ||
if cfg.preview then | |||
return frame.args[1] or '' | |||
if | |||
else | else | ||
return frame.args[2] or '' | |||
end | end | ||
end | end | ||
Line 25: | Line 21: | ||
pmain | pmain | ||
This function returns | This function returns either the first argument or second argument passed to | ||
this module's parent (i.e. template using this module), depending on whether it | |||
is being previewed. | |||
]] | ]] | ||
function p.pmain(frame) | function p.pmain(frame) | ||
return p.main(frame:getParent()) | return p.main(frame:getParent()) | ||
end | |||
local function warning_text(warning) | |||
return mw.ustring.format( | |||
cfg.warning_infrastructure, | |||
cfg.templatestyles, | |||
warning | |||
) | |||
end | |||
function p._warning(args) | |||
local warning = args[1] and args[1]:match('^%s*(.-)%s*$') or '' | |||
if warning == '' then | |||
return warning_text(cfg.missing_warning) | |||
end | |||
if not cfg.preview then return '' end | |||
return warning_text(warning) | |||
end | end | ||
--[[ | --[[ | ||
warning | |||
This function returns the | This function returns a "preview warning", which is the first argument marked | ||
up with HTML and some supporting text, depending on whether the page is being previewed. | |||
disabled since we'll implement the template version in general | |||
]] | ]] | ||
--function p.warning(frame) | |||
-- return p._warning(frame.args) | |||
--end | |||
function p. | --[[ | ||
warning, but for pass-through templates like {{preview warning}} | |||
]] | |||
function p.pwarning(frame) | |||
return p._warning(frame:getParent().args) | |||
end | end | ||
return p | return p |
Latest revision as of 04:51, 23 February 2024
This module is subject to page protection. It is a highly visible module in use by a very large number of pages, or is substituted very frequently. Because vandalism or mistakes would affect many pages, and even trivial editing might cause substantial load on the servers, it is protected from editing. |
This Lua module is used on approximately 54,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages. Consider discussing changes on the talk page before implementing them.
Transclusion count updated automatically (see documentation). |
This module depends on the following other modules: |
null
This module implements {{If preview}} and {{Preview warning}}. It helps templates/modules determine if they are being previewed.
Prefer implementing the template versions in other templates.
In a module to use the main()
, you need to pass a frame table with an args table.
For the preview warning, use _warning()
.
local p = {}
local cfg = mw.loadData('Module:If preview/configuration')
--[[
main
This function returns either the first argument or second argument passed to
this module, depending on whether the page is being previewed.
]]
function p.main(frame)
if cfg.preview then
return frame.args[1] or ''
else
return frame.args[2] or ''
end
end
--[[
pmain
This function returns either the first argument or second argument passed to
this module's parent (i.e. template using this module), depending on whether it
is being previewed.
]]
function p.pmain(frame)
return p.main(frame:getParent())
end
local function warning_text(warning)
return mw.ustring.format(
cfg.warning_infrastructure,
cfg.templatestyles,
warning
)
end
function p._warning(args)
local warning = args[1] and args[1]:match('^%s*(.-)%s*$') or ''
if warning == '' then
return warning_text(cfg.missing_warning)
end
if not cfg.preview then return '' end
return warning_text(warning)
end
--[[
warning
This function returns a "preview warning", which is the first argument marked
up with HTML and some supporting text, depending on whether the page is being previewed.
disabled since we'll implement the template version in general
]]
--function p.warning(frame)
-- return p._warning(frame.args)
--end
--[[
warning, but for pass-through templates like {{preview warning}}
]]
function p.pwarning(frame)
return p._warning(frame:getParent().args)
end
return p