Module:If preview/sandbox: Difference between revisions
Content deleted Content added
No edit summary |
m Reverted edits by Awesome Aasim (talk) to last version by SilverLocust |
||
| Line 1: | Line 1: | ||
local p = {} |
local p = {} |
||
local getArgs = require("Module:Arguments").getArgs |
|||
local yn = require("Module:Yesno") |
|||
local cfg = mw.loadData('Module:If preview/configuration') |
local cfg = mw.loadData('Module:If preview/configuration') |
||
p.pvwc = p.pvwc or package.loaded["Module:If preview/preview warning counter"] |
|||
or require("Module:If preview/preview warning counter") |
|||
--[[ |
--[[ |
||
| Line 14: | Line 11: | ||
]] |
]] |
||
function p.main(frame) |
function p.main(frame) |
||
local args = getArgs(frame) |
|||
if cfg.preview then |
if cfg.preview then |
||
return args[1] or '' |
return frame.args[1] or '' |
||
else |
else |
||
return args[2] or '' |
return frame.args[2] or '' |
||
end |
end |
||
end |
end |
||
| Line 33: | Line 29: | ||
return p.main(frame:getParent()) |
return p.main(frame:getParent()) |
||
end |
end |
||
local function warning_text(warning) |
local function warning_text(warning) |
||
| Line 51: | Line 48: | ||
if not cfg.preview then return '' end |
if not cfg.preview then return '' end |
||
| ⚫ | |||
if yn(args['consolewarning']) then mw.addWarning('[' .. p.pvwc.incr() .. '] ' .. (args[1] or cfg.missing_warning)) end |
|||
return warning_text(warning) |
return warning_text(warning) |
||
end |
end |
||
| Line 60: | Line 57: | ||
This function returns a "preview warning", which is the first argument marked |
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. |
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) |
||
| ⚫ | |||
| ⚫ | |||
| ⚫ | |||
--[[ |
--[[ |
||
| Line 71: | Line 69: | ||
]] |
]] |
||
function p.pwarning(frame) |
function p.pwarning(frame) |
||
| ⚫ | |||
local args = getArgs(frame) |
|||
return p._warning(args) |
|||
end |
|||
--[[ |
|||
| ⚫ | |||
]] |
|||
function p.warn(text) |
|||
if text == nil or text == "" then return "" end |
|||
mw.addWarning('[' .. p.pvwc.incr() .. '] ' .. text) |
|||
return p._warning({text}) |
|||
end |
|||
--[[ |
|||
Console warning |
|||
]] |
|||
function p.consoleWarning(frame) |
|||
local args = getArgs(frame) |
|||
mw.addWarning('[' .. p.pvwc.incr() .. '] ' .. (args[1] or cfg.missing_warning)) |
|||
return '' |
|||
end |
end |
||
Revision as of 01:46, 21 September 2024
 | This is the module sandbox page for Module:If preview (diff). |
 | 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
mw.addWarning(warning)
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