Module:If preview: Difference between revisions
Appearance
Content deleted Content added
m Changed protection level for "Module:If preview": High-risk Lua module ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite)) |
merge in functionality from Module:Preview warning and add TemplateStyles, remove p.boolean as not necessary, move some stuff into a cfg page, and don't return temporaries in p.main, remove use |
||
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. |
|||
Usage: |
|||
{{#invoke:If preview|main|value_if_preview|value_if_not_preview}} |
|||
]] |
]] |
||
function p.main(frame) |
function p.main(frame) |
||
if cfg.preview then |
|||
local result = '' |
|||
⚫ | |||
Preview_mode = frame:preprocess('{{REVISIONID}}'); -- use magic word to get revision id |
|||
if not (Preview_mode == nil or Preview_mode == '') then -- if there is a value then this is not a preiview |
|||
⚫ | |||
else |
else |
||
return frame.args[2] or '' |
|||
end |
end |
||
return result |
|||
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. |
|||
Usage: |
|||
{{#invoke:If preview|pmain}} |
|||
]] |
]] |
||
function p.pmain(frame) |
function p.pmain(frame) |
||
return p.main(frame:getParent()) |
return p.main(frame:getParent()) |
||
⚫ | |||
local function warning_text(warning) |
|||
return mw.ustring.format( |
|||
cfg.warning_infrastructure, |
|||
cfg.templatestyles, |
|||
warning |
|||
⚫ | |||
end |
|||
⚫ | |||
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 |
|||
boolean |
|||
This function returns |
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 |
|||
Usage: |
|||
{{#invoke:If preview|boolean}} |
|||
]] |
]] |
||
--function p.warning(frame) |
|||
-- return p._warning(frame.args) |
|||
--end |
|||
--[[ |
|||
⚫ | |||
warning, but for pass-through templates like {{preview warning}} |
|||
local result = '' |
|||
]] |
|||
Preview_mode = frame:preprocess('{{REVISIONID}}'); -- use magic word to get revision id |
|||
function p.pwarning(frame) |
|||
if not (Preview_mode == nil or Preview_mode == '') then -- if there is a value then this is not a preiview |
|||
return p._warning(frame:getParent().args) |
|||
result = false; |
|||
else |
|||
result = true; -- no value (nil or empty string) so this is a preview |
|||
⚫ | |||
return result |
|||
end |
end |
||
⚫ | |||
return p |
return p |
Revision as of 19:01, 5 May 2021
![]() | This module is rated as ready for general use. It has reached a mature form and is thought to be relatively bug-free and ready for use wherever appropriate. It is ready to mention on help pages and other Wikipedia resources as an option for new users to learn. To reduce server load and bad output, it should be improved by sandbox testing rather than repeated trial-and-error editing. |
![]() | 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 321,000 pages, or roughly 1% of all pages. To avoid major disruption and server load, any changes should be tested in the module's /sandbox or /testcases subpages, or in your own module sandbox. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them. |
![]() | This module depends on the following other modules: |
![]() | This module uses TemplateStyles: |
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