Difference between revisions of "Module:Demo/doc"

From blackwiki
Jump to navigation Jump to search
blackwiki>Codehydro
m (5 revisions imported)
 
(2 intermediate revisions by one other user not shown)
Line 2: Line 2:
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
 
== Usage ==
 
== Usage ==
 +
 +
=== Usage via templates ===
 
This module supports {{t|Demo}}
 
This module supports {{t|Demo}}
  
 
  <nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''main''}}
 
  <nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''main''}}
  
The input must be wrapped in {{tag|nowiki}} tags or else it may be processed before the module can read it. If you want to use this in another module (such as to make the output prettier), you can get values like so:
+
and {{t|Demo-inline}}
 +
 
 +
<nowiki>{{</nowiki>#invoke:{{BASEPAGENAME}}|''inline''}}
 +
 
 +
The input must be wrapped in {{tag|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:
 
<pre>require('Module:demo').get(frame)</pre>
 
<pre>require('Module:demo').get(frame)</pre>
  
Line 26: Line 35:
 
  return p</nowiki>
 
  return p</nowiki>
  
 
+
== See also ==
 +
* [[Template:Nowiki template demo]] which uses [[Module:Template test case]]
 +
* [[Template:Automarkup]] which uses [[Module:Automarkup]]
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

Latest revision as of 13:48, 24 September 2020

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