Module:For nowiki/doc

This is a documentation subpage for Module:For nowiki.
It may contain usage information, categories and other content that is not part of the original module page.

This module is rated as ready for general use. It has reached a mature state, is considered relatively stable and bug-free, and may be used wherever appropriate. It can be mentioned on help pages and other Wikipedia resources as an option for new users. To minimise server load and avoid disruptive output, improvements should be developed through sandbox testing rather than repeated trial-and-error editing.

This Lua module is used on approximately 11,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 directly.
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|conjunction=conjunction}}

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.
conjunction (optional) replaces separator between the second-to-last and last iteration.

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.

This page was redesigned at the edge.

Module:For nowiki/doc

Usage

Example

See also