Cue Tracker Report Templates

This document is a rough guide to creating and editing report templates for use in Cue Tracker. If you're just starting out, I would recommend downloading the predefined report templates and using one of them as a guide.

The report templates are basically HTML, but with special tags added in. Some of these are basically variable names that get replaced by the appropriate values, and others control how Cue Tracker loops through cues, takes, etc. Whatever the type, these tags are recognizable by the fact that they start with <! and end with !>. The basic tag types are:

1. Variable fields

These look something like <!project.title!>, and are replaced by their corresponding values (in this case, the title assigned to the current project).

2. Loops

Loops are defined by a pair of tags, such as <!foreach cue!> ... <!end cue!>. You can loop through the following object types:

*Note that in order for these to make sense, the scope of the current loop is important. That is, simply typing <!foreach take!> will loop through all takes of all cues in the project, which is not likely to be useful. Instead, start with a <!foreach cue!> loop, and within it add a <!foreach cue.take!> loop. This will loop through only the takes associated with the current cue. For example:

<!foreach cue!>
   <!foreach cue.take!>
      <p>Take #<!take.number!></p>
   <!end cue.take!>
<!end cue!>

will output something like:

1m1 Main Titles v4

Take #41

Take #42

Take #43

1m2 Foreign Diplomats v9

Take #19

Take #20


3. Conditionals

Conditionals, or if statements, allow you to introduce a bit of logic into a report. They can take one of two different forms:

In its simplest form, the expression that gets evaluated in a conditional (cue.isfirstinreel in the examples above) is simply any Boolean variable—in this case, the "isfirstinreel" property of the current cue—or it can be one of the following statements:

4. Report Type

This tag looks like <!report-type.Spotting Notes!>, and tells Cue Tracker what to call the report type in the page footer. It should always be included at the beginning of a report template.

Object types and properties

Below is a listing of the available properties for each object type. Note that strings, numbers, dates, and timecodes can all be included in variable fields. Booleans can also be included in a variable field, but will be replaced by the HTML codes defined in Cue Tracker Preferences. Relationships to other objects are useful for foreach loops (for to-many relationships) and for getting another object's properties (for to-one relationships), but cannot be used directly in a variable field.