Template:Docbunto
- Description
- This template exposes Module:Docbunto and auto-generates documentation for Scribunto modules.
- Syntax
- Type
{{Docbunto|Module Name|...}}
- Sample output
{{Docbunto|Docbunto|code=1}}
gives...
Package items
docbunto.main(f)
(function)- Template entrypoint for Template:Docbunto.
- Parameter:
f
Scribunto frame object. (table) - Returns: Module documentation output. (string)
docbunto.build(modname, options)
(function)- Scribunto documentation generator entrypoint.
- Parameters:
modname
Module page name (without namespace). Default: second-level subpage. (string; optional)options
Configuration options. (table; optional)options.all
Include local items in documentation. (boolean; optional)options.boilerplate
Removal of boilerplate (license block comments). (boolean; optional)options.caption
Infobox image caption. (string; optional)options.code
Only document Docbunto code items - exclude article infobox and lede from rendered documentation. Permits article to be edited in VisualEditor. (boolean; optional)options.colon
Format tags with a:
suffix and without the@
prefix. This bypasses the "doctag soup" some authors complain of. (boolean; optional)options.image
Infobox image. (string; optional)options.noluaref
Don't link to the Lua reference manual for types. (boolean; optional)options.plain
Disable Markdown formatting in documentation. (boolean; optional)options.preface
Preface text to insert between lede & item documentation, used to provide usage and code examples. (string; optional)options.simple
Limit documentation to descriptions only. Removes documentation of subitem tags such as@param
and@field
(see list). (boolean; optional)options.sort
Sort documentation items in alphabetical order. (boolean; optional)options.strip
Remove table index in documentation. (boolean; optional)options.ulist
Indent subitems as<ul>
lists (LDoc/JSDoc behaviour). (boolean; optional)
docbunto.taglet(modname, options)
(function)- Docbunto taglet parser for Scribunto modules.
- Parameters:
modname
Module page name (without namespace). (string; optional)options
Configuration options. (table; optional)
- Errors:
- 'Lua source code not found in $1' (string; line 906)
- 'documentation markup for Docbunto not found in $1' (string; line 912)
- Returns: Module documentation data. (table)
docbunto.doclet(data, options)
(function)- Doclet renderer for Docbunto taglet data.
- Parameters:
data
Taglet documentation data. (table)options
Configuration options. (table; optional)
- Returns: Wikitext documentation output. (string)
docbunto.tags
(table)- Token dictionary for Docbunto tags. Maps Docbunto tag names to tag tokens.
- Multi-line tags use the
'M'
token. - Multi-line preformatted tags use the
'ML'
token. - Identifier tags use the
'ID'
token. - Single-line tags use the
'S'
token. - Flags use the
'N'
token. - Type tags use the
'T'
token.
- Multi-line tags use the
Modules and Lua Libraries | |
---|---|
Databases | |
Module:Challenges (/Data) • Module:Enemies (/Data) • M:Environments (/Data) • Module:Equipment (/Data) • M:Interactables (/Data) • M:Items (/Data, /LogbookData) • M:Lore (/Data) • M:Skills (/Data) • M:StatusEffect (/Data) • M:Survivors (/Data) • M:Test Version History (/Data) | |
Wiki | |
M:EnvironmentTooltip • M:ItemTooltip • M:MonsterTooltip • M:StatusEffectTooltip • M:SurvivorTooltip | |
Template Databases | |
T:FriendlyNameToInternal • T:InternalNameToFriendly • T:Keyword | |
Full MediaWiki List • Full Module List • Full Template List • Lua reference manual |
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 |
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 |
Preface | preface | Preface text to insert between lede & item documentation, used to provide usage and code examples. | Content | suggested |