View source for Module talk:Template wrapper

==using positional parameters==
This module was initially written so that positional parameters in the wrapper template are not passed on to the working template.  That's fine for templates like the cs1|2 templates because they do not use positional parameters but is problematic for templates like {{tlx|ERIC}} which wraps {{tlx|Catalog_lookup_link}}.

So I've invented a new parameter for [[Module:template wrapper]]: {{para|_pass-all}} which when set to <code>yes</code> in the module <code><nowiki>{{#invoke:}}</nowiki></code> causes the module to pass all wrapper-template parameters except those listed in {{para|_exclude}} to the working template.  Here is {{tlx|ERIC/sandbox}} which uses [[Module:template wrapper/sandbox]] with {{para|_pass-all|yes}} to wrap {{tlx|Catalog_lookup_link/sandbox}} which invokes [[Module:Catalog_lookup_link/sandbox]]:
:<code><nowiki>{{ERIC/sandbox|ED046562|EJ671671|url-access=free}}</nowiki></code>
::{{ERIC/sandbox|ED046562|EJ671671|url-access=free}}
Here is {{tlx|EFloras/sandbox2}} which uses [[Module:template wrapper/sandbox]] without {{para|_pass-all}} to wrap {{tlx|cite web}} which invokes [[Module:Citation/CS1]].  Positional parameters are used by {{tld|EFloras}} and not passed to {{tld|cite web}}:
:<code><nowiki>{{EFloras/sandbox2|1|233501007|Quercus alba |volume=3 |first=Kevin C. |last=Nixon | access-date = 18 August 2018 }}</nowiki></code> 
::{{EFloras/sandbox2|1|233501007|Quercus alba |volume=3 |first=Kevin C. |last=Nixon | access-date = 18 August 2018 }}
Compare the live {{tlx|Efloras}}:
:<code><nowiki>{{EFloras|1|233501007|Quercus alba |volume=3 |first=Kevin C. |last=Nixon | access-date = 18 August 2018 }}</nowiki></code> 
::{{EFloras|1|233501007|Quercus alba |volume=3 |first=Kevin C. |last=Nixon | access-date = 18 August 2018 }}
What have I missed?

—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 11:29, 19 August 2018 (UTC)
: Unless I'm misunderstanding something, the below looks like it will add all the positional {{code|pframe_args}} regardless of {{para|_exclude}} or {{code|unset}}. <syntaxhighlight lang=lua>	if pass_all then
		for i, v in ipairs (pframe_args) do
			add_parameter (i, v, args, list);
		end
	end</syntaxhighlight> I think the below would do what you intend. <syntaxhighlight lang=lua>local function pframe_args_get (pframe_args, args, exclude, pass_all, list)
	for k, v in pairs (pframe_args) do
		if (pass_all or type (k) ~= 'number') and not is_in_table (exclude, k) then	-- do not pass along excluded parameters
			if v and ('' ~= v) then													-- pass along only those parameters that have assigned values
				if 'unset' == v:lower() then										-- special keyword to unset 'default' parameters set in the wrapper template
					v = '';															-- unset the value in the args table
				end
				add_parameter (k, v, args, list)									-- add all other parameters to args in the style dictated by list
			end
		end
	end
end</syntaxhighlight> It might make more sense to use {{para|_pass_positional}} instead of {{para|_pass-all}} since {{para|_exclude}} still applies. {{code|frame_args_get}} should also be adjusted so that the new parameter isn't passed. —&thinsp;[[User:JJMC89|JJMC89]]&thinsp;<small>([[User talk:JJMC89|T]]'''·'''[[Special:Contributions/JJMC89|C]])</small> 18:11, 19 August 2018 (UTC)
::I did not intend that positional parameters should be excludable.  Perhaps they could be but how is that properly handled?  If we pass <code><nowiki>{{{1}}}</nowiki></code> and exclude <code><nowiki>{{{2}}}</nowiki></code> what do we do with <code><nowiki>{{{3}}}</nowiki></code> et seq.?  Does <code><nowiki>{{{3}}}</nowiki></code> become the new <code><nowiki>{{{2}}}</nowiki></code>?  I just didn't want to venture along that cow track until there is a demonstrated need to go there.
:
::I didn't consider the possibility of a positional parameter having the <code>unset</code> value.  I'll fix that.
:
::Using <code>ipairs()</code> as I did ensures that empty positional parameters are passed along to the working template.  In the <code>pairs()</code> version, the <code><nowiki>if v and ('' ~= v) then</nowiki></code> prevents empty positional parameters from being added to the <code>args</code> table.
:
::I overlooked adding {{para|_pass-all}} to <code>frame_args_get()</code>; I'll do that.  As you can see I was not very successful in finding a good parameter name.  {{para|_pass-all}} is the shortest I could come up with and was, I felt, marginally better than {{para|_pass-positional}} which I felt implied 'only' but was shorter than {{para|_include-positional}} which was the best in terms of describing what it does at the expense of length;  I was hoping for a single word but was unable to find one that is suitable.  I'll change to {{para|_include-positional}}.
::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 21:29, 19 August 2018 (UTC)
::: I misunderstood your comment in the module then. Let's not let positional parameters be excluded with {{para|_include-positional}}; I agree it would be difficult to properly handle. I made [[Special:Diff/855651041|this edit]]. I think the sandbox looks good now. —&thinsp;[[User:JJMC89|JJMC89]]&thinsp;<small>([[User talk:JJMC89|T]]'''·'''[[Special:Contributions/JJMC89|C]])</small> 21:53, 19 August 2018 (UTC)
::::Yeah, we edit conflicted over that.  I've updated the live module.
::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 22:36, 19 August 2018 (UTC)
:::::{{reply to|Trappist the monk}} Potentially a dumb question, but is there a way to pass all but one positional parameter? I tried a bunch of ways to exclude positional parameter "1" in [[Template:Multiref2/sandbox]] before reading this discussion. If there's not a clean solution, I'll leave it as is. [[User:Rjjiii|Rjjiii]] ([[User talk:Rjjiii|talk]]) 02:39, 12 July 2023 (UTC)
::::::I don't think so.  But why would you want to?  Positional parameters have meaning so suppressing <code><nowiki>{{{1}}}</nowiki></code> in the call to the working template 'bumps' the subsequent positional parameters: wrapper template <code><nowiki>{{{2}}}</nowiki></code> becomes working template <code><nowiki>{{{1}}}</nowiki></code> and so on.  For {{tlx|multiref2}} that doesn't much matter but for other templates it can make a hash of things.
::::::
::::::I think that you will need to make a very strong case for a modification to this module.
::::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 13:07, 12 July 2023 (UTC)
:::::::Gotcha, I'm not asking for a modification, just making sure that I understand how the module works. [[User:Rjjiii|Rjjiii]] ([[User talk:Rjjiii|talk]]) 19:20, 12 July 2023 (UTC)
:::::::An additional follow-up: On second thought, it made more sense to style the first positional reference rather than filter it out. Disregard my confusion above. [[User:Rjjiii|Rjjiii]] ([[User talk:Rjjiii|talk]]) 06:48, 16 July 2023 (UTC)

== support for aliasing and parameter name reuse; ==

I have added code so that the wrapper templates can support parameter aliasing and same-name reuse.  Also updated the documentation.  Existing applications should not notice the change.  But, famous last words, those, report anomalies here.

—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 13:46, 17 November 2018 (UTC)

== _substall  ==

@[[User:Pppery|Pppery]]: If you are going to make changes to this module, please document those changes both in the code and in the doc page.

Please explain this:
:<syntaxhighlight lang="lua">if mw.isSubsting() and frame.args._substall == "no" then
	return require("Module:Template invocation").invocation(template, args)
else
	return frame:expandTemplate {title=template, args=args};				-- render the working template
end</syntaxhighlight>
How is the one different from the other?

—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 19:09, 19 February 2019 (UTC)
: One of those actually transcludes the template, whereas the other one returns a wikitext version of the template. The purpose of that edit was, as I explained in the edit summary, to make this module easier to use for substituted templates. To demonstrate this, support you have a template {{tl|X1}}, which contains the code <code><nowiki>{{#invoke:Template wrapper|wrap|_template=X2|xxx=yyy|_substall={{{_substall}}}|_exclude=_substall}}</nowiki></code>. If {{para|_substall|no}} is specified, then substing [[Template:X1]] will produce a transclusion of [[Template:X2]], as opposed to a substitution of [[Template:X2]] which is produced without the _substall param. [[User:Pppery|&#123;&#123;3x&#124;p&#125;&#125;ery]] ([[User talk:Pppery|talk]]) 19:14, 19 February 2019 (UTC)
::@[[User:Pppery|Pppery]]: If you are going to make changes to this module, please document those changes both in the code and in the doc page.
::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 15:59, 22 February 2019 (UTC)
::A substitute option would indeed be really useful. I see your edit summary when you reverted. Are these problems surmountable? &mdash;&nbsp;Martin <small>([[User:MSGJ|MSGJ]]&nbsp;·&nbsp;[[User talk:MSGJ|talk]])</small> 12:32, 8 February 2024 (UTC)

== Reusing positional parameters ==

Why doesn't [[Template:IPA double slash/sandbox|this]] work?

Code:
<syntaxhighlight lang="mediawiki">{{#invoke:Template wrapper|wrap|_template=IPA|_reuse=1|_include-positional=yes|1=⫽{{{1}}}⫽}}</syntaxhighlight>

{{Automarkup|{{IPA double slash/sandbox{{!}}r}}}}

[[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 18:00, 29 December 2024 (UTC)
:Positional parameters in the invoke are ignored.  In this particular example, there are two <syntaxhighlight lang="wikitext" inline="1">{{{1}}}</syntaxhighlight> positional parameters:
:#<syntaxhighlight lang="wikitext" inline="1">{{IPA double slash/sandbox|r}}</syntaxhighlight> – <code>r</code> is <syntaxhighlight lang="wikitext" inline="1">{{{1}}}</syntaxhighlight>
:#<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Template wrapper|wrap|_template=IPA|_reuse=1|_include-positional=yes|1=⫽{{{1}}}⫽}}</syntaxhighlight> – {{para|1}} is also <syntaxhighlight lang="wikitext" inline="1">{{{1}}}</syntaxhighlight>
:Attempting to figure out what an editor wanted when supplying two positional parameters using the same index is not possible with a simple script.
:—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 19:50, 29 December 2024 (UTC)
::So what can I do to make the template output essentially the same thing as <syntaxhighlight lang="mediawiki">{{IPA|⫽{{{1}}}⫽}}</syntaxhighlight> except all other arguments are passed on to {{tl|IPA}}? I thought that was the whole point of <code>_reuse</code>. [[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 22:18, 29 December 2024 (UTC)
:::I confess that I don't understand what is wrong with the current implementation of {{tlx|IPA double slash}}.  Does it not do what you want it to do?
:::
:::Because {{tld|IPA double slash}} invokes [[Module:IPA]] via {{tlx|IPA}}, have you considered adding an exported function to that module that would do what you want and therefore skip the IPA template altogether?
:::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 23:30, 29 December 2024 (UTC)
::::Forget {{tl|IPA double slash}} exists for a moment. My question stands. [[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 23:33, 29 December 2024 (UTC)
:::::Did you try creating a named alias for {{tlx|IPA}} parameter <syntaxhighlight lang="wikitext" inline="1">{{{1}}}</syntaxhighlight>?  Sommat like:
:::::#<syntaxhighlight lang="wikitext" inline="1">{{IPA double slash/sandbox|text=r}}</syntaxhighlight>
:::::#<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Template wrapper|wrap|_template=IPA|_reuse=text|text=⫽{{{text}}}⫽}}</syntaxhighlight>
:::::Insert at [[Module:IPA#L-269|line 269]] sommat like this:
::::::<syntaxhighlight lang="lua" inline="1">args[1] = args[1] or args.text;</syntaxhighlight>
:::::In my sandbox I wrote #1 above and then tweaked {{tlx|IPA double slash/sandbox}} as described in #2 above except that I switched <code>wrap</code> to <code>list</code>.  When I previewed my sandbox with the tweaked template sandbox, [[Module:Template wrapper]] gave me:
::::::<syntaxhighlight lang="wikitext" inline="1">{{IPA|text=⫽r⫽}}</syntaxhighlight>
:::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 00:40, 30 December 2024 (UTC)
:::::
:::::A little refinement:
:::::#<syntaxhighlight lang="wikitext" inline="1">{{IPA double slash/sandbox|text=r|lang=es}}</syntaxhighlight>
:::::#<syntaxhighlight lang="wikitext" inline="1">{{IPA double slash/sandbox|r|lang=es}}</syntaxhighlight>
:::::#<syntaxhighlight lang="wikitext" inline="1">{{#invoke:Template wrapper|list|_template=IPA|_reuse=text|text=⫽{{{text|{{{1|}}}}}}⫽}}</syntaxhighlight>
:::::the above gave me:
:::::#<syntaxhighlight lang="wikitext" inline="1">{{IPA|lang=es|text=⫽r⫽}}</syntaxhighlight>
:::::#<syntaxhighlight lang="wikitext" inline="1">{{IPA|lang=es|text=⫽r⫽}}</syntaxhighlight>
:::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 01:28, 30 December 2024 (UTC)
::::::Again, you're not answering my question. Pretend {{tl|IPA}} was interface-protected and no interface admin was around. Now what do I do? [[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 01:03, 30 December 2024 (UTC)
:::::::I'm not going to play your game; heaping constraint upon constraint feels too much like hostility that I neither need nor want in my life.  You asked:
::::::::{{tq|1=what can I do to make the template output essentially the same thing as <syntaxhighlight lang="mediawiki" inline="1">{{IPA|⫽{{{1}}}⫽}}</syntaxhighlight> except all other arguments are passed on to {{tl|IPA}}?}}
:::::::my previous two posts answered that question.
:::::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 01:28, 30 December 2024 (UTC)
::::::::That was just an example. My inquiry has been a general one about this module and {{para|_reuse}}. Of course anything is possible if you just modify the template being transcluded; that's clearly not what I'm asking, or I wouldn't post it here. So does the module not support what is described in [[Module:Template wrapper#reuse|the doc]] but for a positional parameter? Shouldn't it? [[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 01:52, 30 December 2024 (UTC)
:::::::::I suck at documentation; it is known.  Documentation updated to note that {{para|_reuse}} is not supported for positional parameters.
:::::::::—[[User:Trappist the monk|Trappist the monk]] ([[User talk:Trappist the monk|talk]]) 15:35, 30 December 2024 (UTC)
::::::::::Is it simply not implemented into the module or due to a limitation in Scribunto? [[User:Nardog|Nardog]] ([[User talk:Nardog|talk]]) 07:16, 31 December 2024 (UTC)