Home » Developer Area » Programme Replacement Tags

Programme Replacement Tags

When used all tags should be prefixed with dollar($).

For usage examples take a look at any of the dgprint files in the DigiGuide folder.
Tag Reminder command line Printing Markers Description
CategoryNameUpper X X X Category name associated with the programme uppercased
CategoryName X X X Category name associated with the programme
ChannelName X X X Channel associated
ProgrammeNameMarked X X X Programme name marked up with highlight for any expression matched
ProgrammeName X X X Programme name
ProgrammeKeywords X X X Keywords associated with the programme
StartTime X X X Start time of the programme in HH:MM format.
EndTime X X X End time of the programme in HH:MM format.
TimeSummary X X X Description of when the programme is on, e.g. "Starting in...", "51 minutes remaining"
Duration X X X Duration of the programme in words, e.g. "1 hour 15 minutes".
When used in Alert commandline tools it is in minutes, e.g. "115"
DurationMinutes X X X Duration of the programme in minutes, e.g. "125"
Date X X X Date when the programme starts
USStartDateTime X X X Start time in USDate format "mm/dd/yy HH:MM" - used to create dates for use in JavaScript.
USEndDateTime X X X End time in USDate format "mm/dd/yy HH:MM" - used to create dates for use in JavaScript.
LongDate X X X Long date, "Monday 1st January 2001"
DescriptionMarked X X X Description marked with highlights for expression hits
Description X X X Programme description
SingleLineDescription X X X Description as a single line
ChannelAssignment X X X The assigned EPG associated with the channel. Can be text. (e.g TV3 or 175)
VideoPlus X X X Video plus text if external VideoPlus generator installed and programme was able to generate a valid VideoPlus number.
ChannelID X X X Standard channel ID, unique to the channel always. Assigned by database at DigiGuide HQ (e.g. Sky One is always 65).
UniqueChannelID X X X Internally unique channel ID, this is primarily used when a single channel is added into multiple channel groups and so each duplicate channel has its own unique reference.
SSName X X X Smart search name - (deprecated)
FavouriteID X X X Supported in 6.0, will be removed at some point- (deprecated).
ReminderID X X X Supported in 6.0, will be removed at some point- (deprecated).
SmartSearchID X X X Supported in 6.0, will be removed at some point- (deprecated).
ChannelWebAddress X X X URL for the channel in our DigiGuide Library
CategoryID X X X Category ID associated with this channel
TextColour X X X Foreground colour used for this programme - mainly used in the grid
BackgroundColour X X X Background colour used for this programme - mainly used in the grid
ProgrammeID X X X DigiGuide programme ID assigned by database at DigiGuide HQ
Registered X X X UTC date/time of the subscription expiry date
RegisteredBool X X X "y" or "n" if customer's copy of DigiGuide is fully subscribed
EncodedProgrammeName X X X URL encoded programme name
EncodedDescription X X X URL encoded programme description
EncodedCategoryName X X X URL encoded programme category name (e.g. "Scientific Documentary" would appear as "Scientific%20Documentary")
EncodedChannelName X X X URL encoded programme channel name (e.g. "BBC1 South West" would appear as "BBC1%20South%20West")
SeriesNumber X X X Programme series number if one.
EpisodeNumber X X X Programme episode number if one.
EpisodeName X X X Full episode name (e.g. "Pilot Episode")
Certificate X X X Build 1065 above: Programm certificate like "R18" or "PC"
ReminderSummary X     Only available for "Marker Speech" text. Replaces with "just started", "has been on...", or "is on in..."
TimeStart X     Only available as a "Marker Run Program" attribute. Start time of the programme. Allows a variety of formatting options.
TimeStart X     Only available as a "Marker Run Program" attribute. End time of the programme. Allows a variety of formatting options.
DurationSeconds X     Only available as a "Marker Run Program" attribute. Duration of programme in seconds.
MarkerName   X X Used with GetMarkerInfo. The name of the marker
MarkerTypeID   X X Used with GetMarkerInfo. The type ID of the marker
MarkerIcon   X X Used with GetMarkerInfo. Returns info to allow drawing of marker icons
MarkerBlob   X X Used with GetMarkerInfo. Returns info to allow drawing of marker blobs
EncodedUserEmail X   X URL encoded current user email address
EncodedUserFirstName X   X URL encoded current user first name
EncodedUserLastName X   X URL encoded current user last name
UserEmail X   X Current user email address
UserFirstName X   X Current user first name
UserLastName X   X Current user last name
SubscriptionExpiry X   X Current user's subscription expiry date without time (e.g. "Tuesday 21st March 2005")