WOLFRAM

Wolfram Language & System Documentation Center
Wolfram Language Home Page »

StringTemplate
✖
StringTemplate

✖
StringTemplate["string"]

yields a TemplateObject expression that represents a string template to be applied to arguments.

✖

uses File[…], URL[…] or CloudObject[…] as the source for the string template.

✖
StringTemplate[form,args]

yields a TemplateObject with arguments, suitable for cloud deployment or other evaluation.

Details and Options

Examples

open allclose all

Basic Examples  (4)Summary of the most common use cases

Apply a string template with slots named a and b:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-k0x3ot
Out[1]=1

An equivalent form using TemplateApply:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-40pa4f
Out[2]=2

The StringTemplate is not needed inside TemplateApply:

In[3]:=3
✖
https://wolfram.com/xid/0b8b4n13y6-php541
Out[3]=3

Apply a string template to positional arguments:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-gyq9xj
Out[1]=1

An equivalent form:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-ghm5da
Out[2]=2

The expression inside <* ... *> is evaluated when the string template is applied:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-9c9jtf
Out[1]=1

Include a template slot as well as an expression in the template string:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-bfe2m0
Out[2]=2

Values from the association can be used in the template expression:

In[3]:=3
✖
https://wolfram.com/xid/0b8b4n13y6-c0kvbh
Out[3]=3

Rule delayed can be used to delay computations:

In[4]:=4
✖
https://wolfram.com/xid/0b8b4n13y6-rccdyo
Out[4]=4
In[5]:=5
✖
https://wolfram.com/xid/0b8b4n13y6-igiw7l
Out[5]=5

Expressions are spliced into the string using TextString:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-gzfpvt
Out[1]=1

Scope  (4)Survey of the scope of standard use cases

File is fully supported:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-f48c8p
Out[1]=1

Templates can be hosted in the Wolfram Cloud:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-zn99tp
Out[1]=1

CloudObject can be directly used by TemplateApply:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-euzfet
Out[2]=2

The second argument of StringTemplate can be used to bound data to the template:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-u7p483
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-8tx9dm
Out[2]=2

URL can be used to fetch templates:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-ehr44g
Out[1]=1
In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-uwsajo
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0b8b4n13y6-se9tn7
Out[3]=3

Options  (2)Common values & functionality for each option

CombinerFunction  (1)

Specify a different way to combine parts of templates:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-mvn9kj
Out[1]=1

It can be used to return any expression, not only a string:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-4xbpcu
Out[2]=2
In[3]:=3
✖
https://wolfram.com/xid/0b8b4n13y6-yh0ga7
Out[3]=3

InsertionFunction  (1)

Specify a function to convert arguments before they are inserted:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-xs7arn
Out[1]=1

You can use a string to specify an export format:

In[2]:=2
✖
https://wolfram.com/xid/0b8b4n13y6-p2w19u
Out[2]=2

Properties & Relations  (3)Properties of the function, and connections to other functions

StringTemplate evaluates to a TemplateObject:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-zib0jp
Out[1]=1

If you deploy a template with data, each time you visit it TemplateApply will render the content again:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-kwsq8a
Out[1]=1

TemplateApply can be used to parse and apply a string template in one step:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-8qyixc
Out[1]=1

Possible Issues  (1)Common pitfalls and unexpected behavior

Data in the second argument of StringTemplate takes precedence over arguments in TemplateApply:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-4hpk4b
Out[1]=1

Neat Examples  (1)Surprising or curious use cases

You can deploy a StringTemplate to the cloud. When you visit the URL, TemplateApply will render the template on each visit:

In[1]:=1
✖
https://wolfram.com/xid/0b8b4n13y6-j836et
Out[1]=1
Wolfram Research (2014), StringTemplate, Wolfram Language function, https://reference.wolfram.com/language/ref/StringTemplate.html.
✖
Wolfram Research (2014), StringTemplate, Wolfram Language function, https://reference.wolfram.com/language/ref/StringTemplate.html.

Text

Wolfram Research (2014), StringTemplate, Wolfram Language function, https://reference.wolfram.com/language/ref/StringTemplate.html.

✖
Wolfram Research (2014), StringTemplate, Wolfram Language function, https://reference.wolfram.com/language/ref/StringTemplate.html.

CMS

Wolfram Language. 2014. "StringTemplate." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/StringTemplate.html.

✖
Wolfram Language. 2014. "StringTemplate." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/StringTemplate.html.

APA

Wolfram Language. (2014). StringTemplate. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/StringTemplate.html

✖
Wolfram Language. (2014). StringTemplate. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/StringTemplate.html

BibTeX

@misc{reference.wolfram_2025_stringtemplate, author="Wolfram Research", title="{StringTemplate}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/StringTemplate.html}", note=[Accessed: 11-May-2025 ]}

✖
@misc{reference.wolfram_2025_stringtemplate, author="Wolfram Research", title="{StringTemplate}", year="2014", howpublished="\url{https://reference.wolfram.com/language/ref/StringTemplate.html}", note=[Accessed: 11-May-2025 ]}

BibLaTeX

@online{reference.wolfram_2025_stringtemplate, organization={Wolfram Research}, title={StringTemplate}, year={2014}, url={https://reference.wolfram.com/language/ref/StringTemplate.html}, note=[Accessed: 11-May-2025 ]}

✖
@online{reference.wolfram_2025_stringtemplate, organization={Wolfram Research}, title={StringTemplate}, year={2014}, url={https://reference.wolfram.com/language/ref/StringTemplate.html}, note=[Accessed: 11-May-2025 ]}