dev
Documentation icon Template documentation
[view] [edit] [history] [purge]

Note: parts of or the entire template might not be visible without values provided.
Description
This template exposes Global Lua Modules/Docbunto and auto-generates documentation for Scribunto modules.
Syntax
Type {{Docbunto|<Module Name>|<...>}}
Sample output
{{Docbunto|Unindent|code = 1|boilerplate = 1}} gives...

Package function

unindent(str) (function)
Unindent resets the indentation level of mulitline strings.
Parameter: str Multiline string indented consistently. (string)
Returns: Unindented string. (string)

TemplateData

No description.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Module Name1 file

Module page name (without namespace).

Default: First sub-page of the "Global Lua Modules" root page or the top-level page name.

Default

{{#ifeq: {{NAMESPACE}}:{{ROOTPAGENAME}}

    | :Global Lua Modules

    | {{#titleparts: {{PAGENAME}} | 1 | 2 }}

    | {{ROOTPAGENAME}}

}}

Stringsuggested
Infobox Imageimage

Infobox image.

Fileoptional
Captioncaption

Infobox image caption.

Contentoptional
Allall

Include private items in documentation.

Default
false
Booleanoptional
Boilerplateboilerplate

Removal of boilerplate (license block comments).

Default
false
Booleanoptional
Codecode

Only document Docbunto code items - exclude article infobox and lede from rendered documentation.

Default
false
Booleanoptional
Coloncolon

Parses tags with a `:` suffix and without the `@` prefix. This bypasses the "doctag soup" some authors complain of.

Default
false
Booleanoptional
No Lua Referencenoluaref

Don't link to the Lua reference manual for types.

Default
false
Booleanoptional
Plainplain

Disable Markdown formatting in documentation.

Default
false
Booleanoptional
Prefacepreface

Preface text to insert between lede & item documentation, used to provide usage and code examples.

Contentsuggested
Simplesimple

Limit documentation to descriptions only. Removes documentation of subitem tags such as `@param` and `@field`.

Default
false
Booleanoptional
Sortsort

Sort documentation items in alphabetical order instead of source code order.

Default
false
Booleanoptional
Stripstrip

Remove table index in documentation.

Default
false
Booleanoptional
UListulist

Indent subitems as `<ul>` lists (LDoc/JSDoc behaviour) instead of `<dl>` list.

Default
false
Booleanoptional
Verboseverbose

Show description of a package function when documenting function modules.

Default
false
Booleanoptional