Template parameters

When editing an existing customer template, it is essential that the property identifiers added to the template file are of the correct form and have an appropriate value associated with them.

For example, to set the property for word rate per minute (a timing property), the identifier WordsPerMinute must be used. No other form of this property is permissible. Moreover, its value must be of a certain data type, in this case an integer number.

The following table lists each of the available properties along with their expected data types and typical values:

Property Identifier	Function	Data type	Typical value
AllowOutOfSequence	timing rules	Boolean	TRUE or FALSE
AllowOverlaps	timing rules	Boolean	TRUE or FALSE
BaseLine	safe area	String	Four integers separated by spaces that define the left top right bottom dimensions of the baseline, e.g. 40 -1 40 50. Use -1 to indicate a disabled value.
CharsPerMinute	timing rules	Integer	1 or greater
CharsPerSecond	timing rules	Integer	1 or greater
CharSpacing	default font	Integer	-2, -1, 0, 1, 2
CheckerName	GSI	String
ColourBack	background colour	String or hex number	Black, Red, Blue, Yellow, Cyan, Magenta, Green, White OR a six-digit hex number corresponding to the (BlueGreenRed) values of the required colour, e.g. A88568
ColourFore	foreground colour	String or hex number	Black, Red, Blue, Yellow, Cyan, Magenta, Green, White OR a six-digit hex number corresponding to the (BlueGreenRed) values of the required colour, e.g. A88568
ColourLocked	file locking	Boolean	TRUE or FALSE
ColourNewLine	punctuation	Boolean	TRUE or FALSE
ContactDetails	GSI	String
ContinuationEnabled	punctuation	Boolean	TRUE or FALSE
DotsAfterComma	punctuation	Boolean	TRUE or FALSE
DotsOnSecondSubtitle	punctuation	Boolean	TRUE or FALSE
EBUExportArabicNumbers	export option	Boolean	TRUE or FALSE
EBUExportFont
EBUExportReverseOrder	export option	Boolean	TRUE or FALSE
EBUExportZeroSubtitleAsNormal	export option	Boolean	TRUE or FALSE
EBUExportZeroSubtitleGroups	export option	Boolean	TRUE or FALSE
EditorsName	GSI	String
EnableBlankSubtitles	subtitle size	Boolean	TRUE or FALSE
EnableOpenCaption	personality	Boolean	TRUE or FALSE (Teletext personality only)
EpisodeTitle	GSI	String
ExclusionMinimumGap	timing rules	Integer	0 or greater
ExclusionMinimumGapEnable	timing rules	Boolean	TRUE or FALSE
FileLocked	file locking	Boolean	TRUE or FALSE
FontBold	default font	Boolean	TRUE or FALSE
FontItalic	default font	Boolean	TRUE or FALSE
FontName	default font	String	The name of a valid Windows font, e.g. Times New Roman
FontSize	default font	Integer	A valid point size for the chosen font
FontUnderline	default font	Boolean	TRUE or FALSE
GrowDown	subtitle size	Boolean	TRUE or FALSE
HardOfHearing	file language	Boolean	TRUE or FALSE
HorizontalPosition	default position	Float	A floating point number in the range 0.000-1.000 where 0 is left position, 0.5 is centre and 1.0 is right
IncludeSpaces	timing rules	Boolean	TRUE or FALSE
Justify	default position	Float	A floating point number in the range 0.000-1.000 where 0 is left justify, 0.5 is centre and 1.0 is right
Language	file language	String	The name of a supported language, e.g. English
Language2	file language	String	The name of a supported language, e.g. English
LineSpacing	default font	Integer	A number between -20 and 20
LockOnClose	file locking	Boolean	TRUE or FALSE
LockPositionJustify	position	Boolean	TRUE or FALSE
MagnetismEnable	timing rules	Boolean	TRUE or FALSE
MaxAlignmentDelay	timing rules	Integer	0 or greater
MaxAlignmentEnableDelay	timing rules	Boolean	TRUE or FALSE
MaximumDuration	timing rules	Integer	0 or greater
MaximumDurationEnable	timing rules	Boolean	TRUE or FALSE
MaximumRowCount	subtitle size	Integer	1 - 20 (0 to disable)
MaximumRowLength	subtitle size	Integer	1 or greater (0 to disable)
MaxCharsPerMinute	timing rules	Integer	An integer value >= CharsPerMinute
MaxCharsPerSecond	timing rules	Integer	An integer value >= CharsPerSecond
MaxWordsPerMinute	timing rules	Integer	An integer value >= WordsPerMinute
MinimumDuration	timing rules	Integer	0 or greater
MinimumDurationEnable	timing rules	Boolean	TRUE or FALSE
MinimumGap	timing rules	Integer	0 or greater
MinimumGapEnable	timing rules	Boolean	TRUE or FALSE
Personality	personality	String	Teletext, Open Caption, Closed Caption
PositionLocked	file locking	Boolean	TRUE or FALSE
ProgrammeTitle	GSI	String
ProofReader	GSI	String
Publisher	GSI	String
PunctuationSpace	punctuation	String	A string of symbol:number pairs where the number is either 1 (force space before), 2 (force space after) or 3 (both). Omitted symbols are set to ignore. e.g. :1%1,2;3
ReferenceCode	GSI	String
RevisionNumber	GSI	String
SafeArea	safe area	String	Four integers separated by spaces that define the left top right bottom dimensions, e.g. 56 32 56 32
SavedSubtitleCursorPosition		Integer
ScreenType	personality	String	PAL, PAL Wide, NTSC Drop, NTSC Drop Wide, NTSC NonDrop, NTSC NonDrop Wide, HD1080I/23, HD720P/24, HD1080PsF/30nd, HD1080PsF/60d etc.
SentencePunctuation	punctuation	String	A string containing one or more of the following symbols: .):
ShotchangeZoneWidth	timing rules	Integer	0 or greater
SpotRateEnable	timing rules	Boolean	TRUE or FALSE (enable/disable default subtitle display rate)
SpotRatePercentage	timing rules	Integer	1 or greater
SubtitleLocked	file locking	Boolean	TRUE or FALSE
SubtitleZero	GSI	String	Subtitle zero text, used when exporting to PAC format. Note that formatting characters (e.g. CR/LF) are stored in an encoded form. It's not recommended to edit this string manually.
TeletextAddonInTiming	Teletext options	Boolean	TRUE or FALSE
TeletextForceEndBox	Teletext options	Boolean	TRUE or FALSE
TeletextForceSingleHeightCode	Teletext options	Boolean	TRUE or FALSE
TeletextNoAddons	Teletext options	Boolean	TRUE or FALSE
TeletextNoPacket26	Teletext options	Boolean	TRUE or FALSE
TeletextSingleHeight	Teletext options	Boolean	TRUE or FALSE
TextEffect	background style	String	Surround-3-Square Shadow-1-South East-Thin Block-Solid-Box etc.
TextSpacingRules	subtitle size	String	A string containing 0 or more of the following letters: S (allow extra spaces at start of line) E (allow extra spaces at end of line) I (allow extra spaces between words) N (allow blank rows)
TextSplitSentence	Text Splitting	Boolean	TRUE of FALSE
ThreeDotsInSecondPart	punctuation	Boolean	TRUE or FALSE
TimecodeLocked	file locking	Boolean	TRUE or FALSE
TimezoneActiveBeforeShotChange	timing rules	Boolean	TRUE or FALSE
TranslatedEpisode	GSI	String
TranslatedProgramme	GSI	String
TranslatorContact	GSI	String
TranslatorName	GSI	String
UseDash	punctuation	Boolean	TRUE or FALSE
VerticalPosition	default position	Float	A floating point number in the range 0.000-1.000 where 0 is bottom position, 0.5 is middle and 1.0 is top
WordsPerMinute	timing rules	Integer	1 or greater
ZoneFollowShotchange	timing rules	Integer	0 or greater
ZoneFollowShotchangeEnable	timing rules	Boolean	TRUE or FALSE
ZonePrecedeShotchange	timing rules	Integer	0 or greater
ZonePrecedeShotchangeEnable	timing rules	Boolean	TRUE or FALSE

Template parameters

See Also: