Module:Demo/doc
Yi palo
This is the documentation page for Module:Demo
![]() | 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. |
Usage
[mali mi di yibu sheena n-niŋ]Usage via templates
[mali mi di yibu sheena n-niŋ]This module supports {{Demo}}
{{#invoke:Demo|main}}
and {{Demo inline}}
{{#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
[mali mi di yibu sheena n-niŋ]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
[mali mi di yibu sheena n-niŋ]- Template:Nowiki template demo which uses Module:Template test case
- Template:Automarkup which uses Module:Automarkup