Template Builder User Guide

Version 1.0 | Published August 10, 2017 ©

The Template Builder Window

The Template Builder window is located to the left in the window and is where all the customization of the template is done.

Settings

At the top of the Template Builder Window a Settings drop down list is available, which allows for the following template settings:Limit With Choice Option

Duration

The duration setting can be used to specify the duration of the item. A default value is used when unspecified. Minimum and maximum duration values may also be specified. If these are set to the same number the item will get a fixed duration.

images/download/attachments/30116875/image2017-5-10_9_22_40.png

Track

Setting a Name in the track settings allows for grouping of graphics in the timeline editor, see Track settings displayed in the timeline editor. The Index sets the position of the group in the timeline editor, where 0 is the lowest position.

Warning: Make sure to use the same index for the same name in all modified templates

images/download/attachments/30116875/image2017-5-10_10_8_39.png

Track settings displayed in the timeline editor

images/download/attachments/30116875/image2017-5-24_13_52_9.png

Title generation

The title generation setting allows for auto-generation of the title. The title can for example be text with a placeholder for a Field ID. The placeholder is the {field ID path}. An example is shown below:

images/download/attachments/30116875/image2017-5-26_14_2_26.png

Field Tree

Each line in the Field Tree displays the ID and the label of a field in the template. It also contains an icon indicating the type of the field.

images/download/attachments/30116875/image2017-5-9_16_12_1.png

The Field listing can be rearranged by drag-and-drop within the Field list.

Right clicking a field a list of choices appear. From here fields can be added/removed, HTML panel can be added, Field ID can be changed and the selected field can be deleted.

The Fill In Form will always immediately update upon any change.

Info: Only fields created in Template Builder can be deleted and given a new ID.

images/download/attachments/30116875/image2017-4-11_12_53_35.png

Each field line can be customized using a set of properties which are displayed in the bottom half of the Template Builder window. Mark the desired Field in the top window, and the following properties can be set:

images/download/attachments/30116875/image2017-4-11_14_24_34.png

Label

Specifies the label of the field in the Fill In Form.

Tip text

A tool tip text can be entered to give more information about the field.

Read only

Selecting the Read-only check box will keep the field visible, but greyed out in the Fill In Form.

Hidden

Selecting the Hidden check box will hide the field in the Fill In Form.

Type

The type of content allowed in the field in the Fill In Form are set using the drop down list under Type. Depending on the type selected different choices are available:

Type

Icon

Description

Empty

images/download/thumbnails/30116875/image2017-4-10_12_24_33.png

Will make the field unavailable. Typically used as a contained for other fields.

Plain text

images/download/attachments/30116875/image2017-4-10_12_25_0.png

The field is a text field.

Max length: Set the number of maximum characters in the field.

Limit with choice.

Normalized text

images/download/attachments/30116875/image2017-4-10_12_26_41.png

Normalized text.

Max length: Set the number of maximum characters in the field.

Limit with choice.

Formatted text

images/download/attachments/30116875/image2017-4-10_12_26_41.png

A text that allows formatting.

Max length: Set the number of maximum characters in the field.

Single-line: Check this box to specify that the rich-text editor should only allow one line of text.

Limit with choice.

Boolean

images/download/attachments/30116875/image2017-4-10_13_33_52.png

Creates a check box which have two states; true and false.

Limit with choice .

Integer

images/download/attachments/30116875/image2017-4-10_14_24_13.png

The field is an integer field.

Minimum: Set the minimum value allowed.

Maximum: Set the maximum value allowed.

Limit with choice .

Decimal

images/download/attachments/30116875/image2017-4-10_14_24_130.png

The field allows decimal numbers.

Minimum: Set the minimum value allowed.

Maximum: Set the maximum value allowed.

Limit with choice .

Date and time

images/download/attachments/30116875/image2017-4-11_10_42_59.png

Use the Date Chooser in the Fill In Form to select date and time in this field.

Limit with choice .

Two numbers (duplet)

images/download/thumbnails/30116875/image2017-4-11_10_53_53.png

The field allows two numbers (decimal numbers are allowed).

Minimum: Set the minimum value allowed for both numbers.

Maximum: Set the maximum value allowed for both numbers.

Limit with choice .

Three numbers (triplet)

images/download/thumbnails/30116875/image2017-4-11_11_1_40.png

The field allows three numbers (decimal numbers are allowed).

Minimum: Set the minimum value allowed for all three numbers.

Maximum: Set the maximum value allowed for all three numbers.

Limit with choice .

Image

images/download/attachments/30116875/image2017-4-11_11_9_21.png

Will make the field available for an image.

Limit with choice .

Video

images/download/thumbnails/30116875/image2017-4-11_12_18_2.png

Will make the field available for a video.

Limit with choice .

Font

images/download/attachments/30116875/image2017-4-11_12_21_19.png

Will make the field available for a font.

Limit with choice .

Geometry

images/download/thumbnails/30116875/image2017-4-11_12_22_42.png

Will make the field available for a geometry.

Limit with choice .

Material

images/download/thumbnails/30116875/image2017-4-11_12_24_34.png

Will make the field available for a material.

Limit with choice .

Map

images/download/attachments/30116875/image2017-4-11_12_27_23.png

Will make the field available to present and edit a map.

Limit with choice .

Custom

images/download/thumbnails/30116875/image2017-4-11_12_35_10.png

Using the custom type the media- and XSD- type can be freely specified.

Limit with choice .

List

images/download/thumbnails/30116875/image2017-4-11_12_42_45.png

There is not support for making lists in Template Builder, but lists can be available in the template from Template Wizard.

Note: The user must be aware of the control plugins that have been exposed by the scene designer in Viz Artist.