Using the Document Generator

To start the Document Generator, you have to add a new document set by selecting  File    New    Document Set  in the top menu. You have to enter a name, an optional description as well as optional tags.

To define entities in the folder hierarchy of a document set, use  File    Change Entities  in the top menu of the document set or its subfolders. You may specify the name and the value of a new entity or change an existing one. If the name field remains empty, the entity will be re­moved. You may also change the character set in which the entities of the new document set are coded using  File    Change    Character Set .

Figure 19: Defining entities

After you have generated the templates on your local computer and have them uploaded to the document set (don’t forget to enter ‘Document Generator Template’ (text/x-bscw-template) as MIME type), you may use   Eval Parameters  to set the evaluation parameters of the tem­plates. This lets you specify a template, into which the entities of the present template are to be inserted, and the name of a document which is to be generated from the present template. Internally the evaluation parameters are treated as entities with the name @template@ and @document@, respectively.

Figure 20: Defining the evaluation parameters

To view all entities of the document set, of one of its folders or of a template, use  File    Show Entities  or   Show Entities . If an entity appears in italics it is inherited via the folder hierar­chy.

Figure 21: Displaying entities

The evaluation process may be started for the whole document set, for one of its folders, a set of selected templates or single templates using  File    Evaluate ,  Edit    Evaluate  or   Evaluate , respectively. Documents that have already been generated in prior evaluations will be re­placed.

For a backup of a document set you may save all entities with  File    Export Entities . This gen­erates a file which you may save on your local computer. The file has the following syntax where ‘object path’ designates the path name of the object (folder, template) whose entities are stored within the document set.

'<object-path>' = {

  '<name_of_entity>' = '<value-of-entity>'

  ...

}

...

With   Import Entities  you may import such entity backup files.