[MPlayer-DOCS] r19828 - in trunk/DOCS/xml/en: faq.xml install.xml usage.xml video.xml

Wed Sep 13 16:30:44 CEST 2006

Author: diego
Date: Wed Sep 13 16:30:44 2006
New Revision: 19828

Modified:
   trunk/DOCS/xml/en/faq.xml
   trunk/DOCS/xml/en/install.xml
   trunk/DOCS/xml/en/usage.xml
   trunk/DOCS/xml/en/video.xml

Log:
Move subtitles and OSD section from the installation to the usage chapter.


Modified: trunk/DOCS/xml/en/faq.xml
==============================================================================

--- trunk/DOCS/xml/en/faq.xml	(original)
+++ trunk/DOCS/xml/en/faq.xml	Wed Sep 13 16:30:44 2006
@@ -457,7 +457,7 @@
 </para></question>
 <answer><para>
 Make sure you have installed fonts properly. Run through the steps in the
-<link linkend="subosd">OSD and subtitle</link> part of the installation
+<link linkend="fonts-osd">Fonts and OSD</link> part of the installation
 section again. If you are using TrueType fonts, verify that you have the
 <systemitem class="library">FreeType</systemitem> library installed.
 Other things include checking your subtitles in a text editor or with other

Modified: trunk/DOCS/xml/en/install.xml
==============================================================================
--- trunk/DOCS/xml/en/install.xml	(original)
+++ trunk/DOCS/xml/en/install.xml	Wed Sep 13 16:30:44 2006
@@ -436,128 +436,8 @@
 
 <!-- ********** -->
 
-<sect1 id="subosd">
-<title>Subtitles and OSD</title>
-
-<para>
-<application>MPlayer</application> can display subtitles along with movie files.
-Currently the following formats are supported:
-<itemizedlist>
-<listitem><para>VOBsub</para></listitem>
-<listitem><para>OGM</para></listitem>
-<listitem><para>CC (closed caption)</para></listitem>
-<listitem><para>MicroDVD</para></listitem>
-<listitem><para>SubRip</para></listitem>
-<listitem><para>SubViewer</para></listitem>
-<listitem><para>Sami</para></listitem>
-<listitem><para>VPlayer</para></listitem>
-<listitem><para>RT</para></listitem>
-<listitem><para>SSA</para></listitem>
-<listitem><para>PJS (Phoenix Japanimation Society)</para></listitem>
-<listitem><para>MPsub</para></listitem>
-<listitem><para>AQTitle</para></listitem>
-<listitem><para><ulink url="http://unicorn.us.com/jacosub/">JACOsub</ulink></para></listitem>
-</itemizedlist>
-</para>
-
-<para>
-<application>MPlayer</application> can dump the previously listed subtitle formats
-(<emphasis role="bold">except the three first</emphasis>) into the following
-destination formats, with the given options:
-<itemizedlist>
-<listitem><para>MPsub: <option>-dumpmpsub</option></para></listitem>
-<listitem><para>SubRip: <option>-dumpsrtsub</option></para></listitem>
-<listitem><para>MicroDVD: <option>-dumpmicrodvdsub</option></para></listitem>
-<listitem><para>JACOsub: <option>-dumpjacosub</option></para></listitem>
-<listitem><para>Sami: <option>-dumpsami</option></para></listitem>
-</itemizedlist>
-</para>
-
-<para>
-<application>MEncoder</application> can dump DVD subtitles into
-<link linkend="menc-feat-extractsub">VOBsub</link> format.
-</para>
-
-<para>
-The command line options differ slightly for the different formats:
-</para>
-
-<formalpara>
-<title>VOBsub subtitles</title>
-<para>
-VOBsub subtitles consist of a big (some megabytes) <filename>.SUB</filename> file,
-and optional <filename>.IDX</filename> and/or <filename>.IFO</filename>
-files.  If you have files like
-<filename><replaceable>sample.sub</replaceable></filename>,
-<filename><replaceable>sample.ifo</replaceable></filename> (optional),
-<filename><replaceable>sample.idx</replaceable></filename> - you have to pass
-<application>MPlayer</application> the <option>-vobsub sample
-[-vobsubid <replaceable>id</replaceable>]</option> options
-(full path optional). The <option>-vobsubid</option> option is like
-<option>-sid</option> for DVDs, you can choose between subtitle tracks
-(languages) with it. In case that <option>-vobsubid</option> is omitted,
-<application>MPLayer</application> will try to use the languages given by the
-<option>-slang</option> option and fall back to the <systemitem>langidx</systemitem>
-in the <filename>.IDX</filename> file to set the subtitle language. If it fails,
-there will be no subtitles.
-</para>
-</formalpara>
-
-<formalpara>
-<title>Other subtitles</title>
-<para>
-The other formats consist of a single text file containing timing,
-placement and text information. Usage: If you have a file like
-<filename><replaceable>sample.txt</replaceable></filename>,
-you have to pass the option <option>-sub
-<replaceable>sample.txt</replaceable></option> (full path optional).
-</para>
-</formalpara>
-
-<variablelist>
-<title>Adjusting subtitle timing and placement:</title>
-<varlistentry>
-  <term><option>-subdelay <replaceable>sec</replaceable></option></term>
-  <listitem><simpara>
-    Delays subtitles by <option><replaceable>sec</replaceable></option> seconds.
-    Can be negative. The value is added to movie's time position counter.
-    </simpara></listitem>
-</varlistentry>
-<varlistentry>
-  <term><option>-subfps <replaceable>RATE</replaceable></option></term>
-  <listitem><simpara>
-    Specify frame/sec rate of subtitle file (float number).
-    </simpara></listitem>
-</varlistentry>
-<varlistentry>
-  <term><option>-subpos <replaceable>0-100</replaceable></option></term>
-  <listitem><simpara>
-    Specify the position of subtitles.
-    </simpara></listitem>
-</varlistentry>
-</variablelist>
-
-<para>
-If you experience a growing delay between the movie and the subtitles when
-using a MicroDVD subtitle file, most likely the framerate of the movie and
-the subtitle file are different. Please note that the MicroDVD subtitle
-format uses absolute frame numbers for its timing, but there is no fps
-information in it, and therefore the <option>-subfps</option> option should
-be used with this format. If you like to solve this problem permanently,
-you have to manually convert the subtitle file framerate.
-<application>MPlayer</application> can do this
-conversion for you:
-
-<screen>mplayer -dumpmicrodvdsub -fps <replaceable>subtitles_fps</replaceable> -subfps <replaceable>avi_fps</replaceable> -sub <replaceable>subtitle_filename</replaceable> <replaceable>dummy.avi</replaceable></screen>
-</para>
-
-<para>
-About DVD subtitles, read the <link linkend="dvd">DVD</link> section.
-</para>
-
-
-<sect2 id="truetype-fonts">
-<title>TrueType fonts</title>
+<sect1 id="fonts-osd">
+<title>Fonts and OSD</title>
 
 <para>
 You need to tell <application>MPlayer</application> which font to use to
@@ -565,7 +445,12 @@
 work. However, TrueType fonts are recommended as they look far better,
 can be properly scaled to the movie size and cope better with different
 encodings.
+</para>
 
+<sect2 id="truetype-fonts">
+<title>TrueType fonts</title>
+
+<para>
   <itemizedlist>
     <listitem><para>
       Use the <option>-font <replaceable>/path/to/sample_font.ttf</replaceable></option>

Modified: trunk/DOCS/xml/en/usage.xml
==============================================================================
--- trunk/DOCS/xml/en/usage.xml	(original)
+++ trunk/DOCS/xml/en/usage.xml	Wed Sep 13 16:30:44 2006
@@ -105,6 +105,127 @@
 </sect1>
 
 
+<sect1 id="subosd">
+<title>Subtitles and OSD</title>
+
+<para>
+<application>MPlayer</application> can display subtitles along with movie files.
+Currently the following formats are supported:
+<itemizedlist>
+<listitem><para>VOBsub</para></listitem>
+<listitem><para>OGM</para></listitem>
+<listitem><para>CC (closed caption)</para></listitem>
+<listitem><para>MicroDVD</para></listitem>
+<listitem><para>SubRip</para></listitem>
+<listitem><para>SubViewer</para></listitem>
+<listitem><para>Sami</para></listitem>
+<listitem><para>VPlayer</para></listitem>
+<listitem><para>RT</para></listitem>
+<listitem><para>SSA</para></listitem>
+<listitem><para>PJS (Phoenix Japanimation Society)</para></listitem>
+<listitem><para>MPsub</para></listitem>
+<listitem><para>AQTitle</para></listitem>
+<listitem><para><ulink url="http://unicorn.us.com/jacosub/">JACOsub</ulink></para></listitem>
+</itemizedlist>
+</para>
+
+<para>
+<application>MPlayer</application> can dump the previously listed subtitle formats
+(<emphasis role="bold">except the three first</emphasis>) into the following
+destination formats, with the given options:
+<itemizedlist>
+<listitem><para>MPsub: <option>-dumpmpsub</option></para></listitem>
+<listitem><para>SubRip: <option>-dumpsrtsub</option></para></listitem>
+<listitem><para>MicroDVD: <option>-dumpmicrodvdsub</option></para></listitem>
+<listitem><para>JACOsub: <option>-dumpjacosub</option></para></listitem>
+<listitem><para>Sami: <option>-dumpsami</option></para></listitem>
+</itemizedlist>
+</para>
+
+<para>
+<application>MEncoder</application> can dump DVD subtitles into
+<link linkend="menc-feat-extractsub">VOBsub</link> format.
+</para>
+
+<para>
+The command line options differ slightly for the different formats:
+</para>
+
+<formalpara>
+<title>VOBsub subtitles</title>
+<para>
+VOBsub subtitles consist of a big (some megabytes) <filename>.SUB</filename> file,
+and optional <filename>.IDX</filename> and/or <filename>.IFO</filename>
+files.  If you have files like
+<filename><replaceable>sample.sub</replaceable></filename>,
+<filename><replaceable>sample.ifo</replaceable></filename> (optional),
+<filename><replaceable>sample.idx</replaceable></filename> - you have to pass
+<application>MPlayer</application> the <option>-vobsub sample
+[-vobsubid <replaceable>id</replaceable>]</option> options
+(full path optional). The <option>-vobsubid</option> option is like
+<option>-sid</option> for DVDs, you can choose between subtitle tracks
+(languages) with it. In case that <option>-vobsubid</option> is omitted,
+<application>MPLayer</application> will try to use the languages given by the
+<option>-slang</option> option and fall back to the <systemitem>langidx</systemitem>
+in the <filename>.IDX</filename> file to set the subtitle language. If it fails,
+there will be no subtitles.
+</para>
+</formalpara>
+
+<formalpara>
+<title>Other subtitles</title>
+<para>
+The other formats consist of a single text file containing timing,
+placement and text information. Usage: If you have a file like
+<filename><replaceable>sample.txt</replaceable></filename>,
+you have to pass the option <option>-sub
+<replaceable>sample.txt</replaceable></option> (full path optional).
+</para>
+</formalpara>
+
+<variablelist>
+<title>Adjusting subtitle timing and placement:</title>
+<varlistentry>
+  <term><option>-subdelay <replaceable>sec</replaceable></option></term>
+  <listitem><simpara>
+    Delays subtitles by <option><replaceable>sec</replaceable></option> seconds.
+    Can be negative. The value is added to movie's time position counter.
+    </simpara></listitem>
+</varlistentry>
+<varlistentry>
+  <term><option>-subfps <replaceable>RATE</replaceable></option></term>
+  <listitem><simpara>
+    Specify frame/sec rate of subtitle file (float number).
+    </simpara></listitem>
+</varlistentry>
+<varlistentry>
+  <term><option>-subpos <replaceable>0-100</replaceable></option></term>
+  <listitem><simpara>
+    Specify the position of subtitles.
+    </simpara></listitem>
+</varlistentry>
+</variablelist>
+
+<para>
+If you experience a growing delay between the movie and the subtitles when
+using a MicroDVD subtitle file, most likely the framerate of the movie and
+the subtitle file are different. Please note that the MicroDVD subtitle
+format uses absolute frame numbers for its timing, but there is no fps
+information in it, and therefore the <option>-subfps</option> option should
+be used with this format. If you like to solve this problem permanently,
+you have to manually convert the subtitle file framerate.
+<application>MPlayer</application> can do this
+conversion for you:
+
+<screen>mplayer -dumpmicrodvdsub -fps <replaceable>subtitles_fps</replaceable> -subfps <replaceable>avi_fps</replaceable> -sub <replaceable>subtitle_filename</replaceable> <replaceable>dummy.avi</replaceable></screen>
+</para>
+
+<para>
+About DVD subtitles, read the <link linkend="dvd">DVD</link> section.
+</para>
+</sect1>
+
+
 <sect1 id="control">
 <title>Control</title>
 

Modified: trunk/DOCS/xml/en/video.xml
==============================================================================
--- trunk/DOCS/xml/en/video.xml	(original)
+++ trunk/DOCS/xml/en/video.xml	Wed Sep 13 16:30:44 2006
@@ -1870,8 +1870,8 @@
 
 <para>
   To change channels press the <keycap>h</keycap> (next) and
-  <keycap>k</keycap> (previous) keys, or use the OSD menu (requires
-  a working <link linkend="subosd">OSD subsystem</link>).
+  <keycap>k</keycap> (previous) keys, or use the
+  <link linkend="osdmenu">OSD menu</link>).
 </para>
 
 <para>

