Template:$/doc - Revision history

Alex at 10:24, 17 October 2024

2024-10-17T10:24:13Z

← Older revision		Revision as of 12:24, 17 October 2024
Line 1:		Line 1:
	{{Documentation}}		{{Documentation}}

			This template converts all provided template params and template values into key/value pairs, which it then passes through as a single json-style string:
	The '''*''' template is used to add bullets (example: '''•''') by substituting <tt><nowiki>'''&bull;'''</nowiki></tt> automatically.

			<pre>{{$\|param1=value\|foo=bar\|example=great}}</pre>
	==Usage==
			{{$\|param1=value\|foo=bar\|example=great}}
	The recommended usage is to use spaces ''before'' and ''after'' the template.
	<pre>[[Bones]] {{*}} [[Big bones]]</pre>

			==Example==
	The template renders one space on each side of the bullet.
			As an example, imagine a "Template:BigTable" which calls an associated "Module:BigTable":
	[[Bones]] {{*}} [[Big bones]]

			<syntaxhighlight>
	For long dotted lists each list item can be put on its own line, with spaces between each item and the template.
			{{BigTable
			\|{{$\|metal1=bronze\|metal2=iron\|metal3=steel}}
			\|{{$\|metal1=mithril\|metal2=adamant\|metal3=rune}}
		⚫	}}
			</syntaxhighlight>

			Template:$ serializes the information inside of it into a string of key/value pairs, effectively converting the information to this style as it passes through into Template:BigTable:
	<pre>
	[[Bones]] {{*}}
	[[Bat bones]] {{*}}
	[[Wolf bones]] {{*}}
	[[Big bones]] {{*}}
	[[Dragon bones]]
	</pre>

			<syntaxhighlight>
	As before, the template renders one space on each side of the bullets.
			{{BigTable
	[[Bones]] {{*}}
			\|{"metal1":"bronze","metal2":"iron","metal3":"steel"}
	[[Bat bones]] {{*}}
			\|{"metal1":"mithril","metal2":"adamant","metal3":"rune"}
	[[Wolf bones]] {{*}}
		⚫	}}
	[[Big bones]] {{*}}
			</syntaxhighlight>
	[[Dragon bones]]

			To access the information in the json params, the module uses the <code>deserialize</code> command from [[Module:$]] on the parameters. This converts the json strings into json objects with standard key/value pairs. The <code>deserialize</code> command leaves normal template params unchanged:
	When the list is too long and line breaks, the class "nowraplinks" should be used.

			<syntaxhighlight lang="lua">
	<pre style="width:95%; overflow:scroll"><div class="nowraplinks">
			local ds = require('Module:$').deserialize
	[[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]] {{}} [[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]] {{}} [[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]]
			local p = {}
	</div></pre>

			function p._main(args)
	Using "nowraplinks" forces the line break to come after one of the bullets.
			local secondmetalfromfirstparam = args[1]['metal2']
			local thirdmetalfromsecondparam = args[2]['metal3']
			end

			function p.main(frame)
	<div class="nowraplinks">
			local args = ds(frame:getParent().args)
	[[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]] {{}} [[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]] {{}} [[Bones]] {{}} [[Bat bones]] {{}} [[Wolf bones]] {{}} [[Big bones]] {{}} [[Dragon bones]]
			return p._main(args)
	</div>
			end

			return p
	<includeonly>[[Category:Formatting templates\|{{PAGENAME}}]]</includeonly>
			</syntaxhighlight>

	{{TemplateData\|<templatedata>
	{
	"params": {},
	"description": "The * template is used to add bullets (example: •) by substituting '''•''' automatically.",
	"format": "inline"
⚫	}
	</templatedata>
⚫	}}

Alex at 23:56, 16 October 2024

2024-10-16T23:56:30Z

@@ Line 1: / Line 1: @@
 {{Documentation}}
-===Example===
+==Usage==
 <includeonly>[[Category:Formatting templates|{{PAGENAME}}]]</includeonly>

Alex at 23:53, 16 October 2024

2024-10-16T23:53:23Z

← Older revision		Revision as of 01:53, 17 October 2024
Line 1:		Line 1:
	{{Documentation}}		{{Documentation}}
			A template link with a variable number of parameters.

			===Use===
	This template converts all provided template params and template values into key/value pairs, which it then passes through as a single json-style string:
			To use this for templates, use
			:{{T\|T\|<nowiki>parameter 1\|parameter 2\|parameter 3\|...\|parameter 20</nowiki>}}<!-- self-referential examples! -->
			To use other namespaces, use the namespace as prefix, for example
			:{{T\|T\|User:Example}}
			And to show transclusions of mainspace mw.pages, use
			:{{T\|T\|:Bucket}}

		⚫	===Example===
	<pre>{{$\|param1=value\|foo=bar\|example=great}}</pre>
			<code><nowiki>{{T\|Stub}}</nowiki></code>
	{{$\|param1=value\|foo=bar\|example=great}}
			:{{T\|Stub}}

			<code><nowiki>{{T\|Stub\|Item1\|Item2\|Item3\|Item4\|Item5\|...}}</nowiki></code>
⚫	==Example==
			:{{T\|Stub\|Item1\|Item2\|Item3\|Item4\|Item5\|...}}
	As an example, imagine a "Template:BigTable" which calls an associated "Module:BigTable":

			<includeonly>[[Category:Formatting templates\|{{PAGENAME}}]]</includeonly>
	<syntaxhighlight>
	{{BigTable
	\|{{$\|metal1=bronze\|metal2=iron\|metal3=steel}}
	\|{{$\|metal1=mithril\|metal2=adamant\|metal3=rune}}
	}}
	</syntaxhighlight>

	Template:$ serializes the information inside of it into a string of key/value pairs, effectively converting the information to this style as it passes through into Template:BigTable:

	<syntaxhighlight>
	{{BigTable
	\|{"metal1":"bronze","metal2":"iron","metal3":"steel"}
	\|{"metal1":"mithril","metal2":"adamant","metal3":"rune"}
	}}
	</syntaxhighlight>

	To access the information in the json params, the module uses the <code>deserialize</code> command from [[Module:$]] on the parameters. This converts the json strings into json objects with standard key/value pairs. The <code>deserialize</code> command leaves normal template params unchanged:

	<syntaxhighlight lang="lua">
	local ds = require('Module:$').deserialize
	local p = {}

	function p._main(args)
	local secondmetalfromfirstparam = args[1]['metal2']
	local thirdmetalfromsecondparam = args[2]['metal3']
	end

	function p.main(frame)
	local args = ds(frame:getParent().args)
	return p._main(args)
	end

	return p
	</syntaxhighlight>

Alex: Created page with "{{Documentation}} This template converts all provided template params and template values into key/value pairs, which it then passes through as a single json-style string:

{{$|param1=value|foo=bar|example=great}}

{{$|param1=value|foo=bar|example=great}} ==Example== As an example, imagine a "Template:BigTable" which calls an associated "Module:BigTable": {{BigTable |{{$|metal1=bronze|metal2=iron|metal3=steel}} |{{$|metal1=mithril|metal2=ad..."

2024-10-16T23:13:26Z

Created page with "{{Documentation}} This template converts all provided template params and template values into key/value pairs, which it then passes through as a single json-style string: <pre>{{$|param1=value|foo=bar|example=great}}</pre> {{$|param1=value|foo=bar|example=great}} ==Example== As an example, imagine a "Template:BigTable" which calls an associated "Module:BigTable": <syntaxhighlight> {{BigTable |{{$|metal1=bronze|metal2=iron|metal3=steel}} |{{$|metal1=mithril|metal2=ad..."

New page

{{Documentation}}

This template converts all provided template params and template values into key/value pairs, which it then passes through as a single json-style string:

<pre>{{$|param1=value|foo=bar|example=great}}</pre>
{{$|param1=value|foo=bar|example=great}}

==Example==
As an example, imagine a "Template:BigTable" which calls an associated "Module:BigTable":

<syntaxhighlight>
{{BigTable
|{{$|metal1=bronze|metal2=iron|metal3=steel}}
|{{$|metal1=mithril|metal2=adamant|metal3=rune}}
}}
</syntaxhighlight>

Template:$ serializes the information inside of it into a string of key/value pairs, effectively converting the information to this style as it passes through into Template:BigTable:

<syntaxhighlight>
{{BigTable
|{"metal1":"bronze","metal2":"iron","metal3":"steel"}
|{"metal1":"mithril","metal2":"adamant","metal3":"rune"}
}}
</syntaxhighlight>

To access the information in the json params, the module uses the <code>deserialize</code> command from [[Module:$]] on the parameters. This converts the json strings into json objects with standard key/value pairs. The <code>deserialize</code> command leaves normal template params unchanged:

<syntaxhighlight lang="lua">
local ds = require('Module:$').deserialize
local p = {}

function p._main(args)
local secondmetalfromfirstparam = args[1]['metal2']
local thirdmetalfromsecondparam = args[2]['metal3']
end

function p.main(frame)
local args = ds(frame:getParent().args)
return p._main(args)
end

return p
</syntaxhighlight>