Subtitle Horse Set Up Documentation

download and unzip the files. copy the folder subtitlehorse in your webdirectory and adjust the example.php and the write.php. the tool is embed in the example.php and calls the writeData.php to send the titles.

Flashvars

in the example.php use FlashVars to set the videoUrl of your flv, pass through a variable and/or adjust the default settings of the tool.


"FlashVars", "videoUrl=video.flv&showEditorButtons=true&showStyleOptions=false..."

Overview of Flashvars:

Var	value	default value
videoUrl	string	none
externTitles*	string	none
showBg	true/false	false
workingWithMs*	true/false	false
calcHideTime	true/false	true
searchKeyFrames	true/false	true
easyView*	true/false	true
showEditorButtons*	true/false	false
hideTimeCorrection*	true/false	true
fontSize	string	18
beforeSaving	confirm/askForInfo/nothing	confirm
saveDestination*	string	writeData.php
saveDestinationNewWindow*	true/false	false
allowEditorButtons*	true/false	true
exportTimeStrValues*	true/false	true
id	string	none
nick*	string	none
language*	string	none
val1*	string	none
val2*	string	none
val3*	string	none

* in the advanced version only

videoUrl: the Url of the flv-file, sth like "http://yoursite.org/video.flv"
externTitles: a subtitle txt or a xml file which should be loaded by default. like "test.dfxp.xml"

FlashVars to adjust the default settings of the tool

showBg: if black background is behind the titles, otherwise white font with a black border will be shown.
workingWithMs: if the time will be shown with or without milliseconds.
calcHideTime: if the hide time should be calculated automatically by the amount of letters of a subtitle. this is just a guide, some translators find it easier to adjust a suggested value instead of creating a new one.
search Keyframes it`s not possible to scrub/search between keyframes of a FLV file. the subtitle creator simulates scrubbing, what is acceptable if your FLV has at least one keyframe every 3 seconds. I recommend to have at least one keyframe per second and set this value to false
easyView: With easyView set to false, the titles menu will be shown
showEditorButtons: if the Editor Buttons (like align, bold and italic) are shown
hideTimeCorrection: if a new title`s show-time-value overlaps with the hide-time-value of the previous title. The hide time will be changed.
fontSize: the font size of the renderetitles
beforeSaving after choosing the save on server button in the menu:
confirm = the user will be asked if he/she wants to save the titles.
askForInfo =the user can change or set the TranslatorName value before saving.
nothing = the titles will be saved without any step in between
saveDestination name of file whicht is called when save on server is clicked
saveDestinationNewWindow true = a new window will be opened when save on server is clicked
allowEditorButtons if you want to let the user activate the showEditorButtons option in the preferences
exportTimeStrValues if the time values will be send to the write.php as clock format (e.g. 00:04:11:9)

FlashVars which will passed through

nick, language, val1, val2, val3 the values of this variables will be send to the writeData.php

click here to see the example.php with this settings and choose "write TT File" from the menu.


"FlashVars", "videoUrl=http://subtitle-horse.org/files/pedro3.flv&workingWithMs=false&showEditorButtons=false&externTitles=files/example.xml&translatorName=myname&id=xy"

Language.xml

all text (advises, menu items, buttons...) are stored in the Language.xml file (only advanced version), which can be found in the horsefiles folder:

<language>

<!-- Buttons -->

 <item name="newTitleBtn">Create</item>
 <item name="selectAllBtn">Select All </item>
 <item name="deselectAllBtn">Deselect All</item>
 <item name="removeBtn">Remove</item>
 <item name="cancelBtn">Cancel</item>
 <item name="glueBtn">Glue Titles</item>
 <item name="changeTitle">Change</item>
 <item name="changeTimesBtn">Change Times</item>
 <item name="okBtn">OK</item>
 <item name="cancelTitle">Cancel</item>
 <item name="saveBtn">Save</item>
 <item name="applyBtn">Apply</item>
 <item name="importBtn">Import</item>
 <item name="frameRateBtn">OK</item>
 <item name="searchBtn">Search</item>

 
<!-- Menu -->

 <item name="menu_titles">Titles</item>
 <item name="menu_import">Import</item>
 
 ...

If you want to replace a term just put another text as item values: e.g.

<item name="newTitleBtn">New Title</item>

instead of

<item name="newTitleBtn">Create</item>

If you want to hide a menu item put e.g.

<item name="menu_remove_all">-hide-</item>

in the menu section (if you hide a main menu item, the following sub item will be turned to a main item).

User Documentation

Also in the horsefiles folder the documentation.html can be found which is called by the menu help->documentation