Template:Scribunto/doc

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

If an anchor is provided, the link will be wrapped in . For example:undefined

undefined

self and args
You may also use self to reference your own functions and args to specify args, like so:undefined

If the first char the pattern ^[:%.] then title specified by self will be inserted in front, minus any subpages, unless d with the \ char: undefined

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:undefined'

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

args2 and args3
Use to specify up to 3 argument variations.undefined

plain
If set to anything, the result will no longer be wrapped in .