GenerateDocument

✖
`GenerateDocument`

✖

GenerateDocument[nb]

generates a document by evaluating all template elements in the notebook nb.

✖

GenerateDocument[nb,args]

generates a document using args to fill template slots.

✖

GenerateDocument[nb,output]

writes the generated document in the output file represented by output.

✖

GenerateDocument[nb,args,output]

uses args to fill template slots and puts the result in output.

Details

The nb can be a notebook in any of the following forms:

	"file" or File["file"]	explicit file name
	CloudObject[…]	a cloud object
	LocalObject[…]	a local object
	NotebookObject[…]	a NotebookObject
	Notebook	a Notebook expression

GenerateDocument[nb] and GenerateDocument[nb,args] return a notebook object.
The output in GenerateDocument can be any of the following:
"file" or File["file"] explicit file name

"!prog" export data to a pipe

CloudObject[…] a cloud object

LocalObject[…] a local object
GenerateDocument typically works with template notebooks, which can usually be created interactively.
If the notebook nb does not contain any template elements, GenerateDocument effectively operates like NotebookEvaluate.
If the notebook nb contains template elements, GenerateDocument will fill template slots from args.
A positional template slot i is filled from the i position of args.
A named template slot "name" is filled from an element with key "name" in an association appearing in the first position of args.
A blank template notebook suitable for use with GenerateDocument can be opened in the front end using CreateNotebook["Template"].

Examples

open allclose all

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

Generate a notebook by evaluating template elements in a template notebook:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-hj0p16

Out[1]=1

The template notebook:

The generated document:

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

Template elements can iterate over lists of data to create repeating blocks:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-83zebs

Out[1]=1

Use the data in a template notebook:

In[2]:=2

✖

https://wolfram.com/xid/0h2okkyjyq-5f725t

Out[2]=2

The Repeating Block element in the template notebook:

The result of evaluating the repeating block element:

Generalizations & Extensions (5)Generalized and extended use cases

Generated documents may contain anything notebooks may contain, including interactive elements:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-h7oqmd

Out[1]=1

A copy of an interactive section of the generated report:

In[2]:=2

✖

https://wolfram.com/xid/0h2okkyjyq-djnkpn

Out[2]=2

GenerateDocument can take the input template from a cloud object:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-8oq5i0

Out[1]=1

In[2]:=2

✖

https://wolfram.com/xid/0h2okkyjyq-9hb7ty

Out[2]=2

GenerateDocument can generate an output document deployed as a cloud object:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-nxs0c6

Out[1]=1

Generate a document as a cloud object with Permissions and MetaInformation:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-hefv1j

Deploy a template as a cloud object:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-i12wzq

Generate a document locally using the deployed template; deploy the result as a cloud object:

In[2]:=2

✖

https://wolfram.com/xid/0h2okkyjyq-p9yla0

Out[2]=2

Applications (1)Sample problems that can be solved with this function

Use a template to programmatically produce individualized outputs, as in a mail merge:

In[1]:=1

✖

https://wolfram.com/xid/0h2okkyjyq-cvr9ip

Out[1]=1

One of the generated documents:

In[2]:=2

✖

https://wolfram.com/xid/0h2okkyjyq-j35hpj

Out[2]=2

Top