summaryrefslogtreecommitdiffstats
path: root/doc/en/howto-subtitles.docbook
diff options
context:
space:
mode:
Diffstat (limited to 'doc/en/howto-subtitles.docbook')
-rw-r--r--doc/en/howto-subtitles.docbook130
1 files changed, 130 insertions, 0 deletions
diff --git a/doc/en/howto-subtitles.docbook b/doc/en/howto-subtitles.docbook
new file mode 100644
index 0000000..42b1a3f
--- /dev/null
+++ b/doc/en/howto-subtitles.docbook
@@ -0,0 +1,130 @@
+<sect1 id="howto-subtitles">
+<title>Subtitles</title>
+
+<sect2 id="howto-subtitles-internal">
+<title>Embedded subtitles</title>
+
+<para>Some file types like Ogg or Matroska can have subtitles in them along with
+audio and video. Often they have several internal subtitles, usually in
+different languages. <acronym>DVD</acronym> video disks also often come with
+subtitles on them. &kplayer; finds any of those subtitles and lists them on
+the <link linkend="submenu-subtitles"><guisubmenu>Subtitles</guisubmenu>
+submenu</link> of the <guimenu>Player</guimenu> menu. If the languages of the
+subtitles are known, the entries on the submenu are labelled with the language
+names.</para>
+
+<para>Selecting a subtitle track from the submenu displays the subtitles in the
+<link linkend="parts-video-area">video area</link>. The
+<guimenuitem>None</guimenuitem> option disables subtitle display for the current
+file, title, track or stream. &kplayer; remembers the subtitle selection and
+displays the same subtitles the next time you play the file. The <link
+linkend="properties-subtitles"><guilabel>Subtitles</guilabel> section</link> of
+the <guilabel>File Properties</guilabel> is another place where you can see and
+select the subtitle track to be displayed when playing a video.</para>
+
+</sect2>
+
+<sect2 id="howto-subtitles-external">
+<title>External subtitles</title>
+
+<para>To load subtitles from a separate file or files, choose
+<menuchoice><guimenu>File</guimenu><guimenuitem>Load Subtitles...</guimenuitem>
+</menuchoice>. &kplayer; will display subtitles from the first of the loaded
+files in the <link linkend="parts-video-area">video area</link> if the video is
+playing or the next time you play it. You can also drag and drop subtitle files
+from &konqueror; File Manager and drop them anywhere in &kplayer; except the
+<interface>multimedia library</interface> to load and display them.</para>
+
+<para>The <link linkend="submenu-subtitles"><guisubmenu>Subtitles</guisubmenu>
+submenu</link> of the <guimenu>Player</guimenu> menu shows the name of the
+loaded external subtitle file along with any internal subtitle tracks and the
+<guimenuitem>None</guimenuitem> option as described above. You can freely switch
+between all the available subtitles. &kplayer; will display the ones you choose
+without any interruption in video and audio playback. It will also remember your
+choice and load the subtitles again the next time you play the same file or
+<acronym>URL</acronym>.</para>
+
+<para>The <link linkend="properties-subtitles"><guilabel>Subtitles</guilabel>
+section</link> of the <guilabel>File Properties</guilabel> also shows and lets
+you change the external subtitle path. In some cases you may also need to tell
+&kplayer; if they are VobSub or normal subtitles. This happens when you choose
+the <filename>.sub</filename> file when loading VobSub subtitles. Pointing
+&kplayer; to the <filename>.idx</filename> or <filename>.ifo</filename> file
+should allow it to display the VobSub subtitles correctly without the need to
+specify the external subtitle type explicitly.</para>
+
+</sect2>
+
+<sect2 id="howto-subtitles-autoloading">
+<title>Autoloading</title>
+
+<para>You can also let &kplayer; load subtitles automatically by placing them
+in the same directory as the movie and giving them the same name as the movie
+and the correct subtitle extension. For example, if you play a file called
+<filename><replaceable>Carandiru.avi</replaceable></filename>, and you have
+<literal>srt</literal> subtitles for it, you can name the subtitle file
+<filename><replaceable>Carandiru.srt</replaceable></filename>,
+<filename><replaceable>Carandiru.SRT</replaceable></filename>,
+<filename><replaceable>Carandiru.avi.srt</replaceable></filename> or
+<filename><replaceable>Carandiru.avi.SRT</replaceable></filename>.</para>
+
+<para>&kplayer; will autoload subtitle types you choose on the
+<link linkend="settings-subtitles">Subtitles page</link> in <guilabel>&kplayer;
+Settings</guilabel>. Autoloading only works for local files, and &kplayer; will
+not remember autoloaded subtitles, rather it will autoload them every
+time.</para>
+
+</sect2>
+
+<sect2 id="howto-subtitles-settings">
+<title>Subtitle settings</title>
+
+<para>The <link linkend="settings-subtitles"><guilabel>Subtitles</guilabel>
+section</link> of the <guilabel>&kplayer; Settings</guilabel> dialog allows you
+to customize the way subtitles are displayed in the
+<link linkend="parts-video-area">video area</link>. You can select the font
+face, bold and italic style, text size and autoscaling, font outline and text
+width.</para>
+
+<para>There is also an option to add black areas below and above the video and
+show the subtitles in them. That only works when the video aspect ratio is
+greater than the one you choose. Normally you should choose the aspect ratio to
+match your monitor, which is <guilabel>4:3</guilabel> for a regular monitor or
+<guilabel>16:9</guilabel> for a wide one.</para>
+
+<para>Another important option is the subtitle encoding. You may need to select
+it if &mplayer; does not display your subtitles correctly. If most of your
+subtitle files have the same encoding, you can select it in <link
+linkend="settings-subtitles"><guilabel>&kplayer; Settings</guilabel></link>.
+But if some of them have different encoding, go to the <link
+linkend="properties-subtitles"><guilabel>Subtitles</guilabel> section</link> of
+the <guilabel>File Properties</guilabel> and select the encoding there. If the
+framerate of the subtitles is different from the framerate of the video, you can
+specify the subtitle framerate in the
+<link linkend="properties-subtitles"><guilabel>File Properties</guilabel></link>
+as well.</para>
+
+<para>The vertical position of the subtitles and their delay relative to video
+can be changed using commands on the
+<link linkend="submenu-subtitles"><guisubmenu>Subtitles</guisubmenu>
+submenu</link> of the <guimenu>Player</guimenu> menu. As usual, using keyboard
+shortcuts is recommended. By default &kplayer; will remember the subtitle delay
+for each file or <acronym>URL</acronym>, and will keep the vertical position
+across files. This can be changed on the
+<link linkend="settings-controls">Controls page</link> in <guilabel>&kplayer;
+Settings</guilabel>.</para>
+
+</sect2>
+
+<sect2 id="howto-subtitles-finding">
+<title>Finding subtitles</title>
+
+<para>There are a few good places for finding subtitles on the Net, among them
+<ulink url="http://titles.box.sk/">Titles.box.sk</ulink>,
+<ulink url="http://www.opensubtitles.org/">OpenSubtitles.org</ulink> and
+<ulink url="http://www.divxsubtitles.net/">DivXSubtitles.net</ulink>.
+Make sure to enable popup blocking before going to those sites though.</para>
+
+</sect2>
+
+</sect1>