Template:Str rep

Template documentation[ view · edit · history · purge ]
This documentation is transcluded from Template:Str rep/doc.

Category:Main message boxesCategory:Lua String-based templatesReturns a replacement string with the first occurrence (by default) of a source string replaced with a pattern string. Note that while the first two parameters are marked required, the template technically works even without supplying them, but simply returns source string in this case.

Usage


{{Str rep |1= |2= |3= }}

Template parameters

ParameterDescriptionDefaultStatus
1
source
Source stringThe text to replace inemptyrequired
2
pattern
Pattern searchThe text to search foremptyrequired
3
replace
Replacement stringThe text to replace withemptysuggested
4
count
Replace countThe number of replacements to perform on the source string. Set |4=all to replace all instances of the pattern string.1optional
5
plain
Replacement typeBy default, the replacement type parses the pattern search and replacement string as plain strings. To use regular expression replacements, set |5=falsetrueoptional
 Parameter text is empty
<templatedata>JSON</templatedata> ./. {{TemplateBox}}
TemplateData

TemplateData is a way to store information about template parameters (the description of those and of the whole template) for both humans and machines. It is used by VisualEditor and possibly other tools like Upload Wizard.

Existing template documentation
At Wikimedia Commons, it is recommended to use {{TemplateBox}} with either ‎useTemplateData=1 or ‎useTemplateData=only on the ‎/doc subpage and transcluding it with {{Documentation}} into the template. ‎<nowiki>-tags can be wrapped around the arguments, if required, to avoid templates being expanded.

Newly created template documentation and imports
Another option, especially for imported templates, or for users with JSON experience, is placing raw ‎<templatedata>-tags into the Wikitext of the template, as described in various Wikipediae.

Wikipedia's help about TemplateData • Commons-specific information

Category:Templates using TemplateData

Returns a replacement string with the first occurrence (by default) of a source string replaced with a pattern string. Note that while the first two parameters are marked required, the template technically works even without supplying them, but simply returns string0 in this case.

Template parameters

This template prefers inline formatting of parameters.

ParameterDescriptionTypeStatus
Source string1 source

The text to replace in

Stringrequired
Pattern search2 pattern

The text to search for

Stringrequired
Replacement string3 replace

The text to replace with

Stringsuggested
Replace count4 count

The number of replacements to perform on the source string. Set this parameter to "all" to replace all instances of the pattern string.

Suggested values
all
Default
1
Lineoptional
Replacement type5 plain

By default, the replacement type parses the pattern search and replacement string as plain strings. To use regular expression replacements, set this parameter to "false."

Suggested values
true false
Default
true
Lineoptional

Additional information

The template is intended to be used in the following namespaces: the Template namespace

The template is intended to be used by the following user groups: all users

Relies on:
Module:String

Example

{{Str rep|032|3|1}}

renders as:

012

See also

Trimming templates:

  • {{Trunc}} – To trim down to a specified number of characters.
  • {{Trim}} — To trim any leading or trailing whitespace.
  • {{Str left}} – To trim down to a specified number of characters, or duplicate the string to a specified number.
  • {{Str right}}
  • {{Strip}} – To strip (remove) a given number of characters from the beginning/end of the string

Analyzing templates:

  • {{Str endswith}} – To check if a string ends with a given string.
  • {{Str find}} – Returns the numerical location of a given string in a string, up to 50 characters.
  • {{Str len}} – Returns a string's length. Can count up to 500 characters.

String length comparison templates:

  • {{Str ≤ len}} – To check if a string is "shorter or equally long" or "longer" than a given length.

Sandboxes and test cases:

Technical stuff:

Localization

This template is not intended to be localized.

Category:Templates not requiring internationalizationCategory:String manipulation templates
Category:Lua String-based templates Category:Main message boxes Category:String manipulation templates Category:Templates not requiring internationalization Category:Templates using TemplateData