What are Event Display Strings

When an event, todo list item or contact list item is displayed on any screen its display is based on a configuration item called an Event Display String. You may customize these strings as you wish.

You may modify these strings by hand editing the Event Customization File under the [DISPLAY_STR] section (if this section does not already exist you may add it).

Display strings are weird - there is no two ways about it. They are made up of clear text and tokens.

Clear Text

Clear text is just that - it is text that is not modified in any way by the program.

Whenever clear text is encountered inside an Event Display String it is copied directly from the string to the display.

For example, if you were enter the following display string:

    [DISPLAY_STR]
    gridviews=This is clear text

then every event in the grid views (i.e. Month Grid and Week Grid) would display as 'This is clear text' regardless of the actual data they contained.

    Note: This has no effect on the actual contents of the event. This feature only applies to the way the event is displayed.

Clear Text is the simple case. One might use clear text to specify HTML code to better format the display of an event.

See the examples below for more information.

Tokens

Tokens are the hard part.

A token is a 'stand-in' for the value of any particular field in an event. As each event is displayed tokens are replaced with the value of the field corresponding to that token. This replacement is based on these Recognized Field Names.

Tokens are specified in an Event Display String by surrounding them with squiggly brackets: '{' and '}'. To be recognized as a token the text inside the { } must be one of the Recognized Field Names.

In order to allow the end user to specify optional clear text (for example you may want to show an event's category but only if the category is not empty) there is an additional part to a token. To add an optional prompt to the field surround the clear text and the field token in square brackets: '[' and ']'.

If the square brackets are present the entire text inside the square brackets will not be written to the display if the field is empty. This allows us to create lines such as this:

    [<tr><td>Category: </td><td>{CATEGORY}</td></tr>]

which will include a row in a table only if the value the category field is not empty.

See the examples below for more information.

Some Examples

To display an event's subject:

    Subject: {SUBJECT}

To display and event's subject and its category:

    Subject:  {SUBJECT}<br>
    Category: {CATEGORY}<br>
    Note: notice use of HTML <br> tag as clear text to split the line.

To display and event's subject and its category (but only show category if it is not empty):

     Subject:  {SUBJECT}<br>
    [Category: {CATEGORY}<br>]

Important Note: In the event customization file itself you must make sure that the event display strings are stored on a single line in the file. The above examples show the strings on multiple lines for clarity only.

Details of Event Display Strings

The first four display strings control the display of events on the various calendar views:

The next display string controls the display of dynamically included events:

There are four other display strings that control the display of events in other various parts of the program:

The final three strings apply to email notifications:

There are five undocumented display strings for the Contact List feature which we hope to expose in future versions.