Template:Luaref/doc

Usage

This helps with the creation of doc pages for Lua metamodules that reference the Template:Scribunto or specific function within it.

{{scribunto
|<!--anchor-->
|<!--link text-->
}}

If an anchor is provided, the link will be wrapped in <code>...</code>. For example:Template:Demo

Advanced

|self= and |args=

Template:Seealso2 You may also use |self={{PAGENAME}} to reference your own functions and |args= to specify args, like so:Template:Demo

If the first char Template:Scribunto/helper the pattern ^[:%.] then title specified by |self= will be inserted in front, minus any subpages, unless Template:Scribunto/helperd with the \ char: Template:Demo

no 'main'

If your module has no "main" method (e.g. Module:Buffer), you can pass the escape char \ as the first char in the function name to make a self-reference:Template:Demo'

If the second parameter contains ***, then the first param will be substituted (or the self-reference, as applicable): Template:Demo

|args2= and |args3=

Use to specify up to 3 argument variations.Template:Demo

|plain=

If set to anything, the result will no longer be wrapped in <code>...</code>.

See also

• {{Luaref/helper}} and {{Luaref/helper2}}, two helper templates. These should not be called directly.
• {{Luaself}}, a wrapper template that makes Lua self-references easier.
• Module:Buffer/doc, an example of a doc that uses this
• {{Lua}}
• Category:Lua metamodules