To create new wiki account, please join us on #znc at Libera.Chat and ask admins to create a wiki account for you. You can say thanks to spambots for this inconvenience.

Difference between revisions of "Template:Module arguments"

From ZNC
Jump to navigation Jump to search
(Created page with "<noinclude>== Purpose == Every module page links to the explanation how to load modules. This template is supposed to unify all those texts. == How to use == {<nowiki>{</no...")
 
>5moufl
 
(3 intermediate revisions by 2 users not shown)
Line 5: Line 5:
  {<nowiki>{</nowiki>Module arguments
  {<nowiki>{</nowiki>Module arguments
  | count = How many arguments does the module accept (e.g. ''no'' or ''one'' or ''two to five''
  | count = How many arguments does the module accept (e.g. ''no'' or ''one'' or ''two to five''
| one = true if there's a maximum of one argument (cosmetic)
  | extra = Some description for the arguments, if any
  | extra = Some description for the arguments, if any
  | type = global or user, user is the default
  | type = global or user, user is the default
Line 16: Line 17:
{{Module arguments|count=two|extra=The arguments are a foo and a bar.}}
{{Module arguments|count=two|extra=The arguments are a foo and a bar.}}


</noinclude><includeonly>
</noinclude><includeonly>{{#ifeq:{{{noheading|no}}}|yes||=== Arguments ===}}
{{#ifeq:{{{noheading|no}}}|yes||=== Arguments ===}}
This {{{type|user}}} module takes {{{count|no}}} argument{{#ifeq:{{{one|false}}}|true||s}}. {{{extra|}}}
This {{{type|user}}} module takes {{{count|no}}} arguments. {{{extra|}}}


Read [[Modules#.28Un.29Loading_Modules|loading modules]] to learn more about loading modules.
Read [[Modules#.28Un.29Loading_Modules|loading modules]] to learn more about loading modules.</includeonly>
</includeonly>

Latest revision as of 13:59, 20 October 2012

Purpose

Every module page links to the explanation how to load modules. This template is supposed to unify all those texts.

How to use[edit]

{{Module arguments
| count = How many arguments does the module accept (e.g. no or one or two to five
| one = true if there's a maximum of one argument (cosmetic)
| extra = Some description for the arguments, if any
| type = global or user, user is the default
| noheading = yes means this template doesn't generate the Arguments section
}}

Example[edit]

{{Module arguments|count=two|extra=The arguments are a foo and a bar.}}

resuts in:

Arguments

This user module takes two arguments. The arguments are a foo and a bar.

Read loading modules to learn more about loading modules.