Subtitle Processor
==================
Read documentation for futrher informations.

Bug tracker and feature request tracker is maintained at project pages at SourceForge
(http://sourceforge.net/projects/subtitleproc/).
If you find any bug, please report it there. Bugs that are not reported can't be fixed,
if nobody knows about them. You can also request new features there. Again, your 
requested feature won't be implemented if you keep it for yourself.



Contents
--------
  1. Logging
  2. Archive contents
  3. Addresses
  4. Problems with media files
  5. Help file
  6. Spell checker
  7. Upgrading to newer version
  8. Third-party libraries

1. Logging
----------

  SP comes with logging feature to help debugging. If you encounter a bug in SP,
  please do the following:
  - Run SP using the command SubtitleProcessor.exe -log (parameter -log on command line).
    You can run the included .bat file. This enables the log file (the log file will be
    created in the same folder where is SubtitleProcessor.exe. You must have write
    rights in the folder)
  - Try to reproduce the same bug when loggign is enabled
  - Send the .log file together with the bug description (the more details you send the 
    better is the chance to find the bug) to catsoft@seznam.cz

2. Archive contents
-------------------

  \docs - documentation in CHM format
  \extracted - empty dir for storing SSA extracted files. Do not delete it!
  \lang - available translations to other languages
  \data - the SubtitleFormats.zip file (format definition for subtitle loader)
  \data\script - Ruby scripts
  
3. Addresses
------------

  janklir@gmail.com - send bugs, suggestions

  http://sourceforge.net/projects/subtitleproc
  http://subtitleproc.sourceforge.net/
    
  
4. Problems loading media files
-------------------------------

  - You should have all DirectShow decoders that are needed for your movie
  - SP was built using DirectShow 9 (DX9) so use DX9
  - Do not use various 'Codec packs', use FFDShow instead. It's free, opensource
    and can decode a lot of formats. WWW: http://sourceforge.net/projects/ffdshow
  - If your movie has AC3 audio stream, use AC3Filter 
    (http://sourceforge.net/projects/ffdshow), it's free, high quality  and opensource   
  - For Matroska files, you will need the Matroska pack from http://www.matroska.org,
    or at least the Splitter and the VSFilter for subtitles  
  - If you have problems with clock/frame rate/etc., use ReClock filter
    (http://ogo.nerim.net/reclockfilter/), it's free
  - Do not use stream switcher filters (Morgan Stream Switcher for example),
    SubtitleProcessor has built-in stream switching feature, that might not work
    with these filters
  
5. Help file
------------
Please go to http://subtitleproc.sourceforge.net/
to download the newest version of the help file (in the Downloads section)
You may select the language you prefer.
Place the downloaded file in the "docs" directory and configure the path in
the Settings screen. After that you can press F1 for context-sensitive help.  

6. Spell checker
----------------
Spell checker uses the GNU ASpell engine.

Getting ASpell:
-  Download the full installer package from http://aspell.net/win32 and install it. 
-  Download desired dictionaries from the same page and install them. There are 
   currently 22 languages available. 

Note: The ASpell installer should setup the path to the DLL in registry. If SP 
is unable to load ASpell, you can configure the path to the DLL in the Settings screen, 
Editor tab. If the DLL is not available, the spell checker will be disabled.

7. Upgrading to newer version
-----------------------------
When upgrading to newer version of SP, be careful with the keyboard configuration.
New versions may contain new keyboard actions, that have the same key definitions 
(by default) as some of the existing actions that you have changed. Always check the 
configuration when upgrading to newer version. You may also load the default controls
configuration.

8. Third-party libraries
------------------------
In case yuo don't have the help file, here is the list of third-party components
used in SP.

Delphi components
Jedi VCL 3.31
* http://jvcl.sourceforge.net

DSPack 2.3.4
* http://www.progdigy.com

Virtual Treeview 4.3.1
* http://www.delphi-gems.com

Toolbar 2000 2.1.8
* http://www.jrsoftware.org/tb2k.php

TBX 2.1b
* http://www.g32.org/tbx/index.html

SpTBXLib 1.8.3
* http://club.telepolis.com/silverpointdev/sptbxlib/

TBX Themes
* http://www.rmklever.com/

1.8 Sourcepole's Ruby component
* http://www.sourcepole.com/2006/9/1/embedding-ruby-in-kylix-delphi

TPerlRegEx
* http://www.regular-expressions.info/

TntWare Delphi Unicode Controls 2.3.0
Subtitle Processor uses the latest version of TNT that was available under the free license. See section 4.

Libraries
Synapse - The synchronous socket library.
* http://www.ararat.cz/synapse/

GNU Aspell
* http://aspell.net/win32

JEDI Code Library
* http://jcl.sourceforge.net

SPHtmlHelp 1.3
* radisoft@mail.ru

TRegExpr library
* http://RegExpStudio.com

libiconv: character set conversion library 1.9
* http://gnuwin32.sourceforge.net/packages/libiconv.htm

Ruby interpreter 1.8.5.0
* http://www.ruby-lang.org/en/

CatsoftComponents
The CatsoftComponents package uses additional third-party libraries. See CVS at SP's project page for source code. 
* No homepage or documentation available


-----------------------------
Go to www.matroska.org and learn about the Matroska container. It supports various streams
such as multiple audio tracks and subtitles, chapters and so on.

IMO it is the best of existing container formats!
