FileTemplate

✖
`FileTemplate`

✖

FileTemplate["file"]

yields a TemplateObject expression that represents a file template to be applied using functions like TemplateApply.

✖

FileTemplate[src]

uses File[…], URL[…], or CloudObject[…] as the specification for the file location.

✖

FileTemplate[form,args]

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

Details and Options

FileTemplate will infer from the extension whether to interpret the contents as a StringTemplate, XMLTemplate, or NotebookTemplate.
FileTemplate[CloudObject[…]] will infer the template type based on the contents of the cloud object.
FileTemplate[File["path"]] and FileTemplate["path"] are effectively equivalent.
The following special forms can be used in the file for FileTemplate:
`` TemplateSlot[]

`n` TemplateSlot[n]

`name` TemplateSlot["name"]

<*expr*> TemplateExpression[expr]
FileTemplate has the following options:

	CombinerFunction	Automatic	function to apply to combine pieces before returning a result
	InsertionFunction	Automatic	function to apply before inserting expressions
	Path	$TemplatePath	search for templates on the specified path

Examples

open allclose all

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

Loading a template file from disk:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-qf4tcj

Out[1]=1

Applying to a FileTemplate:

In[2]:=2

✖

https://wolfram.com/xid/0b8cw8waea-j5xpp2

Out[2]=2

Saving a template to disk:

In[3]:=3

✖

https://wolfram.com/xid/0b8cw8waea-1insba

Out[3]=3

The type of template to use is by default determined by the extension:

In[4]:=4

✖

https://wolfram.com/xid/0b8cw8waea-3jstzd

Out[4]=4

Evaluate $TemplatePath to see where FileTemplate is searching for templates:

In[5]:=5

✖

https://wolfram.com/xid/0b8cw8waea-sx4281

Out[5]=5

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

File is fully supported:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-f48c8p

Out[1]=1

Templates can be hosted in the Wolfram Cloud:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-zn99tp

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0b8cw8waea-binn8z

Out[2]=2

URL can be used to fetch templates:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-ehr44g

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0b8cw8waea-uwsajo

Out[2]=2

In[3]:=3

✖

https://wolfram.com/xid/0b8cw8waea-se9tn7

Out[3]=3

URL can be directly used by TemplateApply:

In[4]:=4

✖

https://wolfram.com/xid/0b8cw8waea-6etf82

Out[4]=4

Options (2)Common values & functionality for each option

InsertionFunction (1)

Specify a function to convert arguments before they are inserted:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-xldpc6

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0b8cw8waea-dnzkqo

Out[2]=2

You can use a string to specify an export format:

In[3]:=3

✖

https://wolfram.com/xid/0b8cw8waea-p2w19u

Out[3]=3

CombinerFunction (1)

Specify a different way to combine parts of templates:

In[1]:=1

✖

https://wolfram.com/xid/0b8cw8waea-i8d0rz

Out[1]=1

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

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/0b8cw8waea-kwsq8a

Out[1]=1

Top