sarna.net

wiki |

news |

forums |

downloads

Sarna News: HEXTECH Review - Wave 3 Brings More Urban Options To Your Battlefield

Search

Template:Str find

Sarna News

Sarna.net News: HEXTECH Review - Wave 3 Brings More Urban Options To Your Battlefield

Sarna.net Merch!

Support sarna.net! Merch!

BattleTech Community Ads

Mechanical Frog

Mechanical Frog

1

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

This template uses Lua:

Module:String (sandbox)

Contents

1 Usage
2 Examples
3 TemplateData
4 See also

Usage[edit]

{{Str find|text|sub_string}}

Returns the position of first appearance of sub_string in text.

The comparison is case sensitive.
Returns -1 if sub_string not found
Character position is 1 based (not 0 based as usual in calculations).
If sub_string is empty, this routine returns 1. This case will often have to be handled specially.

Examples[edit]

In the examples, the string to be searched is Abcdefghijklm:

A; 1
a; -1
def; 4
klm; 11
zyx; -1
empty;klm;-1
empty;empty; 1

TemplateData[edit]

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools.

TemplateData for Str find

A template to find the numeric position of first appearance of ''sub_string'' in ''text''

Template parameters
Parameter		Description	Type	Status
Text	`1`	The text to search within	String	required
Sub_string	`2`	The string to be searched within the text	String	required

See also[edit]

String-handling templates (help page)

Substring (select chunk of string by its position)

{{str sub new}}	Select a substring based on starting and ending index counted in either direction.
{{str left}}	Keep the first N characters of a string, or duplicate it to N characters.
{{str crop}}	Return all but the last N characters of a string.
{{str index}}	Return the N-th character of a string.

{{str right}}	Return substring starting at N-th character to end of string.
{{str rightc}}	Return the last N characters of a string; or a given value if empty.
{{str sub old}}	Return substring of given length starting at N-th character.

Trimming (select/remove chunk of string by character type)

{{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 (e.g. "1740s") from a pagename, if any.
{{title number}}	Returns any number 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.
{{in string}}	Returns optional string when given string is not found
{{str count}}	Count the number of occurrences of a pattern within a string.

{{a or an}}	Takes a noun and produces the appropriate indefinite article, based on whether the first letter is a vowel.
{{Array}}	Array manipulation and retrieval.
{{Font style}}	Returns bold or italic if the input value has either formatting.
{{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.

Category:String manipulation templates

Category:String manipulating modules

The above documentation is transcluded from Template:Str find/doc.
Editors can experiment in this template's sandbox and testcases pages.
Add categories to the /doc subpage. Subpages of this template.

Retrieved from "https://www.sarna.net/wiki/index.php?title=Template:Str_find&oldid=979716"

Hidden category:

Templates using TemplateData

Search

Tools