home *** CD-ROM | disk | FTP | other *** search
/ Fish 'n' More 2 / fishmore-publicdomainlibraryvol.ii1991xetec.iso / fish / applications / turbotitle / turbotitle.doc < prev    next >
Text File  |  1990-12-30  |  20KB  |  462 lines
  1.                                 TurboTitle
  2.                                    v0.71
  3.                                     By:
  4.                                Robert Jenks
  5.  
  6.  
  7.      TurboTitle was created for the purpose of subtitling Japanese
  8. Animation films and to create a standard Amiga subtitle format. Although
  9. created to subtitle Japanese Animation this program is perfectly suited
  10. for subtitling any foreign film. TurboTitle version 0.71 is realeased as
  11. a shareware product and can be distributed as such in it's original 
  12. un-modified form.
  13.  
  14. The following files MUST acompany TurboTitle:
  15.  
  16. Root dir:
  17.     TurboTitle                              :    The main program.
  18.     TurboTitle.DOC                          :    This File.
  19.     Libs <directory>
  20.         req.library                         :    requester library
  21.     ForProgrammmers <directory>             :    requester docs, etc...
  22.         reqbase.i
  23.         reqbase.h
  24.         read.me
  25.         req.doc
  26.  
  27. All other files are optional, but suggested.        
  28.  
  29.      Please spread this program around as much as posible! The more people
  30. that use it, the more scripts that are publicly available.
  31.  
  32.      The Shareware registration for this program is $15 and includes the
  33. following services:
  34.  
  35.      - If you send me a disk with a script(s) (timed or un-timed) that
  36.        you or a friend typed, I will send you the disk(s) back with the
  37.        latest version of TurboTitle and as many scripts as I can fit on
  38.        the disk. (as of 12/10/90 I have approx. 100 scripts)
  39.  
  40.      - When my BBS goes on-line you will be granted Un-Limited script
  41.        download time. And will also be able to download the latest 
  42.        version of TurboTitle and many other fine shareware products.
  43.  
  44.      Please send you registration fee of $15 and your Name, Comapny,
  45. Address, and Phone to:
  46.             
  47.                               Robert Jenks
  48.                               1322 20th Court
  49.                               Oceano, Ca 93445
  50.  
  51.  
  52. You can reach me for technical support on:
  53.             
  54.               BIX as 'rjenks'.
  55.               Valley of the Wind BBS as 'Robert Jenks'
  56.  
  57. ------------------------------------------------------------------------
  58. User Manual
  59. ========================================================================
  60.  
  61.      The folowing is an abridged version of the final documentation that
  62. will be released with version 1.0.  This is written for users familiar
  63. with basic Subtitling and CLI experience.
  64.  
  65. Steps to install TurboTitle on a Workbench disk:
  66.  
  67.     1. Load up workbench 1.3 or higher.
  68.  
  69.     2. Make a copy of your workbench 1.3 or 2.0 disk 1.
  70.  
  71.     3. Modify the contents to resemble the following:
  72.  
  73.     ---------------------------------------------------------------
  74.      System (dir)
  75.             .info                            CLI
  76.             DiskCopy                         FastMemFirst
  77.             Format                           
  78.      c (dir)
  79.             AddBuffers                       Assign
  80.             Avail                            Binddrivers
  81.             Break                            CD
  82.             Copy                             Delete
  83.             Dir                              DiskChange
  84.             Echo                             Ed
  85.             EndCLI                           Execute
  86.             Failat                           FF
  87.             Info                             Install
  88.             Join                             LoadWB
  89.             Makedir                          More
  90.             Mount                            NewShell
  91.             Path                             Prompt
  92.             Quit                             Relabel
  93.             Rename                           Resident
  94.             Run                              SetPatch
  95.             Type                             
  96.      Spell (dir)
  97.             AllWords.Spell                   CommonWords.Spell
  98.      Prefs (dir)
  99.             .info                            Preferences
  100.             Preferences.info                 
  101.      l (dir)
  102.             Aux-Handler                      Disk-Validator
  103.             Newcon-Handler                   Pipe-Handler
  104.             Port-Handler                     Ram-Handler
  105.             Shell-Seg                        Speak-Handler
  106.      devs (dir)
  107.           keymaps (dir)
  108.                  usa1                             
  109.           printers (dir)
  110.                  generic                          
  111.           clipboards (dir)
  112.             MountList                        ramdrive.device
  113.             system-configuration             
  114.      s (dir)
  115.             Shell-Startup                    Startup-Sequence
  116.      fonts (dir)
  117.           helvetica (dir)
  118.                  .info                            29.4C
  119.                  36.4C                            
  120.             helvetica.font                   
  121.      libs (dir)
  122.             diskfont.library                 icon.library
  123.             info.library                     req.library
  124.             version.library                  
  125.      T (dir)
  126.        .info                            ColorText
  127.        ColorText.info                   Disk.info
  128.        Prefs.info                       Shell
  129.        Shell.info                       TurboTitle
  130.        TurboTitle.DOC                   TurboTitle.DOC.info
  131.        TurboTitle.info                  
  132.     ---------------------------------------------------------------
  133.  
  134.     4. Use a standard text-editor such as ED, CED, etc... to add these
  135. lines to your s:startup-sequence file:
  136.  
  137.     -----------------------S:Startup-Sequence----------------------
  138.  
  139.     assign TT: df0: ;The location of TurboTitle executable files.
  140.     assign TTS: ram: ;The location of script files.
  141.     assign SPELL: df0:spell ;Included for future versions.
  142.  
  143.     ---------------------------------------------------------------
  144.  
  145.     5. Boot off this disk with you gen-lock connected to a VCR, LD and 
  146. a TV set (Not a monitor!) Then adjust your workbench preferences so that
  147. the Worbench screen is centered on your screen (LEFT, RIGHT, TOP, and 
  148. BOTTOM!) Make sure you have a video signal going into your gen-lock before
  149. doing this though and use a TV set not a Monitor so that you can be sure
  150. that the screen will be fully visible on any standard TV set.
  151.  
  152.     6. TurboTitle can be executed from either Workbench 1.3+ or from 
  153. CLI or Shell windows.  From workbench double-click on the TurboTitle
  154. icon or from CLI type 'run TT:TurboTitle'.
  155.  
  156.  
  157. ------------------------------------------------------------------------
  158. Steps for subtitling a film:
  159. ========================================================================
  160.  
  161.     1. Type or convert an ascii text file to the TurboTitle ASCII format.
  162. (described latter under the FILE/LOAD ASCII menu function). This can be 
  163. accomplished in any standard ascii text editor such as: Ed, CED, Memacs,
  164. TxEd, etc... WordPerfect users must save the files as standard ascii 
  165. format, NOT WP format!
  166.  
  167.     2. If you have ColorText run it now. Alternatly you may wish to run
  168. it in your startup-sequence.
  169.  
  170.     3. Run TurboTitle in Workbench 1.3 or higher. You can do this by
  171. double-clicking on the Icon in workbench or by typing in a CLI or shell
  172. window; 'run TT:TurboTitle'
  173.  
  174.     4. Load the ASCII script with the FILE/LOAD ASCII menu option.
  175.  
  176.     5. Then save the file with the FILE/SAVE menu option. Make sure you
  177. change the name to .TTS though.
  178.  
  179.     6. Use the PREFS/FONT/VIEW to load your prefered subtitling font.
  180. (Helvetica 29 & 36 are supplied, but need ColorText to use.) 
  181.  
  182.     7. Then use the SCRIPT/VIEW menu function to make sure all of the
  183. pages are 1, 2, or 3 lines long. Not 4 lines! Make a note of all the
  184. pages than need correcting.
  185.  
  186.     8. Save the script with the FILE/SAVE menu function.
  187.  
  188.     9. FILE/QUIT TurboTitle. Then use your text-editor to edit the .TTS
  189. script file. Make the needed changes to the script from step 5.
  190.  
  191.     10. Repeat steps 6 thru 9 until the script is the way you want it.
  192.  
  193.     11. Re-Load TurboTitle and load the script. Then use the SCRIPT/TIME
  194. menu funtion to time the file. Remember: It is not critical to time it
  195. perfectly, just try to be consistantly off. Then you can use the 
  196. SHIFT/TIME SHIFT/ALL function to adjust the script to your sync point.
  197. I find that I usualy am off by about 2/10 of a second on my initial
  198. timing run.
  199.  
  200.     12. Then I ususaly will use the SCRIPT/PLAY function and record the
  201. results to a temporary tape. Then manualy adjust the timing on any lines
  202. that are off by wathing the temporary tape and editing at the same time.
  203.  
  204.     13. Repeat any of the steps above as necessary and be sure to save
  205. your work as you go. It is also handy to save to a different file name
  206. often so you can always revert back to an older version. (read the
  207. description of the FILE/LOAD SCRIPT function for a description of file
  208. standard script file naming) 
  209.  
  210.  
  211.  
  212. ------------------------------------------------------------------------
  213. Program Function:
  214. ========================================================================
  215.  
  216.      Below is a brief summary of the program functions. Pending the 
  217. release of Version 1.0 all of the Menu fuctions will be available,
  218. but only enabled functions are completed so far. Please notify me if
  219. you expirience any problem in using my program or any bugs in the 
  220. software. I would also be glad to hear any suggestions or coments about
  221. the program. Remember: Support the developer and he will suport you!
  222.  
  223. ------------------------------------------------------------------------
  224. Menu Comands:
  225.  
  226.   FILE menu-------------------------------------------------------------
  227.  
  228.      LOAD SCRIPT - This Option loads script files in in the following
  229.            format: (every line in the file must look like this)
  230.            
  231.            H:MM:SS.DD,H:MM:SS.DD,NAME QUOTE
  232.         
  233.            H     = Hours (range 0-9)
  234.            MM    = Minutes (range 0-59)
  235.            SS    = Seconds (range 0-59)
  236.            DD    = Hundredth of a second (range 0-99)
  237.            NAME  = Name of the Character who is speaking
  238.                    (Cannot contain any spaces)
  239.                    (if no name is used put a tilde(~) for the NAME)
  240.            QUOTE = What the character is saying
  241.  
  242.            The Puctuation must be exact. Any misused or misplaced
  243.            punctuation will cause an error. Be sure to use a .(period)
  244.            between the SS and the DD and one space between the NAME and
  245.            the QUOTE. 
  246.  
  247.            The first time is used for the Starting time and the seccond
  248.            is for the ending. The NAME will not be printed when playing
  249.            the script, but will only be used for ease in timing.
  250.  
  251.            
  252.            The standard file name format for TurboTitle scripts is:
  253.  
  254.            Name[side][-version].TTS
  255.  
  256.            [side] is a letter representing the side of the media source
  257.            and is only used when the media being subtitled is a laser disk
  258.            or other source with more than one side.  The first side should
  259.            be 'A' the second 'B' and so forth.  
  260.  
  261.            [-version] is a numeral representing the timing version of the
  262.            script. The untimed version should be '-0', and the final timing
  263.            should be the highest version number.
  264.  
  265.            An example would be: 
  266.  
  267.            VenusWarsA-0.TTS
  268.  
  269.            Venus Wars is the movie, the side is A, it is Un-Timed and the
  270.            script format is TTS (standard TurboTitle format). 
  271.  
  272.            Please use this naming convention for all of your scripts for
  273.            standardization.
  274.  
  275.      LOAD TJP SCRIPT - This option was included for compatability for  
  276.            with another subtitling program I have, until now, been using.
  277.            It will convert all timing for you and should run with the 
  278.            same or better acuracy.
  279.  
  280.            Scripts loaded with this option are not guaranteed to run on
  281.            time due to inherent flaws in the TJP-Subtitling program.  
  282.          
  283.            (The TJP program was good, but it's main flaw was that it was
  284.            written in BASIC. BASIC was not able to keep up with the titles
  285.            on many of the films I subtitled with it and so they ran behind.
  286.            Sometimes just time-shifting them will correct the problem, but
  287.            not always.)
  288.  
  289.            There is no standard file extension for this, but I would 
  290.            suggest that you use .TJP
  291.  
  292.      LOAD ASCII SCRIPT - This option is usefull when loading a script for
  293.            the first time. It is suggested that all scripts be typed in
  294.            the following format and read in with this option.
  295.  
  296.            NAME QUOTE
  297.  
  298.            This is exactly like the TTS format except that there are no
  299.            start and end fields.
  300.  
  301.            Files typed this way should be named in the folowing format:
  302.  
  303.            Name[side].ASCII
  304.  
  305.            [side] is a letter representing the side of the media source
  306.            and is only used when the media being subtitled is a laser disk
  307.            or other source with more than one side.  The first side should
  308.            be 'A' the second 'B' and so forth.  LOAD ASCII SCRIPT looks for
  309.            files named *.ASCII when loading scrips. Please use this
  310.            extension for all scripts in this format.
  311.  
  312.            An example would be:
  313.  
  314.            VenusWarsA.ASCII
  315.  
  316.            The movie is Venus Wars, the side is A, and file type is ASCII. 
  317.  
  318.      SAVE SCRIPT - This option saves the current file as a .TTS file
  319.            to be re-loaded with the LOAD SCRIPT option.
  320.  
  321.      ABOUT - Display's the shareware notice for this program.
  322.  
  323.      QUIT - Self explanitory.  MAKE SURE YOU HAVE SAVED YOUR WORK BEFORE
  324.            USING THIS OPTION. the current version does not have a
  325.            'do you wish to save your work?' safety reqester. (YET!)
  326.  
  327.   EDIT menu-------------------------------------------------------------
  328.  
  329.      The Edit menu will be included in a future version.
  330.  
  331.   BLOCK menu------------------------------------------------------------
  332.  
  333.      The Block menu will be included in a future version.
  334.  
  335.   SCRIPT menu-----------------------------------------------------------
  336.  
  337.      Special Note - it is always a good idea to save before using a 
  338.             SCRIPT menu option. If the program is going to crash it will
  339.             do it here! Also, there will be a short pause after you
  340.             select one of these options. This is normal and sould not
  341.             take more that a few seconds.
  342.  
  343.      VIEW - Displays the entire script so that you can scan for posible
  344.            errors and long pages. A page refers to one line in the text
  345.            file and a set of 1-4 lines on the view-screen. At any time
  346.            you can stop the display by pressing 'q'.
  347.  
  348.            Use this function after every LOAD opion to be sure that the 
  349.            file was loaded corectly and entirely. If there were any
  350.            errors the display will proably be garbled after completion
  351.            of this option. If so, quit without saving and manualy edit
  352.            the script with an editor (e.g. ED) and correct the problem.
  353.  
  354.            A faster way to make sure the file was loaded properly is to
  355.            check the total pages on the status line and compare it to
  356.            the number of lines in the text file.
  357.  
  358.      TIME - This option allows you to edit the start and end timeing on
  359.            all of the pages withing your script in real-time.
  360.  
  361.            With a gen-loc attached to your computer, hook up your source
  362.            media to the input on the gen-loc and cue it to the begining.
  363.            Then hook the output to a monitor or TV to watch the titles.
  364.            Next select the TIME option. It will blank the screen and 
  365.            a reqester will appear.  Find a spot in the beging or before
  366.            the Movie starts and we will call that the Sync point. Re-cue
  367.            the movie to the begining and wait for the sync pont. At the
  368.            exact moment of the sync pont click on the SYNC gadget in the
  369.            requester. You should see a small line of text at the bottom of
  370.            your screen this is the NAME and QUOTE of the next page. When
  371.            the time comes for the first QUOTE to be on the screen press
  372.            the [RETURN] key. this will display the page and print the
  373.            NAME and QUOTE of the page after it on the bottom of the screen.
  374.  
  375.            You can press:
  376.  
  377.            'q' to quit
  378.            [RETURN] to display the next page
  379.            [SPACE BAR] to clear the current page
  380.  
  381.            An important fact to remember is that this option saves the 
  382.            time when you press the RETURN or SPACE BAR key, NOT when
  383.            the title appears. (Although ther should not be much difference)
  384.  
  385.      PLAY - Works exactly like the TIME function but does not display the
  386.            next page and will not alow you to modify the timing.
  387.  
  388.            You can press 'q' to quit 
  389.  
  390.    LIBRARY menu----------------------------------------------------------
  391.  
  392.      The Library menu will be included in a future version.
  393.  
  394.    PREFS menu------------------------------------------------------------
  395.  
  396.      WORKBENCH - Toggle menu funtion that allows you to close workbench
  397.            to free up more memory. MAY allow TurboTitle to run with
  398.            only 512k.
  399.  
  400.      INTERLACE - Toggle menu function that allows you to edit your script
  401.            in interlaced or non-interlaced mode. This option does not 
  402.            effect the VIEW screen.
  403.  
  404.      LINE SPACING - Allows you to adjust the space between the lines on
  405.            the view page.
  406.  
  407.      TEXT MODE - Allows you to set the TEXT mode to either display the
  408.            font on the background color or set a specific background
  409.            color. Usefull if you don't have ColorText.
  410.  
  411.      VIDEO SETUP - Not yet available but when it is finished it will do
  412.            the following:
  413.  
  414.            This option allows TurboTitle to control a profesional laser
  415.            disk player. It is functionally the same as the controlls in
  416.            Amiga Vision (Copyright 1990 Commodore Buisness Machines)
  417.            It's main funtion in TurboTitle is to set frame 0 or time 0 to
  418.            be the sync point. With the correct driver loaded TurboTitle 
  419.            will start the laser disk for you and sync the titles to it.
  420.            This will eliminate the human error factor when setting the
  421.            sync point. There is also the posibility that TurboTitle might
  422.            get it's timing from the Laser Disk player instead of the Amiga.
  423.            This might even allow you to pause or scan the laser disk and 
  424.            still have the titles appear on time after.
  425.  
  426.            The posibilities of this function have not yet fully been reached
  427.            and I will continue to ponder them until I can get a player to
  428.            test them on. 
  429.  
  430.      FONT - Selects the font you wish to subtitle in. Run ColorText for
  431.            multiple color fonts if using workbench 1.3 or lower.
  432.  
  433.      PALETTE - Modifies the current palette for the VIEW or EDIT screen.
  434.  
  435.      SAVE PREFS - saves your current prefrences.
  436.  
  437.    SHIFT menu------------------------------------------------------------
  438.  
  439.      TIME SHIFT - shifts the start and end times by a specific value.
  440.  
  441.            It is usualy best to time shift by 0:00:00.20 SpeedUp after the
  442.            first use of the TIME option.
  443.  
  444.      AUTO SHUT-OFF - Computes the optimum time a title should be on for 
  445.            and adjusts the End Time accordingly. It uses 2 seconds +
  446.            .1 seconds per chacter in the quote.
  447.  
  448.    OTHER menu------------------------------------------------------------
  449.  
  450.      PRINT SCRIPT - Not yet available, but when it is finished it will do
  451.            the following:
  452.  
  453.            This option will allow you to print to you printer the current
  454.            script. It will allow you to select which fields you want 
  455.            printed.
  456.  
  457.      MARK TAPE - Displays a counter in the upper-left corner of the
  458.            VIEW screen. This is meant to be recorded onto a temporary
  459.            tape to use as a reference. Helpfull if you are subtitling
  460.            off a video tape instead of a laser disk.
  461.  
  462.