Difference between revisions of "Template:Lua/doc"

From "PTTLink Wiki"
Jump to navigation Jump to search
Mediawiki>ExE Boss
(Update the `placement` parameter of {{TemplateBox/sandbox}}; →‎Examples: Add examples)
 
m (1 revision imported)
 

Latest revision as of 08:03, 24 January 2022

Banner for templates that rely on Lua modules

The template automatically sets the following categories:

Module categories: one of these categories is added if the first listed module is the listed module

Usage

{{Lua |1= }}

Template parameters

<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.


Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. <nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw <templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Discussion
There is an ongoing discussion about that matter. Feel invited to comment if you are experienced in either way, your time permits and if you like to share your opinion or to make a suggestion.


Wikipedia's help about TemplateDataCommons-specific information

Banner for templates that rely on Lua modules

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Module 11

Name of the main module used in the template. Use multiple parameters to specify multiple modules.

Pagesuggested
Module 22

Name of the second module.

Pageoptional
Module 33

Name of the third module.

Pageoptional
Module 44

Name of the fourth module.

Pageoptional
Module 55

Name of the fifth module.

Pageoptional
Module 66

Name of the sixth module.

Pageoptional
Module 77

Name of the seventh module.

Pageoptional
Module 88

Name of the eighth module.

Pageoptional
Module 99

Name of the ninth module.

Pageoptional
Module 1010

Name of the tenth module.

Pageoptional
No Category?nocat

Whether to disable categorization.

Default
0
Auto value
1
Booleanoptional
Custom Categorycategory

Default
Lua-based templates
Stringoptional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Placement:

In the |mbox= parameter of {{TemplateBox}}.

Examples

{{Lua|Module:Bananas}}

renders as:


{{Lua|wish=true}}

renders as:

⧼Seealso⧽

Localization

This template is localized using Module:TNT. These translations are stored in Data:I18n/Lua banner.tab.