Module:Ustring/doc - Revision history

Grufo: +Cat

2025-04-22T08:12:16Z

+Cat

← Previous revision		Revision as of 08:12, 22 April 2025
Line 105:		Line 105:
	<!-- Categories below this line, please; interwikis at Wikidata -->		<!-- Categories below this line, please; interwikis at Wikidata -->
	[[Category:Modules that manipulate strings\|*]]		[[Category:Modules that manipulate strings\|*]]
			[[Category:Template metamodules\|*]]
	}}</includeonly>		}}</includeonly>

64.114 etc at 02:15, 19 October 2024

2024-10-19T02:15:02Z

← Previous revision		Revision as of 02:15, 19 October 2024
Line 1:		Line 1:
	{{used in system}}		{{used in system}}
			{{cascade-protected template\|page=module}}
	{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

Pppery at 22:54, 8 August 2022

2022-08-08T22:54:10Z

← Previous revision		Revision as of 22:54, 8 August 2022
Line 1:		Line 1:
	{{used in ~~systen~~}}		{{used in system}}
	{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

Pppery: Used in system

2022-08-08T22:54:03Z

Used in system

← Previous revision		Revision as of 22:54, 8 August 2022
Line 1:		Line 1:
			{{used in systen}}
	{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}		{{Module rating \|release<!-- Values: pre-alpha • alpha • beta • release • protected -- If a rating not needed/relevant, delete this template call -->}}
	<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->		<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->

Uzume: rv with fix

2021-11-15T15:19:23Z

rv with fix

← Previous revision		Revision as of 15:19, 15 November 2021
Line 21:		Line 21:
	\|-		\|-
	\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|		\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|
			\|-
			\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|1\|<nowiki>\{{#if:1\|{{{1}}}}}</nowiki>}} \|\|
	\|}		\|}

GKFX: Remove last example as it is not correct

2021-11-14T10:36:23Z

Remove last example as it is not correct

← Previous revision		Revision as of 10:36, 14 November 2021
Line 21:		Line 21:
	\|-		\|-
	\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|		\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|
	\|-
	\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|1\|\{{{1}}}}} \|\|
	\|}		\|}

Uzume: unused

2021-11-11T22:31:31Z

unused

← Previous revision		Revision as of 22:31, 11 November 2021
Line 25:		Line 25:
	\|}		\|}

	You can also wrap results in tags. All ~~non-number~~ ~~indexed~~ arguments will be passed to {{luaref\|frame:extensionTag}}		You can also wrap results in tags. All other unused arguments will be passed to {{luaref\|frame:extensionTag}}

	== Usage ==		== Usage ==

Uzume: document that the new "s" args are not really necessary as the same functionality can already be achieved with named numeric parameter usage

2021-11-11T19:11:12Z

document that the new "s" args are not really necessary as the same functionality can already be achieved with named numeric parameter usage

← Previous revision		Revision as of 19:11, 11 November 2021
Line 15:		Line 15:
	\|-		\|-
	\| <code>"0123"</code> \|\| {{para\|s1\|0123}} \|\| If you don't need to preserve whitespace use {{para\|s1}} etc.		\| <code>"0123"</code> \|\| {{para\|s1\|0123}} \|\| If you don't need to preserve whitespace use {{para\|s1}} etc.
			\|-
			\| <code>"0123"</code> \|\| {{para\|1\|\0123}} \|\| If you don't need to preserve whitespace explicitly use {{para\|1}} etc.
	\|-		\|-
	\| In another template, to pass its parameter <code>{{{1}}}</code>, preserving whitespace \|\| {{para\|\|\{{{1}}}}} \|\| Must provide the <code>\</code> with unknown string input.		\| In another template, to pass its parameter <code>{{{1}}}</code>, preserving whitespace \|\| {{para\|\|\{{{1}}}}} \|\| Must provide the <code>\</code> with unknown string input.
	\|-		\|-
	\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|		\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|
			\|-
			\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|1\|\{{{1}}}}} \|\|
	\|}		\|}

GKFX: Document s1, s2, etc, parameters

2021-10-13T17:07:28Z

Document s1, s2, etc, parameters

← Previous revision		Revision as of 17:07, 13 October 2021
Line 3:		Line 3:
	This module directly imports all functions from the {{luaref\|Ustring library\|mw.ustring}} library. Documentation for each function can be found there.		This module directly imports all functions from the {{luaref\|Ustring library\|mw.ustring}} library. Documentation for each function can be found there.

	The module takes an indefinite number of arguments. All arguments are coerced as number type if possible. If you wish for ~~something~~ to remain a string, you can simply escape it by ~~insert~~ <code>\</code> at the beginning of the string.		The module takes an indefinite number of arguments. Arguments given as {{para\|s1}}, {{para\|s2}}, etc, are read first, and are used as strings. All remaining numerical arguments are coerced to number type if possible, and remain strings if not. If you wish for a numerical (i.e. unnamed or "{{para\|1}}", "{{para\|2}}") to remain a string, you can simply escape it by inserting <code>\</code> at the beginning of the string.

			Note that MediaWiki will always trim whitespace from named arguments; to give arguments with surrounding whitespace you must use unnamed parameters starting with <code>\</code>.

			{\| class="wikitable"
			\|+ How to pass inconvenient strings
			\|-
			! To pass this... !! Write this !! Explanation
			\|-
			\| <code>" 0123 "</code> \|\| {{para\|\|\ 123 }} \|\| To get surrounding whitespace must use unnamed, but must precede with <code>\</code> to indicate that it isn't a number.
			\|-
			\| <code>"0123"</code> \|\| {{para\|s1\|0123}} \|\| If you don't need to preserve whitespace use {{para\|s1}} etc.
			\|-
			\| In another template, to pass its parameter <code>{{{1}}}</code>, preserving whitespace \|\| {{para\|\|\{{{1}}}}} \|\| Must provide the <code>\</code> with unknown string input.
			\|-
			\| In another template, to pass its parameter <code>{{{1}}}</code>, stripping whitespace \|\| {{para\|s1\|{{{1}}}}} \|\|
			\|}

	You can also wrap results in tags. All non-number indexed arguments will be passed to {{luaref\|frame:extensionTag}}		You can also wrap results in tags. All non-number indexed arguments will be passed to {{luaref\|frame:extensionTag}}
Line 12:		Line 28:

	===Example using mw.ustring.sub===		===Example using mw.ustring.sub===
	<code><nowiki>{{#invoke:Ustring\|sub\|abcde\|2\|4}}</nowiki></code>		<code><nowiki>{{#invoke:Ustring\|sub\|s1=abcde\|2\|4}}</nowiki></code>

	produces:		produces:

	{{#invoke:Ustring\|sub\|abcde\|2\|4}}		{{#invoke:Ustring\|sub\|s1=abcde\|2\|4}}

	===Example using mw.ustring.gsub===		===Example using mw.ustring.gsub===
	<code><nowiki>{{#invoke:Ustring\|gsub\|1234\|23\|}}</nowiki></code>		<code><nowiki>{{#invoke:Ustring\|gsub\|s1=1234\|23\|}}</nowiki></code>

	produces:		produces:

	{{#invoke:Ustring\|gsub\|1234\|23\|}}		{{#invoke:Ustring\|gsub\|s1=1234\|23\|}}

	===Example using mw.ustring.char===		===Example using mw.ustring.char===
Line 33:		Line 49:

	===Example using mw.ustring.match===		===Example using mw.ustring.match===
	<code><nowiki>{{#invoke:Ustring\|match\|abcde\|(c%w)}}</nowiki></code>		<code><nowiki>{{#invoke:Ustring\|match\|s1=abcde\|s2=(c%w)}}</nowiki></code>

	produces:		produces:

	{{#invoke:Ustring\|match\|abcde\|(c%w)}}		{{#invoke:Ustring\|match\|s1=abcde\|s2=(c%w)}}

	Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.		Note: Only the first match is returned. Additional returns are omitted because mw.ustring.gsub's second return value is generally undesirable.
Line 43:		Line 59:
	===Example using tag arguments===		===Example using tag arguments===
	<pre>{{#invoke:Ustring\|match		<pre>{{#invoke:Ustring\|match
	\|{{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%		\|s1={{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%
	<!--enter an actual newline character to match '\n'-->%s%s%send		<!--enter an actual newline character to match '\n'-->%s%s%send
	\|tag=syntaxhighlight\|lang=lua}}</pre>		\|tag=syntaxhighlight\|lang=lua}}</pre>
	produces:		produces:
	{{#invoke:Ustring\|match		{{#invoke:Ustring\|match
	\|{{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%		\|s1={{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%
	<!--enter an actual newline character to match '\n'-->%s%s%send		<!--enter an actual newline character to match '\n'-->%s%s%send
	\|tag=syntaxhighlight\|lang=lua}}		\|tag=syntaxhighlight\|lang=lua}}
Line 54:		Line 70:
	Note that:		Note that:
	{{#tag:pre\|<nowiki><syntaxhighlight lang="lua">{{#invoke:Ustring\|match		{{#tag:pre\|<nowiki><syntaxhighlight lang="lua">{{#invoke:Ustring\|match
	\|{{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%		\|s1={{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%
	<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight></nowiki>}}		<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight></nowiki>}}
	produces:		produces:
	<syntaxhighlight lang="lua">{{#invoke:Ustring\|match		<syntaxhighlight lang="lua">{{#invoke:Ustring\|match
	\|{{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%		\|s1={{Module:Ustring}}\|%s%s%sif%snot%s[^%s]+%sthen.+%
	<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight>		<!--enter an actual newline character to match '\n'-->%s%s%send}}</syntaxhighlight>

GKFX: /* Example using mw.ustring.char */ Remove example as it does not look like the sort of code to encourage

2021-10-04T18:21:50Z

Example using mw.ustring.char: Remove example as it does not look like the sort of code to encourage

← Previous revision		Revision as of 18:21, 4 October 2021
Line 31:		Line 31:

	&#{{#invoke:ustring\|char\|49\|48\|59}}		&#{{#invoke:ustring\|char\|49\|48\|59}}

	This is nice for escaping character sequences in other modules; for example:
	<syntaxhighlight lang="lua">
	p = {}
	function p.main(frame)
	local str = '1-2-2{{#invoke:ustring\|char\|45}}1-3'
	return frame:preprocess(str:gsub('-', '/'))-- == '1/2/2-1/3'
	end
	return p
	</syntaxhighlight>

	===Example using mw.ustring.match===		===Example using mw.ustring.match===