Template:Lua/doc: Difference between revisions

Latest revision as of 20:39, 24 November 2024

This subpage contains documentation, categories, or other content that is not part of the template.
To view the template page itself, see Template:Lua.

العربية ∙ asturianu ∙ Boarisch ∙ беларуская (тарашкевіца) ∙ български ∙ বাংলা ∙ català ∙ čeština ∙ dansk ∙ Deutsch ∙ Zazaki ∙ Ελληνικά ∙ English ∙ Esperanto ∙ español ∙ eesti ∙ euskara ∙ فارسی ∙ suomi ∙ français ∙ galego ∙ עברית ∙ हिन्दी ∙ hrvatski ∙ magyar ∙ Bahasa Indonesia ∙ italiano ∙ 日本語 ∙ ქართული ∙ 한국어 ∙ кыргызча ∙ Lëtzebuergesch ∙ македонски ∙ മലയാളം ∙ ဘာသာမန် ∙ Bahasa Melayu ∙ Mirandés ∙ မြန်မာဘာသာ ∙ norsk bokmål ∙ Plattdüütsch ∙ Nederlands ∙ norsk ∙ polski ∙ português ∙ português do Brasil ∙ русский ∙ sicilianu ∙ Scots ∙ slovenščina ∙ српски / srpski ∙ svenska ∙ ไทย ∙ Türkçe ∙ українська ∙ اردو ∙ oʻzbekcha / ўзбекча ∙ Tiếng Việt ∙ 中文 ∙ 中文（简体） ∙ 中文（繁體） ∙ 中文（臺灣） ∙ +/−

Uses Lua:

Module:Lua banner

TNT

This template uses Module:TNT for localisation:

I18n/Lua banner.tab

Banner for templates that rely on Lua modules

The template automatically sets the following categories:

Category:Lua templates with errors, added if the module call contains errors.
Category:Lua-candidates, added if no module is listed.
Category:Lua-based templates, added if none of the below module_categories matches the first module listed.

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

Usage

Template parameters

Parameter text is empty

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.

Wikipedia's help about TemplateData • Commons-specific information

Banner for templates that rely on Lua modules

Template parameters
This template prefers inline formatting of parameters.
Parameter		Description	Type	Status
Module 1	`1`	Name of the main module used in the template. Use multiple parameters to specify multiple modules.	Page name	suggested
Module 10	`10`	Name of the tenth module.	Page name	optional
Module 2	`2`	Name of the second module.	Page name	optional
Module 3	`3`	Name of the third module.	Page name	optional
Module 4	`4`	Name of the fourth module.	Page name	optional
Module 5	`5`	Name of the fifth module.	Page name	optional
Module 6	`6`	Name of the sixth module.	Page name	optional
Module 7	`7`	Name of the seventh module.	Page name	optional
Module 8	`8`	Name of the eighth module.	Page name	optional
Module 9	`9`	Name of the ninth module.	Page name	optional
Custom Category	`category`	Default Lua-based templates	String	optional
No Category?	`nocat`	Whether to disable categorization. Default 0 Auto value `1`	Boolean	optional

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}}.

Example

{{Lua|Module:Bananas}}

renders as:

Uses Lua:

Module:Bananas

{{Lua|wish=true}}

renders as:

This template should use Lua

Localization

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

@@ Line 1: / Line 1: @@
-<!-- {{Lua|Module:Lua banner}} -->
+<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
-{{TemplateBox/sandbox
+{{TemplateBox
-| useTemplateData = 1
+| name = Lua
+| mbox =
+{{Lua|Module:Lua banner}}
+{{Uses TNT|Lua banner}}
+| desc-en = Banner for templates that rely on Lua modules
+| namespace = Template
+| usergroup = all
+| placement = In the {{para|mbox}} parameter of {{tld|TemplateBox}}.
-  |name               =Lua
-  |desc               =Banner for templates that rely on Lua modules
-  |namespace          =Template
-  |usergroup          =all
-  |placement          =doc
-  |example-value      =
-  |mustbesubst        =
-  |relieson           =
-  |usage-notes        =
-  |shorthand          =
 | setscats =
 * {{cl|{{#invoke:Data|Module:Lua banner/config|error_category}}}}, added if the module call contains errors{{#if:{{yesno|{{#invoke:Data|Module:Lua banner/config|allow_wishes}}}}|.
@@ Line 23: / Line 22: @@
 * {{cl|{{#invoke:Data|Module:Lua banner/config|module_categories|String}}}} ([[Module:String]])
 * {{cl|{{#invoke:Data|Module:Lua banner/config|module_categories|Iteration}}}} ([[Module:Iteration]])
-  |seealso            =
-  |type               =
-  |i18n-desc          =Translations in [[Data:I18n/Lua banner.tab]]
-  |i18n-subpage       =
-  |i18n-mediawiki-msg =
-  |i18n-method        =tnt
-  |example            =
-  |print              =
-| useTemplateData = 1
+| example = Module:Bananas
+| example-value = {{Lua|Module:Bananas|nocat=true}}
+| example3 = wish=true
+| example3-value = {{Lua|wish=true|nocat=true}}
+| seealso =
+* {{tld|Uses TemplateStyles}}
+* {{tld|Uses TNT}}
+| i18n-method = TNT
+| i18n-data-file = Lua banner
+| print = line
+| useTemplateData = only
 | 1        = 1
@@ Line 108: / Line 113: @@
 | 12type   = string
 }}
-<includeonly>[[Category:Internal link templates]]</includeonly>
+<includeonly>{{Sandbox other||
+<!-- Categories below this line; interwikis at Wikidata -->
+[[Category:Internal link templates]]
+}}</includeonly>