View source for Template:In string/doc

{{wikipedia|page name}}
{{high-use}}
{{cascade-protected template}}
{{Documentation subpage}}
{{Lua|Module:String}}
<!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[Wikipedia:Wikidata]]) -->
This template wraps the function {{mlx|String|find|...|section=#find}}, and provides the extra option to return an alternative string (including a blank string) when nothing is found.
== Usage ==

: <code><nowiki>{{In string|</nowiki>''source_string''|''target_string''|''start_index''|''plain_flag''|''nomatch_returntext''}}</code>
:or
: <code><nowiki>{{In string|source=source_string |target=target_string |start=start_index |plain=plain_flag |nomatch=nomatch_returntext}}</nowiki></code>
<pre>
{{In string
|source= 
|target= 
|start= 
|plain=
|nomatch=
}}
</pre>
:By default, when the target is not found, <code>0</code> is returned. 
:Set {{para|nomatch|anytext}} to ''replace'' that <code>0</code>. Also, {{para|nomatch|}} &lt;blank> returns blank not 0.

:Note: outer spaces are not conserved.
;Using the nomatch option:

:<nowiki>{{#if:{{in string|source=pancake|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}}</nowiki> &rarr; {{#if:{{in string|source=pancake|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}}
:<nowiki>{{#if:{{in string|source=Hawaiian pizza|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}}</nowiki> &rarr; {{#if:{{in string|source=Hawaiian pizza|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}}

==Examples==

* <code><nowiki>{{In string|abc123def }}</nowiki></code> → {{In string|abc123def }}
* <code><nowiki>{{In string|source= abc123def }}</nowiki></code> → {{In string|source= abc123def }}
* <code><nowiki>{{In string|abc123def |123}}</nowiki></code> → {{In string|abc123def |123}}
* <code><nowiki>{{In string|source= abc123def |target= 123 }}</nowiki></code> → {{In string|source= abc123def |target= 123 }}
* <code><nowiki>{{In string|abc123def |%d|3|false}}</nowiki></code> → {{In string|abc123def |%d|3|false}}
* <code><nowiki>{{In string|source= abc123def |target= %d |start= 3 |plain= false }}</nowiki></code> → {{In string|source= abc123def |target= %d |start= 3 |plain= false}}

;nomatch=xxx
* <code><nowiki>{{In string|abc123def |nomatch=xxx}}</nowiki></code> → {{In string|abc123def |nomatch=xxx}}
* <code><nowiki>{{In string|source= abc123def |nomatch=xxx}}</nowiki></code> → {{In string|source= abc123def |nomatch=xxx}}
* <code><nowiki>{{In string|abc123def |123|nomatch=xxx}}</nowiki></code> → {{In string|abc123def |123|nomatch=xxx}}
* <code><nowiki>{{In string|source= abc123def |target= 123 |nomatch=xxx}}</nowiki></code> → {{In string|source= abc123def |target= 123 |nomatch=xxx}}
* <code><nowiki>{{In string|abc123def |%d|3|false|nomatch=xxx}}</nowiki></code> → {{In string|abc123def |%d|3|false|nomatch=xxx}}
* <code><nowiki>{{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=xxx}}</nowiki></code> → {{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=xxx}}

;nomatch = blank
* <code><nowiki>{{In string|abc123def |nomatch=}}</nowiki></code> → {{In string|abc123def |nomatch=}}
* <code><nowiki>{{In string|source= abc123def |nomatch=}}</nowiki></code> → {{In string|source= abc123def |nomatch=}}
* <code><nowiki>{{In string|abc123def |123|nomatch=}}</nowiki></code> → {{In string|abc123def |123|nomatch=}}
* <code><nowiki>{{In string|source= abc123def |target= 123 |nomatch=}}</nowiki></code> → {{In string|source= abc123def |target= 123 |nomatch=}}
* <code><nowiki>{{In string|abc123def |%d|3|false|nomatch=}}</nowiki></code> → {{In string|abc123def |%d|3|false|nomatch=}}
* <code><nowiki>{{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=}}</nowiki></code> → {{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=}}

;module Examples:
* <code><nowiki>{{#invoke:String|find|abc123def }}</nowiki></code> → {{#invoke:String|find|abc123def }}
* <code><nowiki>{{#invoke:String|find|source= abc123def }}</nowiki></code> → {{#invoke:String|find|source= abc123def }}
* <code><nowiki>{{#invoke:String|find|abc123def |123}}</nowiki></code> → {{#invoke:String|find|abc123def |123}}
* <code><nowiki>{{#invoke:String|find|source= abc123def |target= 123 }}</nowiki></code> → {{#invoke:String|find|source= abc123def |target= 123 }}
* <code><nowiki>{{#invoke:String|find|abc123def |%d|3|false}}</nowiki></code> → {{#invoke:String|find|abc123def |%d|3|false}}
* <code><nowiki>{{#invoke:String|find|source= abc123def |target= %d |start= 3 |plain= false }}</nowiki></code> → {{#invoke:String|find|source= abc123def |target= %d |start= 3 |plain= false }}

==Template data==
{{Template data header}}
{{cot|title=Template data|bg=#ddd}}
<includeonly>{{sandbox other||
<!-- Categories below this line, please; interwikis at Wikidata -->
[[Category:String manipulation templates]]
}}</includeonly>
<templatedata>
{
	"params": {
		"1": {},
		"2": {},
		"3": {},
		"4": {},
		"source": {},
		"target": {},
		"start": {},
		"plain": {},
		"nomatch": {}
	}
}
</templatedata>