Module:For nowiki/doc: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 01:12, 9 September 2024

This Lua module is used on approximately 9,000 pages and changes may be widely noticed. Test changes in the module's /sandbox or /testcases subpages, or in your own module sandbox. Consider discussing changes on the talk page before implementing them.

This module implements a foreach loop that can be used from wikitext. It exports two functions:

main - Implements {{For nowiki}}, which can be used with explicitly provided parameters. Should not be called diretly.
template - Designed to be used from within other templates. It takes explicit configuration parameters but it uses parameters passed to the parent frame (the template) for all others. Should be called directly.

Usage

{{#invoke:For nowiki|template|separator|<nowiki>wikitext</nowiki>|offset=offset}}

separator and wikitext function the same as described in Template:For nowiki/doc#Usage.
offset is the offset of the first argument to process. Defaults to 0, which means the |1= parameter passed to the template is the first parameter processed.

Example

If you have a template _TEMPLATE_:

{{#invoke:For nowiki|template|
|<nowiki>* {{{i}}} is {{{1}}}. Next is {{#expr:{{{i}}} + 1}}.</nowiki>}}

Then calling:

{{_TEMPLATE_|A|B|Foo|Orange}}

Would produce:

1 is A. Next is 2.
2 is B. Next is 3.
3 is Foo. Next is 4.
4 is Orange. Next is 5.

@@ Line 7: / Line 7: @@
 == Usage ==
- {{ml|For nowiki|template|''separator''|<code>&lt;nowiki&gt;''wikitext''&lt;/nowiki&gt;</code>}}
+ {{ml|For nowiki|template|''separator''|<code>&lt;nowiki&gt;''wikitext''&lt;/nowiki&gt;</code>|offset{{=}}''offset''}}
 * <code>''separator''</code> and <code>''wikitext''</code> function the same as described in [[Template:For nowiki/doc#Usage]].
@@ Line 13: / Line 13: @@
 == Example ==
+If you have a template <code>_TEMPLATE_</code>:
-[[Module:For nowiki/doc/example]]:
+<syntaxhighlight lang="wikitext">{{#invoke:For nowiki|template|
+|<nowiki>* {{{i}}} is {{{1}}}. Next is {{#expr:{{{i}}} + 1}}.</nowiki>}}</syntaxhighlight>
+Then calling:
-<pre>{{#invoke:For nowiki|template|<br>|&lt;nowiki&gt;{{{i}}} is {{{1}}}. Next is {{#expr:{{{i}}} + 1}}.&lt;/nowiki&gt;}}</pre>
+<syntaxhighlight lang="wikitext">{{_TEMPLATE_|A|B|Foo|Orange}}</syntaxhighlight>
+Would produce:
-Calling:
+{{Call wikitext|sourceCode=<nowiki>{{#invoke:For nowiki|template|
+|&lt;nowiki&gt;* {{{i}}} is {{{1}}}. Next is {{#expr:{{{i}}} + 1}}.&lt;/nowiki&gt;}}</nowiki>|A|B|Foo|Orange}}
-<pre>{{Module:For nowiki/doc/example|A|B|Foo|Orange}}</pre>
-Produces:
-{{Module:For nowiki/doc/example|A|B|Foo|Orange}}
 == See also ==
@@ Line 31: / Line 30: @@
 <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 <!-- Categories below this line, please; interwikis at Wikidata -->
-[[Category:Wikipedia utility modules]]
+[[Category:Template metamodules]]
-[[Category:Wikipedia metatemplates]]
 }}</includeonly><noinclude>
 [[Category:Module documentation pages]]