The template editor is displayed when you click on when showing the parameters of a "target". You can see the template script on the left and GUI elements to create groups, bands and merge fields.

On the right parameters of bands will be displayed, when you select a band. Please note that the template is not being automatically saved. Changes will only be saved when you press "Save". You can only edit the text when the check "Edit" was enabled.

Note: To insert a new paragraph after a group, please press the INSERT key when a group is selected.

 

A) Simple PDF export template shown in the screenshot above.

1) Fields (Variables)

Here you see two fields, which will insert the text provided in the parameters as document title and document subtitle.

Other variables can be read from the custom variables XML file. There you can enter a field for the author or other information.

The XML file which defines custom variables can be freely edited. In this example the variable "creator" is added:

<?xml version="1.0" encoding="utf-8"?>
<variables>
  <var name="creator"><![CDATA[documentARRAY by WPCubed GmbH]]></var>
</variables>

 

2) Create Groups and other elements

Groups are used to export several pages (or only their titles and URLs) one after each other. Usually all pages included by the outline are exported, but it is also possible to set a condition to ignore certain pages by condition or the nesting level in the outline.

The template uses two groups, one to create and index and one to add the text of the pages.

 

a) Groups are created by selecting a type, such as "INDEX" and a click on >Group.  

Click on >Band to insert a header, data or footer band. The enclosed text in the respective band will be used at the start, for each loop or and the end of the process performed on the group.

 

b) To add a variables select or enter a variable name and click on >Variable.

Please note that variables can used in some parameters using the syntax %VARNAME%. When doing HTML export, variables can be used in HTML templates using the HTML syntax <!--%VARNAME--%--> or JavaScrip syntax:  /*%VARNAME%*/

 

c) These band elements create groups used by the XML based HTML export. We cover this feature later:

 

 

2.1) Group INDEX (Creates Table of Contents)

 

The group will be executed for all items in the outline until all items have been processed.

The group INDEX is used to create the index of a document. In the example above it uses a variable "NEW_PAGE_HERE" which will create a page break when accessed. The variable "TITLE" reads the caption of the outline item.

 

Parameters:

Condition

The condition is checked against the symbols defined under parameters. The group is processed, if a name is listed as symbol. If a name preceded with an exclamation sign "!", the group is not processed if the name was listed as symbol parameter.

 

2.2) Group PAGES

 

The group will be executed for all items in the outline until all items have been processed. For each item the referenced page will be loaded.

Parameters:

Condition - see above

WebScript - used for XML scripts which convert XML data to text. This feature is used to convert automatically created data to documentation. We used it to processed XMLDoc created from source code comments. You can ignore this feature if you do not work with source code documentation.

Condition for Pages - list of symbols used to pre process the text on the pages. This makes it possible to adapt the text of a page, i.e. reduce it to an excerpt or only use text written in a certain language.