Wikipedia>Awesome Aasim: /* Examples */

2025-03-10T18:31:56Z

Examples

New page

{{Documentation subpage}}
{{Lua|Module:Docbunto}}
== Usage ==
{{tlx|Lua autodoc|2=file=Module name}}

== Examples ==
{{tlx|Lua autodoc|2=file=Docbunto|3=code=yes}} yields:
{{ctop}}
{{#invoke:Suppress categories|main|1={{Lua autodoc|file=Docbunto|code=yes}}}}
{{cbot}}

{{tlx|Lua autodoc|2=file=Example|3=code=yes}} yields:
{{ctop}}
{{#invoke:Suppress categories|main|1={{Lua autodoc|file=Example|code=yes}}}}
{{cbot}}

{{tlx|Lua autodoc|2=file=Sandbox|3=code=yes}} yields:
{{ctop}}
{{#invoke:Suppress categories|main|1={{Lua autodoc|file=Sandbox|code=yes}}}}
{{cbot}}

== Template data ==
<templatedata>
{
"format": "block",
"params": {
"1": {
"label": "Module Name",
"aliases": [
"file"
],
"description": "\nModule page name (without namespace).",
"suggested": true,
"type": "string"
},
"preface": {
"label": "Preface",
"description": "Preface text to insert between lede & item documentation, used to provide usage and code examples.",
"suggested": true,
"type": "content"
},
"image": {
"label": "Infobox Image",
"description": "Infobox image.",
"type": "wiki-file-name"
},
"caption": {
"label": "Caption",
"description": "Infobox image caption.",
"type": "content"
},
"all": {
"label": "All",
"description": "Include private items in documentation.",
"default": "false",
"type": "boolean"
},
"boilerplate": {
"label": "Boilerplate",
"description": "Removal of boilerplate (license block comments).",
"default": "false",
"type": "boolean"
},
"code": {
"label": "Code",
"description": "Only document Docbunto code items - exclude article infobox and lede from rendered documentation.",
"default": "false",
"type": "boolean"
},
"colon": {
"label": "Colon",
"description": "Parses tags with a `:` suffix and without the `@` prefix. This bypasses the \"doctag soup\" some authors complain of.",
"default": "false",
"type": "boolean"
},
"noluaref": {
"label": "No Lua Reference",
"description": "Don't link to the Lua reference manual for types.",
"default": "false",
"type": "boolean"
},
"plain": {
"label": "Plain",
"description": "Disable Markdown formatting in documentation.",
"default": "false",
"type": "boolean"
},
"simple": {
"label": "Simple",
"description": "Limit documentation to descriptions only. Removes documentation of subitem tags such as `@param` and `@field`.",
"default": "false",
"type": "boolean"
},
"sort": {
"label": "Sort",
"description": "Sort documentation items in alphabetical order instead of source code order.",
"default": "false",
"type": "boolean"
},
"strip": {
"label": "Strip",
"description": "Remove table index in documentation.",
"default": "false",
"type": "boolean"
},
"ulist": {
"label": "UList",
"description": "Indent subitems as `<ul>` lists (LDoc/JSDoc behaviour) instead of `<dl>` list.",
"default": "false",
"type": "boolean"
}
},
"paramOrder": [
"1",
"image",
"caption",
"all",
"boilerplate",
"code",
"colon",
"noluaref",
"plain",
"simple",
"sort",
"strip",
"ulist",
"preface"
]
}
</templatedata>

<includeonly>{{Sandbox other||

[[Category:Documentation templates]]
[[Category:Wikipedia Lua-related templates]]
}}</includeonly>

Template:Lua autodoc/doc - Revision history

Wikipedia>Awesome Aasim: /* Examples */