Note: parts of or the entire template might not be visible without values provided.
| This template uses Lua: |
- Description
- This template exposes Global Lua Modules/Docbunto and auto-generates documentation for Scribunto modules.
- Syntax
- Type
{{Docbunto|<Module Name>|<...>}} - Sample output
gives...{{Docbunto|Unindent|code = 1|boilerplate = 1}}
Package function
unindent(str)(function)- Unindent resets the indentation level of mulitline strings.
- Parameter:
strMultiline string indented consistently. (string) - Returns: Unindented string. (string)
TemplateData
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Module Name | 1 file |
Module page name (without namespace). Default: First sub-page of the "Global Lua Modules" root page or the top-level page name.
| String | suggested |
| Infobox Image | image | Infobox image. | File | optional |
| Caption | caption | Infobox image caption. | Content | optional |
| All | all | Include private items in documentation.
| Boolean | optional |
| Boilerplate | boilerplate | Removal of boilerplate (license block comments).
| Boolean | optional |
| Code | code | Only document Docbunto code items - exclude article infobox and lede from rendered documentation.
| Boolean | optional |
| Colon | colon | Parses tags with a `:` suffix and without the `@` prefix. This bypasses the "doctag soup" some authors complain of.
| Boolean | optional |
| No Lua Reference | noluaref | Don't link to the Lua reference manual for types.
| Boolean | optional |
| Plain | plain | Disable Markdown formatting in documentation.
| Boolean | optional |
| Preface | preface | Preface text to insert between lede & item documentation, used to provide usage and code examples. | Content | suggested |
| Simple | simple | Limit documentation to descriptions only. Removes documentation of subitem tags such as `@param` and `@field`.
| Boolean | optional |
| Sort | sort | Sort documentation items in alphabetical order instead of source code order.
| Boolean | optional |
| Strip | strip | Remove table index in documentation.
| Boolean | optional |
| UList | ulist | Indent subitems as `<ul>` lists (LDoc/JSDoc behaviour) instead of `<dl>` list.
| Boolean | optional |
| Verbose | verbose | Show description of a package function when documenting function modules.
| Boolean | optional |