Module:Demo/doc
 | This is a documentation subpage for Module:Demo. It may contain usage information, categories and other content that is not part of the original module page. |
 | This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing. |
 | This module depends on the following other modules: |
Usage
[edit]Usage via templates
[edit]This module supports {{Demo}}
{{#invoke:Demo|main}}
and {{Demo inline}}
{{#invoke:Demo|inline}}
The input must be wrapped in <nowiki> tags or else it may be processed before the module can read it.
Usage in a module
[edit]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<syntaxhighlight>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:
local 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
[edit]- Template:Nowiki template demo which uses Module:Template test case
- Template:Automarkup which uses Module:Automarkup