Module:ArgRest/doc - Revision history

Uzume: /* Usage */ "Wikipedia"->"Mediawiki": Mediawiki is the main software that runs Wikipedia page rendering

2025-05-11T12:02:35Z

Usage: "Wikipedia"->"Mediawiki": Mediawiki is the main software that runs Wikipedia page rendering

← Previous revision		Revision as of 12:02, 11 May 2025
Line 8:		Line 8:

	Afterwards, the module will "fill in" parameters with larger numbers than the ones originally given; i.e. in the above example, the module would allow the containing template to receive parameters <code><nowiki>{{{named-3-a}}}</nowiki></code>, <code><nowiki>{{{named-3-b}}}</nowiki></code>, <code><nowiki>{{{named-4-a}}}</nowiki></code>, etc.<br />		Afterwards, the module will "fill in" parameters with larger numbers than the ones originally given; i.e. in the above example, the module would allow the containing template to receive parameters <code><nowiki>{{{named-3-a}}}</nowiki></code>, <code><nowiki>{{{named-3-b}}}</nowiki></code>, <code><nowiki>{{{named-4-a}}}</nowiki></code>, etc.<br />
	<strong>Note: You MUST wrap the first parameter in <code class="cm-mw-htmltag-name"><nowiki></code>;</strong> otherwise, ~~Wikipedia~~ processes ''all'' wikitext and HTML syntax before the module receives it, which makes it impossible to use pattern matching due to the resulting pollution. If you do, the module will give this error:		<strong>Note: You MUST wrap the first parameter in <code class="cm-mw-htmltag-name"><nowiki></code>;</strong> otherwise, Mediawiki processes ''all'' wikitext and HTML syntax before the module receives it, which makes it impossible to use pattern matching due to the resulting pollution. If you do, the module will give this error:
	:{{error\|Lua error in Module:ArgRest at line 8: <nowiki> tags missing from first parameter.}}		:{{error\|Lua error in Module:ArgRest at line 8: <nowiki> tags missing from first parameter.}}
	=== Example ===		=== Example ===
Line 28:		Line 28:
	=== Note ===		=== Note ===
	Be wary when using ArgRest wrapped inside of an outer template; it hasn't quite been thoroughly tested in such scenarios, and should be watched carefully when it is used this way.		Be wary when using ArgRest wrapped inside of an outer template; it hasn't quite been thoroughly tested in such scenarios, and should be watched carefully when it is used this way.

	== Limitations ==		== Limitations ==
	This module currently suffers from a few limitations:		This module currently suffers from a few limitations:

Uzume: "infinite"->"arbitrary"; no computational device or programming language can actually support infinite anything

2025-05-11T11:42:39Z

"infinite"->"arbitrary"; no computational device or programming language can actually support infinite anything

← Previous revision		Revision as of 11:42, 11 May 2025
Line 1:		Line 1:
	{{Module rating\|alpha}}		{{Module rating\|alpha}}
	<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->		<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
	This is an auxiliary module intended to be invoked by templates; it permits templates to support an ~~infinite~~ ~~number~~ of parameters by repeating a block of wikitext multiple times. This module works with named as well as unnamed parameters, can handle multiple named parameters at the same time, and supports defaults,		This is an auxiliary module intended to be invoked by templates; it permits templates to support an arbitrary set of parameters by repeating a block of wikitext multiple times. This module works with named as well as unnamed parameters, can handle multiple named parameters at the same time, and supports defaults,

	== Usage ==		== Usage ==
	If you want to use this module in your template: take the block of wikitext that you want to be repeated for ~~infinite~~ parameters, wrap it in <code class="cm-mw-htmltag-name"><nowiki></code>, and pass that as the module's first parameter; then, choose a "base" parameter such that the module will stop repeating the wikitext if the parameter wasn't defined by the user, and pass its name as the second parameter. Example usage:		If you want to use this module in your template: take the block of wikitext that you want to be repeated for an arbitrary set of parameters, wrap it in <code class="cm-mw-htmltag-name"><nowiki></code>, and pass that as the module's first parameter; then, choose a "base" parameter such that the module will stop repeating the wikitext if the parameter wasn't defined by the user, and pass its name as the second parameter. Example usage:
	:<code>...<nowiki>{{</nowiki>#invoke:ArgRest\|''main''<nowiki>\|<nowiki>...{{{named-2-a}}}...{{{named-2-b\|default}}}...</nowiki>\|named-2-a}}</nowiki></code>		:<code>...<nowiki>{{</nowiki>#invoke:ArgRest\|''main''<nowiki>\|<nowiki>...{{{named-2-a}}}...{{{named-2-b\|default}}}...</nowiki>\|named-2-a}}</nowiki></code>

BrandonXLF: /* Helpful templates */ Use {{tl}}

2024-09-02T21:54:45Z

Helpful templates: Use {{tl}}

← Previous revision		Revision as of 21:54, 2 September 2024
Line 20:		Line 20:
	=== Helpful templates ===		=== Helpful templates ===
	There are a few templates that can used with this module to help it adapt to certain scenarios:		There are a few templates that can used with this module to help it adapt to certain scenarios:
	* ~~[[Template:~~Call wikitext]]: This template allows ArgRest to be demoed without the need to create a template.		* {{tl\|Call wikitext}}: This template allows ArgRest to be demoed without the need to create a template.
	** For example, <code><nowiki>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}&lt;/nowiki>\|1}}</nowiki>\|foo\|bar}}</nowiki></code> outputs <code>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki>\|1}}</nowiki>\|foo\|bar}}</code>.		** For example, <code><nowiki>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}&lt;/nowiki>\|1}}</nowiki>\|foo\|bar}}</nowiki></code> outputs <code>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki>\|1}}</nowiki>\|foo\|bar}}</code>.
	* ~~[[Template:~~Expand wikitext]]: If you try to use ArgRest to generate parameters inside of an outer template (e.g. <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}&lt;/nowiki>\|1}}}}</nowiki></code>), it will fail to do so because the outer template won't get processed after ArgRest is done parsing. This template fixes this by invoking the parser to process the outer template.		* {{tl\|Expand wikitext}}: If you try to use ArgRest to generate parameters inside of an outer template (e.g. <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}&lt;/nowiki>\|1}}}}</nowiki></code>), it will fail to do so because the outer template won't get processed after ArgRest is done parsing. This template fixes this by invoking the parser to process the outer template.
	** For example, a template defined as <code><nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki></code> called with the arguments <code><nowiki>{{__TEMPLATE__\|foo\|bar\|Baz}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki>\|foo\|bar\|baz}}</code> where as one defined as <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki>\|foo\|bar\|baz}}</code>.		** For example, a template defined as <code><nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki></code> called with the arguments <code><nowiki>{{__TEMPLATE__\|foo\|bar\|Baz}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki>\|foo\|bar\|baz}}</code> where as one defined as <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki>\|foo\|bar\|baz}}</code>.
	** <strong>WARNING:</strong> ArgRest may become highly unstable if you use it this way, and is rather likely to not work as expected in these scenarios. If you do use it like this, heavy caution should be taken.		** <strong>WARNING:</strong> ArgRest may become highly unstable if you use it this way, and is rather likely to not work as expected in these scenarios. If you do use it like this, heavy caution should be taken.

BrandonXLF: /* Partner templates */ Add examples and use established templates

2024-09-02T21:54:00Z

Partner templates: Add examples and use established templates

← Previous revision		Revision as of 21:54, 2 September 2024
Line 18:		Line 18:
	:{{tlc\|PlusMinusLoop\|plus1{{{=}}}0\|minus1{{{=}}}1\|plus2{{{=}}}1\|minus2{{{=}}}2\|plus3{{{=}}}3\|plus5{{{=}}}21}}		:{{tlc\|PlusMinusLoop\|plus1{{{=}}}0\|minus1{{{=}}}1\|plus2{{{=}}}1\|minus2{{{=}}}2\|plus3{{{=}}}3\|plus5{{{=}}}21}}
	will yield <code>0 - 1 + 1 - 2 + 3 - 5</code>. The <code>- 5</code> is present because <code>\|minus3</code> defaulted to 5, but <code>21</code> never appears because, although <code>\|plus5</code> is defined, <code>\|plus4</code> isn't, so the module halts there.		will yield <code>0 - 1 + 1 - 2 + 3 - 5</code>. The <code>- 5</code> is present because <code>\|minus3</code> defaulted to 5, but <code>21</code> never appears because, although <code>\|plus5</code> is defined, <code>\|plus4</code> isn't, so the module halts there.
	=== ~~Partner~~ templates ===		=== Helpful templates ===
	There are a few templates that can used with this module to help it in certain scenarios:		There are a few templates that can used with this module to help it adapt to certain scenarios:
	* [[Template:Call wikitext]] - This template allows ArgRest to be demoed without the need to create a template. ~~For example:~~		* [[Template:Call wikitext]]: This template allows ArgRest to be demoed without the need to create a template.
	{{~~nowiki~~ ~~template demo~~\|~~format~~=~~inline\|~~<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1}}</nowiki>\|~~Foo~~\|~~Bar~~}} → {{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1}}</nowiki>}}		** For example, <code><nowiki>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}&lt;/nowiki>\|1}}</nowiki>\|foo\|bar}}</nowiki></code> outputs <code>{{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki>\|1}}</nowiki>\|foo\|bar}}</code>.
		⚫	* [[Template:Expand wikitext]]: If you try to use ArgRest to generate parameters inside of an outer template (e.g. <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}&lt;/nowiki>\|1}}}}</nowiki></code>), it will fail to do so because the outer template won't get processed after ArgRest is done parsing. This template fixes this by invoking the parser to process the outer template.

			** For example, a template defined as <code><nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki></code> called with the arguments <code><nowiki>{{__TEMPLATE__\|foo\|bar\|Baz}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{Expand wikitext\|{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}}}</nowiki>\|foo\|bar\|baz}}</code> where as one defined as <code><nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki></code> would output <code>{{Call wikitext\|sourceCode=<nowiki>{{enum{{#invoke:ArgRest\|main\|<nowiki>\|{{{1}}}</nowiki>\|1}}}}</nowiki>\|foo\|bar\|baz}}</code>.
	This module has a few submodules that serve as "partners" for the module, to help it in certain scenarios:
	*[[Module:ArgRest/testCaser]]: This submodule allows ArgRest to be used without needing to be inside of a template.
⚫	*[[~~Module~~:~~ArgRest/wrapper~~]]: If you try to use ArgRest to generate parameters inside of an outer template (e.g. <code><nowiki>{{enum{{#invoke:ArgRest\|<nowiki>\|{{{1}}}&lt;/nowiki>\|1}}}}</nowiki></code>), it will ~~normally~~ fail to do so because the outer template won't get processed after ArgRest is done parsing; ~~this~~ ~~submodule~~ ~~can~~ ~~fix~~ ~~that~~ ~~(albeit~~ in a ~~rather~~ ~~scrappy way) by simply processing~~ the outer template ~~one extra time~~.
	** <strong>WARNING:</strong> ArgRest may become highly unstable if you use it this way, and is rather likely to not work as expected in these scenarios. If you do use it like this, heavy caution should be taken.		** <strong>WARNING:</strong> ArgRest may become highly unstable if you use it this way, and is rather likely to not work as expected in these scenarios. If you do use it like this, heavy caution should be taken.

BrandonXLF: /* Partner templates */

2024-09-02T21:42:22Z

Partner templates

← Previous revision		Revision as of 21:42, 2 September 2024
Line 21:		Line 21:
	There are a few templates that can used with this module to help it in certain scenarios:		There are a few templates that can used with this module to help it in certain scenarios:
	* [[Template:Call wikitext]] - This template allows ArgRest to be demoed without the need to create a template. For example:		* [[Template:Call wikitext]] - This template allows ArgRest to be demoed without the need to create a template. For example:
	{{nowiki template demo\|format=inline\|<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1>}}</nowiki>\|Foo\|Bar}}		{{nowiki template demo\|format=inline\|<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1}}</nowiki>\|Foo\|Bar}} → {{Call wikitext\|sourceCode=<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1}}</nowiki>}}

	This module has a few submodules that serve as "partners" for the module, to help it in certain scenarios:		This module has a few submodules that serve as "partners" for the module, to help it in certain scenarios:

BrandonXLF: /* Partner modules */

2024-09-02T21:40:39Z

Partner modules

← Previous revision		Revision as of 21:40, 2 September 2024
Line 18:		Line 18:
	:{{tlc\|PlusMinusLoop\|plus1{{{=}}}0\|minus1{{{=}}}1\|plus2{{{=}}}1\|minus2{{{=}}}2\|plus3{{{=}}}3\|plus5{{{=}}}21}}		:{{tlc\|PlusMinusLoop\|plus1{{{=}}}0\|minus1{{{=}}}1\|plus2{{{=}}}1\|minus2{{{=}}}2\|plus3{{{=}}}3\|plus5{{{=}}}21}}
	will yield <code>0 - 1 + 1 - 2 + 3 - 5</code>. The <code>- 5</code> is present because <code>\|minus3</code> defaulted to 5, but <code>21</code> never appears because, although <code>\|plus5</code> is defined, <code>\|plus4</code> isn't, so the module halts there.		will yield <code>0 - 1 + 1 - 2 + 3 - 5</code>. The <code>- 5</code> is present because <code>\|minus3</code> defaulted to 5, but <code>21</code> never appears because, although <code>\|plus5</code> is defined, <code>\|plus4</code> isn't, so the module halts there.
	=== Partner ~~modules~~ ===		=== Partner templates ===
			There are a few templates that can used with this module to help it in certain scenarios:
			* [[Template:Call wikitext]] - This template allows ArgRest to be demoed without the need to create a template. For example:
			{{nowiki template demo\|format=inline\|<nowiki>{{#invoke:ArgRest\|main\|<nowiki>{{{1}}}</nowiki\|1>}}</nowiki>\|Foo\|Bar}}

	This module has a few submodules that serve as "partners" for the module, to help it in certain scenarios:		This module has a few submodules that serve as "partners" for the module, to help it in certain scenarios:
	*[[Module:ArgRest/testCaser]]: This submodule allows ArgRest to be used without needing to be inside of a template.		*[[Module:ArgRest/testCaser]]: This submodule allows ArgRest to be used without needing to be inside of a template.

BrandonXLF: Add Category:Template metamodules

2024-09-01T22:37:45Z

Add Category:Template metamodules

← Previous revision		Revision as of 22:37, 1 September 2024
Line 39:		Line 39:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->
	[[Category:~~Wikipedia~~ ~~utility modules~~]]		[[Category:Template metamodules]]
	[[Category:Wikipedia metatemplates]]
	}}</includeonly>		}}</includeonly>
	<noinclude>		<noinclude>

BrandonXLF: /* See also */ Add Category:Wikipedia metatemplates

2024-09-01T07:00:32Z

See also: Add Category:Wikipedia metatemplates

← Previous revision		Revision as of 07:00, 1 September 2024
Line 40:		Line 40:
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->
	[[Category:Wikipedia utility modules]]		[[Category:Wikipedia utility modules]]
			[[Category:Wikipedia metatemplates]]
	}}</includeonly>		}}</includeonly>
	<noinclude>		<noinclude>

BrandonXLF: /* See also */ Add Category:Wikipedia utility modules

2024-09-01T06:58:58Z

← Previous revision		Revision as of 06:58, 1 September 2024
Line 39:		Line 39:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	<!-- Categories below this line; interwikis at Wikidata -->		<!-- Categories below this line; interwikis at Wikidata -->
			[[Category:Wikipedia utility modules]]

	}}</includeonly>		}}</includeonly>
	<noinclude>		<noinclude>

BrandonXLF: /* See also */

2024-09-01T06:58:10Z

← Previous revision		Revision as of 06:58, 1 September 2024
Line 34:		Line 34:
	== See also ==		== See also ==
	* {{mfl\|params\|with_name_matching}}, {{mfl\|params\|for_each}}		* {{mfl\|params\|with_name_matching}}, {{mfl\|params\|for_each}}
	* {{mfl\|for nowiki\|~~main~~}}		* {{mfl\|for nowiki\|template}}
	* {{tl\|for nowiki}}		* {{tl\|for nowiki}}