Voozh

From Wikipedia, the free encyclopedia

👁 Image
Template documentation[view] [edit] [history] [purge]

This template is used on approximately 299,000 pages.
To avoid major disruption and server load, any changes should be tested in the template's /sandbox or /testcases subpages, or in your own user subpage. The tested changes can be added to this page in a single edit. Consider discussing changes on the talk page before implementing them.

👁 Image

This template can only be edited by administrators because it is transcluded onto one or more cascade-protected pages.

👁 Image

This template uses Lua:

Module:String (sandbox)

This template wraps the function {{#invoke:String|find|...}}, and provides the extra option to return an alternative string (including a blank string) when nothing is found.

Usage

{{In string|source_string|target_string|start_index|plain_flag|nomatch_returntext}}

{{In string|source=source_string |target=target_string |start=start_index |plain=plain_flag |nomatch=nomatch_returntext}}

{{In string
|source= 
|target= 
|start= 
|plain=
|nomatch=
}}

By default, when the target is not found, 0 is returned.

Set |nomatch=anytext to replace that 0. Also, |nomatch= <blank> returns blank not 0.

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

{{#if:{{in string|source=pancake|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}} → Not a pizza

{{#if:{{in string|source=Hawaiian pizza|target=pizza|plain=true|nomatch=}}|Is a pizza|Not a pizza}} → Is a pizza

Examples

{{In string|abc123def }} → 0
{{In string|source= abc123def }} → 0
{{In string|abc123def |123}} → 4
{{In string|source= abc123def |target= 123 }} → 4
{{In string|abc123def |%d|3|false}} → 4
{{In string|source= abc123def |target= %d |start= 3 |plain= false }} → 4

nomatch=xxx

{{In string|abc123def |nomatch=xxx}} → xxx
{{In string|source= abc123def |nomatch=xxx}} → xxx
{{In string|abc123def |123|nomatch=xxx}} → 4
{{In string|source= abc123def |target= 123 |nomatch=xxx}} → 4
{{In string|abc123def |%d|3|false|nomatch=xxx}} → 4
{{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=xxx}} → 4

nomatch = blank

{{In string|abc123def |nomatch=}} →
{{In string|source= abc123def |nomatch=}} →
{{In string|abc123def |123|nomatch=}} → 4
{{In string|source= abc123def |target= 123 |nomatch=}} → 4
{{In string|abc123def |%d|3|false|nomatch=}} → 4
{{In string|source= abc123def |target= %d |start= 3 |plain= false |nomatch=}} → 4

module Examples

{{#invoke:String|find|abc123def }} → 0
{{#invoke:String|find|source= abc123def }} → 0
{{#invoke:String|find|abc123def |123}} → 4
{{#invoke:String|find|source= abc123def |target= 123 }} → 4
{{#invoke:String|find|abc123def |%d|3|false}} → 4
{{#invoke:String|find|source= abc123def |target= %d |start= 3 |plain= false }} → 4

Template data

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for in articles based on its TemplateData.

TemplateData for In string

Template data

Template parameters[Edit template data]
Parameter		Description	Type	Status
1	`1`	no description	Unknown	optional
2	`2`	no description	Unknown	optional
3	`3`	no description	Unknown	optional
4	`4`	no description	Unknown	optional
source	`source`	no description	Unknown	optional
target	`target`	no description	Unknown	optional
start	`start`	no description	Unknown	optional
plain	`plain`	no description	Unknown	optional
nomatch	`nomatch`	no description	Unknown	optional

{{trim}}	Trim any leading or trailing whitespace
{{str letter/trim}}	Trim down to the beginning letters.
{{str number/trim}}	Trim down to the beginning numbers.
{{trim brackets}}	Trim any leading or trailing square brackets.
{{trim quotes}}	Trim leading or trailing matching quotes.
{{trim leading}}	Trim up to six instances of specified <prefix>.

{{string split}}	Extract a short string from a long string.
{{first word}}	Trim down to the first space.
{{remove first word}}	Remove anything before the first space.
{{last word}}	Trim down from the last space.
{{remove last word}}	Remove anything after the last space.

Select/remove specific item from string

{{delink}}, {{trim brackets}}	Removes wikilink brackets (wikicode); all or outer only.
{{Plain text}}	Removes wikicode (formatting and brackets)
{{PAGENAMEBASE}}	Trim off any parenthesis text at the end of a string (disambiguation).
{{title disambig text}}	Returns text in parentheses at the end of a string (disambiguation).

{{title year}}	Returns the 3-or-4-digit year from a pagename, if any.
{{title decade}}	Returns the 4-digit decade from a pagename (e.g. "1740" from "Foo 1740s bar"), if any.
{{title number}}	Returns any number from a pagename.
{{WikiProjectbasename}}	Removes "WikiProject" from a pagename.

Insertion, replacement, and length

{{loop}}	Repeat character string a specified number of times.
{{replace}}	Returns the string, after replacing all occurrences of a specified string with another string.
{{str rep}}	Returns the string, after replacing the first occurrence of a specified string with another string.
{{digits}}	Returns the string, after removing all characters that are not digits 0–9
{{Nowiki}}	Displays wikitext as plain text.

{{str len}}	Returns a string's length.
{{str ≥ len}}	Check if a string is "longer or equally long" or "shorter" than a given length.
{{str ≤ len}}	Check if a string is "shorter or equally long" or "longer" than a given length.
{{str ≠ len}}	Check if a string is "not equal" or "equal" to a given length.

Analysis and searching

{{str startswith}} {{str endswith}}	Check if a string starts or ends with a given string.
{{str find}}, {{strfind short}}	Returns the numerical location of a given string in a string.
{{str count}}	Count the number of occurrences of a pattern within a string.
{{string count in page}}	Count the number of occurrences of a string within a given page's wikitext.

{{Array}}	Array item manipulation and retrieval.
{{a or an}}	Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
{{}}	Returns optional string when given string is not found
{{Isnumeric}}	Returns number when true, blank when not numeric.
{{str letter}}	Returns the number of letters that begin a string.
{{str number}}	Returns the number of numbers that begin a string.

Modules and built-in functions
Module:String, Module:String2, Module:Ustring, Module:Text, wikitext handling: modules that together contain most necessary string functions. Magic words: About `{{padleft:\|}}`, `{{lc:\|}}`, `{{formatnum:\|}}` etc. ParserFunctions: About `{{#titleparts:\|}}, {{#expr:\|}}, {{#ifeq:\|}},` etc.