Difference between revisions of "Module:Demo"

From blackwiki
Jump to navigation Jump to search
test>CambridgeBayWeather
m (Protected "Module:Demo": Highly visible template ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite)))
test>CambridgeBayWeather
m (Protected "Template:Demo": Highly visible template ([Edit=Require template editor access] (indefinite) [Move=Require template editor access] (indefinite)))
Line 1: Line 1:
local p = {}
+
{{#invoke:Demo|main}}<noinclude>{{documentation}}</noinclude>
 
 
--creates a frame object that cannot access any of the parent's args
 
--unless a table containing a list keys of not to inherit is provided
 
function disinherit(frame, onlyTheseKeys)
 
local parent = frame:getParent() or frame
 
local orphan = parent:newChild{}
 
orphan.getParent = parent.getParent --returns nil
 
orphan.args = {}
 
if onlyTheseKeys then
 
local family = {parent, frame}
 
for f = 1, 2 do
 
for k, v in pairs(family[f] and family[f].args or {}) do
 
orphan.args[k] = orphan.args[k] or v
 
end
 
end
 
parent.args = mw.clone(orphan.args)
 
setmetatable(orphan.args, nil)
 
for _, k in ipairs(onlyTheseKeys) do
 
rawset(orphan.args, k, nil)
 
end
 
end
 
return orphan, parent
 
end
 
 
 
function p.get(frame, arg, passArgs)
 
local orphan, frame = disinherit(frame, passArgs and {arg or 1})
 
local code, noWiki, preserve = frame.args[arg or 1] or ''
 
if code:match'nowiki' then
 
local placeholder, preserve = ('6'):char(), {}
 
code = mw.text.unstripNoWiki(code)
 
noWiki = code:gsub('%%', placeholder):gsub('&lt;', '<'):gsub('&gt;', '>')
 
for k in noWiki:gmatch('&.-;') do
 
if not preserve[k] then
 
preserve[k] = true
 
table.insert(preserve, (k:gsub('&', '&amp;')))
 
noWiki = noWiki:gsub('(&.-;)', '%%%s')
 
end
 
end
 
noWiki = mw.text.nowiki(noWiki):format(unpack(preserve)):gsub(placeholder, '%%')
 
end
 
local kill_categories = frame.args.demo_kill_categories or frame.args.nocat
 
return {
 
source = noWiki or code,
 
output = orphan:preprocess(code):gsub(kill_categories and '%[%[Category.-%]%]' or '', ''),
 
frame = frame
 
}
 
end
 
 
 
function p.main(frame, demoTable)
 
local show = demoTable or p.get(frame)
 
local args = show.frame.args
 
args.br = tonumber(args.br or 1) and ('<br>'):rep(args.br or 1) or args.br or ''
 
if show[args.result_arg] then
 
return show[args.result_arg]
 
end
 
return string.format('<pre%s>%s</pre>%s%s', args.style and string.format(" style='%s'", args.style) or '', show.source, args.br, show.output)
 
end
 
 
 
-- Alternate function to return an inline result
 
function p.inline(frame, demoTable)
 
local show = demoTable or p.get(frame)
 
local args = show.frame.args
 
if show[args.result_arg] then
 
return show[args.result_arg]
 
end
 
return string.format('<code%s>%s</code>%s%s', args.style and string.format(" style='%s'", args.style) or '', show.source, ' → ', show.output)
 
end
 
 
 
--passing of args into other module without preprocessing
 
function p.module(frame)
 
local orphan, frame = disinherit(frame, {
 
'demo_template',
 
'demo_module',
 
'demo_module_func',
 
'demo_main',
 
'demo_br',
 
'demo_result_arg',
 
'demo_kill_categories',
 
'nocat'
 
})
 
local template = frame.args.demo_template and 'Template:'..frame.args.demo_template
 
local demoFunc = frame.args.demo_module_func or 'main\n'
 
local demoModule = require('Module:' .. frame.args.demo_module)[demoFunc:match('^%s*(.-)%s*$')]
 
frame.args.br, frame.args.result_arg = frame.args.demo_br, frame.args.demo_result_arg
 
local kill_categories = frame.args.demo_kill_categories or frame.args.nocat
 
if demoModule then
 
local named = {insert = function(self, ...) table.insert(self, ...) return self end}
 
local source = {insert = named.insert, '{{', frame.args.demo_template or frame.args.demo_module, '\n'}
 
if not template then
 
source:insert(2, '#invoke:'):insert(4, '|'):insert(5, demoFunc)
 
end
 
local insertNamed = #source + 1
 
for k, v in pairs(orphan.args) do
 
local nan, insert = type(k) ~= 'number', {v}
 
local target = nan and named or source
 
target:insert'|'
 
if nan then
 
target:insert(k):insert'=':insert'\n'
 
table.insert(insert, 1, #target)
 
end
 
target:insert(unpack(insert))
 
local nowiki = v:match('nowiki')
 
if nowiki or v:match('{{.-}}') then
 
orphan.args[k] = frame:preprocess(nowiki and mw.text.unstripNoWiki(v) or v)
 
end
 
end
 
source:insert'}}'
 
table.insert(source, insertNamed, table.concat(named))
 
return p.main(orphan, {
 
source = mw.text.encode(table.concat(source), "<>'|=~"),
 
output = tostring(demoModule(orphan)):gsub(kill_categories and '%[%[Category.-%]%]' or '', ''),
 
frame = frame
 
})
 
else
 
return "ERROR: Invalid module function: "..demoFunc
 
end
 
end
 
 
 
return p
 

Revision as of 19:54, 2 January 2019

Lua error at line 1: unexpected symbol near '{'.

50px Module documentation[view] [edit] [history] [purge]

Usage

Usage via templates

This module supports Template:T

{{#invoke:Demo|main}}

and Template:T

{{#invoke:Demo|inline}}

The input must be wrapped in <nowiki>...</nowiki> tags or else it may be processed before the module can read it.

Usage in a module

If you want to use this in another module (such as to make the output prettier), you can get values like so:

require('Module:demo').get(frame)

Function get() returns a table containing:

  • source = the source code (without <pre>...</pre> wrappers, characters substituted with html entities)
  • output = the execution result of the source.
  • frame = the frame from which this template took the parameter.

By default, get() takes the first parameter of frame. If the frame uses a different parameter name for the nowiki-wrapped source, then place that name (as a string) as the second parameter, like so require('Module:demo').get(frame, 'alternate_name')

Example:

p = {}

 function p.main(frame)
  local parts = require('Module:demo').get(frame)
  return '<Pretty html><pre>' .. parts.source .. '</pre><more pretty html>' .. parts.output .. '<even more pretty html>'
 end

 return p

See also