Module:Arguments/doc - Revision history

Lusi: 100 revisions imported from :wikipedia:Module:Arguments/doc

2026-01-23T21:35:41Z

100 revisions imported from wikipedia:Module:Arguments/doc

← Older revision	Revision as of 21:35, 23 January 2026
(No difference)

wikipedia>Hooman Mallahzadeh at 12:22, 21 November 2025

2025-11-21T12:22:17Z

← Older revision		Revision as of 12:22, 21 November 2025
Line 4:		Line 4:

	This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:		This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:
	* Easy trimming of arguments and removal of blank arguments.		* Easy [[Trimming (computer programming)\|trimming]] of arguments and removal of blank arguments.
	* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)		* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)
	* Arguments can be passed in directly from another Lua module or from the debug console.		* Arguments can be passed in directly from another Lua module or from the debug console.

wikipedia>Srapoj: /* Recommended practice */ improve clarity?

2025-07-19T22:08:13Z

Recommended practice: improve clarity?

← Older revision		Revision as of 22:08, 19 July 2025
Line 32:		Line 32:

	=== Recommended practice ===		=== Recommended practice ===
	However, the recommended practice is to use a function just for processing arguments ~~from #invoke~~. This ~~means that if someone calls your module from another~~ Lua ~~module you don't have~~ to ~~have a~~ frame object ~~available, which improves performance~~.		However, the recommended practice is to use a separate function as the entry point from <code>#invoke</code> just for processing the arguments. This allows other Lua modules to call your core logic directly, improving performance by avoiding the overhead of interacting with the <code>frame</code> object.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

wikipedia>GKNishimoto at 22:01, 9 May 2025

2025-05-09T22:01:23Z

← Older revision		Revision as of 22:01, 9 May 2025
Line 3:		Line 3:
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}

	This module provides easy processing of arguments passed from <code>#invoke</code>.~~hhhhhuh~~ It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:		This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:
	* Easy trimming of arguments and removal of blank arguments.		* Easy trimming of arguments and removal of blank arguments.
	* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)		* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)
Line 482:		Line 482:
	=== Known limitations ===		=== Known limitations ===

	The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own ~~argumuhueutyyunt~~ processing function instead of this		The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own argument processing function instead of this module.<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>

2804:389:F2A8:C429:B0DA:BBFF:FE73:B260: /* Known limitations */

2025-05-09T20:09:41Z

Known limitations

← Older revision		Revision as of 20:09, 9 May 2025
Line 482:		Line 482:
	=== Known limitations ===		=== Known limitations ===

	The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own ~~argument~~ processing function instead of this ~~module.<includeonly>{{#ifeq:{{SUBPAGENAME}}\|sandbox\|\|~~		The use of metatables also has its downsides. Most of the normal Lua table tools won't work properly on the args table, including the <code>#</code> operator, the <code>next()</code> function, and the functions in the table library. If using these is important for your module, you should use your own argumuhueutyyunt processing function instead of this
	[[Category:Lua metamodules]]		[[Category:Lua metamodules]]
	}}</includeonly>		}}</includeonly>

2804:389:F2A8:C429:B0DA:BBFF:FE73:B260 at 20:08, 9 May 2025

2025-05-09T20:08:55Z

← Older revision		Revision as of 20:08, 9 May 2025
Line 3:		Line 3:
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}

	This module provides easy processing of arguments passed from <code>#invoke</code>. It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:		This module provides easy processing of arguments passed from <code>#invoke</code>.hhhhhuh It is a meta-module, meant for use by other modules, and should not be called from <code>#invoke</code> directly (for a module directly invocable by templates you might want to have a look at {{ml\|params\|}}). Its features include:
	* Easy trimming of arguments and removal of blank arguments.		* Easy trimming of arguments and removal of blank arguments.
	* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)		* Arguments can be passed by both the current frame and by the parent frame at the same time. (More details below.)

wikipedia>John of Reading: Reverted 1 edit by 41.90.172.255 (talk): Rv scribble

2025-01-26T17:52:58Z

Reverted 1 edit by 41.90.172.255 (talk): Rv scribble

← Older revision		Revision as of 17:52, 26 January 2025
Line 1:		Line 1:
	~~{{angle bracket\|}}~~{{Used in system}}		{{Used in system}}
	{{Module rating\|p}}		{{Module rating\|p}}
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}
Line 12:		Line 12:

	First, you need to load the module. It contains one function, named <code>getArgs</code>.		First, you need to load the module. It contains one function, named <code>getArgs</code>.
	~~d₩™◌₳₨₨ḌḍMĖIصŋŋŋɛərɛər~~
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local getArgs = require('Module:Arguments').getArgs		local getArgs = require('Module:Arguments').getArgs

41.90.172.255 at 17:04, 26 January 2025

2025-01-26T17:04:58Z

← Older revision		Revision as of 17:04, 26 January 2025
Line 1:		Line 1:
	{{Used in system}}		{{angle bracket\|}}{{Used in system}}
	{{Module rating\|p}}		{{Module rating\|p}}
	{{cascade-protected template\|page=module}}		{{cascade-protected template\|page=module}}
Line 12:		Line 12:

	First, you need to load the module. It contains one function, named <code>getArgs</code>.		First, you need to load the module. It contains one function, named <code>getArgs</code>.
			d₩™◌₳₨₨ḌḍMĖIصŋŋŋɛərɛər
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local getArgs = require('Module:Arguments').getArgs		local getArgs = require('Module:Arguments').getArgs

wikipedia>Explorer09: /* Options */ Italicize "firstInvokeArg" in the examples. This help identifying the frame source of the arguments easier.

2024-11-18T09:54:47Z

Options: Italicize "firstInvokeArg" in the examples. This help identifying the frame source of the arguments easier.

← Older revision		Revision as of 09:54, 18 November 2024
Line 241:		Line 241:
	{{cob}}		{{cob}}

	~~<code>Module:ExampleArgs</code> is then called by~~ <code>Template:ExampleArgs</code>~~, which~~ contains the code <code><nowiki>{{#invoke:ExampleArgs\|main\|firstInvokeArg}}</nowiki></code>~~. This produces the result "firstInvokeArg"~~.		<code>Template:ExampleArgs</code> contains the code <code><nowiki>{{#invoke:ExampleArgs\|main\|''firstInvokeArg''}}</nowiki></code>.

	Now if we were to call <code>Template:ExampleArgs</code>, the following would happen:		Now if we were to call <code>Template:ExampleArgs</code>, the following would happen:
Line 249:		Line 249:
	! style="width: 60%;" \| Code		! style="width: 60%;" \| Code
	! style="width: 40%;" \| Result		! style="width: 40%;" \| Result
			\|-
			\| <pre>{{#invoke:ExampleArgs\|main\|''firstInvokeArg''}}

			(call #invoke directly without template)</pre>
			\| ''firstInvokeArg''

			(call #invoke directly without template)
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>
	\| firstInvokeArg secondTemplateArg		\| ''firstInvokeArg'' secondTemplateArg
	\|}		\|}

Line 269:		Line 276:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|}		\|}

Line 301:		Line 308:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
Line 372:		Line 379:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>
	\| firstInvokeArg secondTemplateArg		\| ''firstInvokeArg'' secondTemplateArg
	\|}		\|}

Line 388:		Line 395:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
Line 407:		Line 414:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|}		\|}

Line 423:		Line 430:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg\|secondTemplateArg}}</nowiki></code>
	\| firstInvokeArg secondTemplateArg		\| ''firstInvokeArg'' secondTemplateArg
	\|}		\|}

Line 439:		Line 446:
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs}}</nowiki></code>
	\| firstInvokeArg		\| ''firstInvokeArg''
	\|-		\|-
	\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>		\| <code><nowiki>{{ExampleArgs\|firstTemplateArg}}</nowiki></code>

wikipedia>Explorer09: /* Wrappers */ Behaviors of frameOnly and parentOnly in relations with wrapper templates. (This documentation is not good enough; can be improved later.)

2024-11-18T09:33:18Z

Wrappers: Behaviors of frameOnly and parentOnly in relations with wrapper templates. (This documentation is not good enough; can be improved later.)

@@ Line 338: / Line 338: @@
 })
 </syntaxhighlight>
 Notes:
 # The module will automatically detect if it is being called from a wrapper template's /sandbox subpage, so there is no need to specify sandbox pages explicitly.
 # If the ''wrappers'' option is set and no parent frame is available, the module will always get the arguments from the frame passed to <code>getArgs</code>.