Module:String2/doc - Revision history

Grufo: +Cat

2025-04-22T08:09:00Z

+Cat

← Previous revision		Revision as of 08:09, 22 April 2025
Line 304:		Line 304:
	<includeonly>{{Sandbox other\|\|		<includeonly>{{Sandbox other\|\|
	[[Category:Modules that manipulate strings\|*]]		[[Category:Modules that manipulate strings\|*]]
			[[Category:Template metamodules]]
	}}</includeonly>		}}</includeonly>

Ahecht: use {{markup}} again

2024-12-02T05:54:37Z

use {{markup}} again

← Previous revision		Revision as of 05:54, 2 December 2024
Line 148:		Line 148:
	A startswith function similar to {{ml\|string\|endswith}}. Both parameters are required, although they can be blank. Leading and trailing whitespace ''is'' counted, use named parameters to avoid this if required. Outputs "yes" for true and blank for false so may be passed directly to #if.		A startswith function similar to {{ml\|string\|endswith}}. Both parameters are required, although they can be blank. Leading and trailing whitespace ''is'' counted, use named parameters to avoid this if required. Outputs "yes" for true and blank for false so may be passed directly to #if.

	{{markup\|		{{markup\|padding=1px 5px\|
	<nowiki>{{#invoke:string2\|startswith\|search\|se}}</nowiki>\|{{#invoke:string2\|startswith\|search\|se}}\|		<nowiki>{{#invoke:string2\|startswith\|search\|se}}</nowiki>\|{{#invoke:string2\|startswith\|search\|se}}\|
	<nowiki>{{#invoke:string2\|startswith\|search\|ch}}</nowiki>\|{{#invoke:string2\|startswith\|search\|ch}}}}<!-- Template:Mra -->		<nowiki>{{#invoke:string2\|startswith\|search\|ch}}</nowiki>\|{{#invoke:string2\|startswith\|search\|ch}}}}<!-- Template:Mra -->
Line 155:		Line 155:
	Implements {{tl\|isnumeric}}, which tests whether a value is numeric (or at least, that it can be treated as such by the [[:mw:Extension:Scribunto/Lua_reference_manual#Language_library\|Scribunto language library]]). By default, it will pass through the parameter if it's numeric and be blank if it's not. If the parameter <code>boolean=true</code> is given, then it will output <code>1</code> if numeric and <code>0</code> if not numeric.		Implements {{tl\|isnumeric}}, which tests whether a value is numeric (or at least, that it can be treated as such by the [[:mw:Extension:Scribunto/Lua_reference_manual#Language_library\|Scribunto language library]]). By default, it will pass through the parameter if it's numeric and be blank if it's not. If the parameter <code>boolean=true</code> is given, then it will output <code>1</code> if numeric and <code>0</code> if not numeric.

			{{markup\|padding=1px 5px\|
	{\| class="wikitable"
		⚫	<nowiki>{{#invoke:string2\|isnumeric\|1,327.50}}</nowiki>\|{{#invoke:string2\|isnumeric\|1,327.50}}\|
	! Markup !! Output
		⚫	<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)}}</nowiki>\|{{#invoke:string2\|isnumeric\|9,999 (1950)}}\|
	\|-
	~~\|<code>~~<nowiki>{{#invoke:string2\|isnumeric\|1,327.50}}</nowiki>~~</code>\|~~\|{{#invoke:string2\|isnumeric\|1,327.50}}		<nowiki>{{#invoke:string2\|isnumeric\|1,327.50\|boolean=true}}</nowiki>\|{{#invoke:string2\|isnumeric\|1,327.50\|boolean=true}}\|
		⚫	<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}</nowiki>\|{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}}}
	\|-
⚫	~~\|<code>~~<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)}}</nowiki>~~</code>\|~~\|{{#invoke:string2\|isnumeric\|9,999 (1950)}}
	\|-
⚫	~~\|<code>~~<nowiki>{{#invoke:string2\|isnumeric\|1,327.50~~\|boolean=true~~}}</nowiki>~~</code>\|~~\|{{#invoke:string2\|isnumeric\|1,327.50~~\|boolean=true~~}}
	\|-
⚫	~~\|<code>~~<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}</nowiki>~~</code>\|~~\|{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}
	\|}

	== Usage ==		== Usage ==

Ahecht: /* isnumeric */ {{marku}} seems to produce excessively tall rows

2024-12-02T04:33:41Z

isnumeric: {{marku}} seems to produce excessively tall rows

@@ Line 155: / Line 155: @@
 Implements {{tl|isnumeric}}, which tests whether a value is numeric (or at least, that it can be treated as such by the [[:mw:Extension:Scribunto/Lua_reference_manual#Language_library|Scribunto language library]]). By default, it will pass through the parameter if it's numeric and be blank if it's not. If the parameter <code>boolean=true</code> is given, then it will output <code>1</code> if numeric and <code>0</code> if not numeric.
-<nowiki>{{#invoke:string2|isnumeric|1,327.50|boolean=true}}</nowiki>|{{#invoke:string2|isnumeric|1,327.50|boolean=true}}|
+|<code><nowiki>{{#invoke:string2|isnumeric|1,327.50}}</nowiki></code>||{{#invoke:string2|isnumeric|1,327.50}}
 == Usage ==

Ahecht: /* Functions */ isnumeric

2024-12-02T04:27:01Z

Functions: isnumeric

← Previous revision		Revision as of 04:27, 2 December 2024
Line 151:		Line 151:
	<nowiki>{{#invoke:string2\|startswith\|search\|se}}</nowiki>\|{{#invoke:string2\|startswith\|search\|se}}\|		<nowiki>{{#invoke:string2\|startswith\|search\|se}}</nowiki>\|{{#invoke:string2\|startswith\|search\|se}}\|
	<nowiki>{{#invoke:string2\|startswith\|search\|ch}}</nowiki>\|{{#invoke:string2\|startswith\|search\|ch}}}}<!-- Template:Mra -->		<nowiki>{{#invoke:string2\|startswith\|search\|ch}}</nowiki>\|{{#invoke:string2\|startswith\|search\|ch}}}}<!-- Template:Mra -->

			===isnumeric===
			Implements {{tl\|isnumeric}}, which tests whether a value is numeric (or at least, that it can be treated as such by the [[:mw:Extension:Scribunto/Lua_reference_manual#Language_library\|Scribunto language library]]). By default, it will pass through the parameter if it's numeric and be blank if it's not. If the parameter <code>boolean=true</code> is given, then it will output <code>1</code> if numeric and <code>0</code> if not numeric.

			{{markup\|
			<nowiki>{{#invoke:string2\|isnumeric\|1,327.50}}</nowiki>\|{{#invoke:string2\|isnumeric\|1,327.50}}\|
			<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)}}</nowiki>\|{{#invoke:string2\|isnumeric\|9,999 (1950)}}\|
			<nowiki>{{#invoke:string2\|isnumeric\|1,327.50\|boolean=true}}</nowiki>\|{{#invoke:string2\|isnumeric\|1,327.50\|boolean=true}}\|
			<nowiki>{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}</nowiki>\|{{#invoke:string2\|isnumeric\|9,999 (1950)\|boolean=true}}}}

	== Usage ==		== Usage ==

Uzume: /* split */

2024-03-28T02:33:48Z

split

← Previous revision		Revision as of 02:33, 28 March 2024
Line 67:		Line 67:
	The index parameter is optional; it defaults to the first chunk of text.		The index parameter is optional; it defaults to the first chunk of text.

	The ~~[[Template:Stringsplit]]~~ is a convenience wrapper for the split function.		The {{tl\|string split}} is a convenience wrapper for the split function.

	=== stripZeros ===		=== stripZeros ===

MSGJ: /* findpagetext */ fix link

2023-12-21T13:33:08Z

findpagetext: fix link

← Previous revision		Revision as of 13:33, 21 December 2023
Line 87:		Line 87:
	* First positional parameter or \|text is the text to be searched for.		* First positional parameter or \|text is the text to be searched for.
	* Optional parameter \|title is the page title, defaults to the current page.		* Optional parameter \|title is the page title, defaults to the current page.
	* Optional parameter \|plain is either true for a plain search (default), or false for a [[Extension:Scribunto/Lua reference manual #Patterns\|Lua pattern]] search.		* Optional parameter \|plain is either true for a plain search (default), or false for a [[mw:Extension:Scribunto/Lua reference manual #Patterns\|Lua pattern]] search.
	* Optional parameter \|nomatch is the value returned when no match is found; default is nothing.		* Optional parameter \|nomatch is the value returned when no match is found; default is nothing.

Jnestorius: /* title */ This is a very simplistic algorithm; see :Template:Title case/doc for discussion of its limitations.

2023-11-30T21:15:12Z

title: This is a very simplistic algorithm; see Template:Title case/doc for discussion of its limitations.

← Previous revision		Revision as of 21:15, 30 November 2023
Line 15:		Line 15:

	=== title ===		=== title ===
	The title function capitalises the first letter of each word in the text, apart from a number of short words ~~recommended~~ by [[s:U.S. Government Printing Office Style Manual/Capitalization Rules\|The U.S. Government Printing Office Style Manual]]: {{xt\|a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor}}.		The title function capitalises the first letter of each word in the text, apart from a number of short words listed in [[s:U.S. Government Printing Office Style Manual/Capitalization Rules#3.49\|The U.S. Government Printing Office Style Manual §3.49 "Center and side heads"]]: {{xt\|a, an, the, at, by, for, in, of, on, to, up, and, as, but, or, and nor}}.

			This is a very simplistic algorithm; see [[:Template:Title case/doc]] for some of its limitations.

	=== sentence ===		=== sentence ===

Zyxw: /* strip */ update

2023-08-21T16:23:25Z

strip: update

← Previous revision		Revision as of 16:23, 21 August 2023
Line 105:		Line 105:

	; Usage		; Usage
	: <code><nowiki>{{#invoke:String2\|strip\|source_string\|characters_to_strip}}</~~nowiki~~></code>		: <code><nowiki>{{#invoke:String2\|strip\|</nowiki><var>source_string</var>\|<var>characters_to_strip</var>\|<var>plain_flag</var>}}</code>
	: <code><nowiki>{{#invoke:String2\|strip\|~~source_string\|characters_to_strip\|plain_flag}}~~</nowiki></code>		: <code><nowiki>{{#invoke:String2\|strip\|</nowiki>source=\|chars=\|plain=}}</code>

	; Examples		; Examples
	: <code><nowiki>{{#invoke:String2\|strip\|abc123def\|123}}</nowiki></code> → {{#invoke:String2\|strip\|abc123def\|123}}		: <code><nowiki>{{#invoke:String2\|strip\|abc123def\|123}}</nowiki></code> → {{#invoke:String2\|strip\|abc123def\|123}}
⚫	: <code><nowiki>{{#invoke:String2\|strip\|abc123def\|123~~\|true~~}}</nowiki></code> → {{#invoke:String2\|strip\|abc123def\|123~~\|true~~}}
	: <code><nowiki>{{#invoke:String2\|strip\|abc123def\|%d+\|false}}</nowiki></code> → {{#invoke:String2\|strip\|abc123def\|%d+\|false}}		: <code><nowiki>{{#invoke:String2\|strip\|abc123def\|%d+\|false}}</nowiki></code> → {{#invoke:String2\|strip\|abc123def\|%d+\|false}}
		⚫	: <code><nowiki>{{#invoke:String2\|strip\|source=abc123def\|chars=123}}</nowiki></code> → {{#invoke:String2\|strip\|source=abc123def\|chars=123}}
			: <code><nowiki>{{#invoke:String2\|strip\|source=abc123def\|chars=%d+\|plain=false}}</nowiki></code> → {{#invoke:String2\|strip\|source=abc123def\|chars=%d+\|plain=false}}

	=== matchAny ===		=== matchAny ===

Zyxw: add usage and examples

2023-08-21T16:01:50Z

add usage and examples

@@ Line 54: / Line 54: @@
 === split ===
 The ''split'' function splits text at boundaries specified by separator and returns the chunk for the index idx (starting at 1). It can use positional parameters or named parameters (but these should not be mixed):
 Any double quotes (") in the separator parameter are stripped out, which allows spaces and wikitext like <code><nowiki>["[</nowiki></code> to be passed. Use <code>{{tl|!}}</code> for the pipe character <code>|</code>.
@@ Line 100: / Line 103: @@
 The strip function strips the first positional parameter of the characters or pattern supplied in the second positional parameter.
 === matchAny ===

Aidan9382: /* See also */ fix editor syntax highlighting

2023-05-02T18:03:43Z

See also: fix editor syntax highlighting

← Previous revision		Revision as of 18:03, 2 May 2023
Line 275:		Line 275:
	{{Case templates see also}}		{{Case templates see also}}

	Templates that implement ~~<code><~~nowiki~~></code>~~		Templates that implement {{tag\|nowiki\|o}}
	* {{tl\|nowiki}}		* {{tl\|nowiki}}
	* {{tl\|nowiki2}}		* {{tl\|nowiki2}}

← Previous revision		Revision as of 13:33, 21 December 2023
Line 87:		Line 87:
	* First positional parameter or \|text is the text to be searched for.		* First positional parameter or \|text is the text to be searched for.
	* Optional parameter \|title is the page title, defaults to the current page.		* Optional parameter \|title is the page title, defaults to the current page.
	* Optional parameter \|plain is either true for a plain search (default), or false for a [[Extension:Scribunto/Lua reference manual #Patterns\|Lua pattern]] search.		* Optional parameter \|plain is either true for a plain search (default), or false for a [[mw:Extension:Scribunto/Lua reference manual #Patterns\|Lua pattern]] search.
	* Optional parameter \|nomatch is the value returned when no match is found; default is nothing.		* Optional parameter \|nomatch is the value returned when no match is found; default is nothing.