[MPlayer-DOCS] Bunch of patches for codecs.xml

Torinthiel torinthiel at megapolis.pl
Sun Nov 5 15:01:47 CET 2006


Here's a bunch of patches for DOCS/xml/en/codecs.xml, with short
explanations:
Order of applying is almost irrevelant, except it may cause some
offsets.
OK to commit? Comments?

codecs.option.patch: Fixes a missing <option> tag, around -ac hwmpa

codecs.para.patch:
Removes </para><para> in a middle of thought. IMHO it logically doesn't
belong there (although it doesn't visually change resulting HTML).

codecs.screen.patch:
In two places joins <screen> tag in a single line, thus removing ugly
indentation in resulting HTML.

codecs.sentence.patch:
The resulting fragment looks like this:
#For a complete list of supported codecs please visit the FFmpeg
#homepage. Supported video and audio codecs.
with video and audio being hyperlinks. This looks awkward to me.
I propose to change it to
#For a complete list of supported (audio and video) codecs please visit
#the FFmpeg homepage.
Hyperlinks stay at audio and video, but this time fragments looks better
when viewed without hyperlinks.

codecs.systemitem.patch:
Various missing <systemitem class="library"> tags.

codecs.url.patch:
Better (IMHO at least) and more consistent markup of address for
uploading codec requests. With <> and <replaceable> tags around the
replaceable codec name.

codecs.configure.patch:
This one has to go after the systemitem patch, as they overlap (unless
I get a go for this one and not for systemitem of course).
It unifies configure script handling, as
<filename>./configure</filename>

Torinthiel

-- 
 Waclaw "Torinthiel" Schiller       GG#: 3073512
   torinthiel(at)megapolis(dot)pl
   gpg: 0906A2CE fpr: EE3E DFB4 C4D6 E22E 8999  D714 7CEB CDDC 0906 A2CE
 "No classmates may be used during this examination"
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -447,7 +445,7 @@
 <title>Hardware MPEG audio codec</title>
 
 <para>
-This codec (selected by -ac hwmpa) passes through MPEG audio packets 
+This codec (selected by <option>-ac hwmpa</option>) passes through MPEG audio packets 
 to hardware decoders, such as the ones found in full-featured DVB cards 
 and DXR2 adapters.
 Don't use it in combination with any other audio output device
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -536,9 +534,6 @@
 extension.  If <application>MPlayer</application> fails at playing your AVI
 with this kind of message:
 <screen>UNKNOWN video codec: HFYU (0x55594648)</screen>
-</para>
-
-<para>
 It means your AVI is encoded with a codec which has the HFYU fourcc (HFYU =
 HuffYUV codec, DIV3 = DivX Low Motion, etc.). Now that you know this, you
 have to find out which DLL Windows loads in order to play this file. In our
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -285,9 +286,7 @@
 <para>
   If you have the subversion client installed, the latest x264
   sources can be gotten with this command:
-  <screen>
-    svn co svn://svn.videolan.org/x264/trunk x264<!--
-  --></screen>
+  <screen>svn co svn://svn.videolan.org/x264/trunk x264</screen>
   <application>MPlayer</application> sources are updated whenever
   an <systemitem class="library">x264</systemitem> API change
   occurs, so it is always suggested to use
@@ -301,9 +300,7 @@
 <para>
   <systemitem class="library">x264</systemitem> is built and
   installed in the standard way:
-  <screen>
-    ./configure &amp;&amp; make &amp;&amp; sudo make install<!--
-  --></screen>
+  <screen>./configure &amp;&amp; make &amp;&amp; sudo make install</screen>
   This installs libx264.a in /usr/local/lib and x264.h is placed in
   /usr/local/include.
 
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -93,9 +93,10 @@
 </para>
 
 <para>
-For a complete list of supported codecs please visit the FFmpeg homepage.
-Supported <ulink url="http://ffmpeg.org/ffmpeg-doc.html#SEC19">video</ulink>
-and <ulink url="http://ffmpeg.org/ffmpeg-doc.html#SEC20">audio</ulink> codecs.
+For a complete list of supported 
+(<ulink url="http://ffmpeg.org/ffmpeg-doc.html#SEC19">video</ulink>
+and <ulink url="http://ffmpeg.org/ffmpeg-doc.html#SEC20">audio</ulink>)
+codecs please visit the FFmpeg homepage.
 </para>
 
 <para>
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -178,10 +179,10 @@
 
 
 <sect2 id="codec-x264">
-<title>x264</title>
+<title><systemitem class="library">x264</systemitem></title>
 
 <sect3 id="codec-x264-whatis">
-<title>What is x264?</title>
+<title>What is <systemitem class="library">x264</systemitem>?</title>
 <para>
   <ulink url="http://developers.videolan.org/x264.html"><systemitem class="library">x264</systemitem></ulink>
   is a library for
@@ -426,18 +423,19 @@
 
 
 <sect2 id="libmad">
-<title>libmad support</title>
+<title><systemitem class="library">libmad</systemitem> support</title>
 
 <para>
-<ulink url="http://www.underbit.com/products/mad/">libmad</ulink> is a multiplatform,
-integer (internally 24bit PCM) only
+<ulink url="http://www.underbit.com/products/mad/"><systemitem class="library">libmad</systemitem></ulink>
+is a multiplatform, integer (internally 24bit PCM) only
 MPEG audio decoding library. It does not handle broken files well, and it
 sometimes has problems with seeking, but it may perform better on FPU-less
-(such as <link linkend="arm">ARM</link>) platform than mp3lib.
+(such as <link linkend="arm">ARM</link>) platform than <systemitem class="library">mp3lib</systemitem>.
 </para>
 
 <para>
-If you have a proper installation of libmad, <filename>configure</filename>
+If you have a proper installation of <systemitem class="library">libmad</systemitem>,
+<filename>configure</filename>
 will notice and support for MPEG audio decoding via
 <systemitem class="library">libmad</systemitem> will be built automatically.
 </para>
-------------- next part --------------
Index: en/codecs.xml
===================================================================
--- en/codecs.xml	(revision 20682)
+++ en/codecs.xml	(working copy)
@@ -558,7 +553,7 @@
 (fourcc, codec file, sample AVI), submit your codec support request by
 mail, and upload these files to the FTP site:
 <systemitem role="url">
-ftp://upload.mplayerhq.hu/MPlayer/incoming/[codecname]/
+ftp://upload.mplayerhq.hu/MPlayer/incoming/<replaceable>&lt;codecname&gt;</replaceable>/
 </systemitem>
 </para>
 
@@ -670,7 +665,7 @@
 sample AVI), submit your codec support request by mail, and upload these files
 to the FTP site:
 <systemitem
-role="url">ftp://upload.mplayerhq.hu/MPlayer/incoming/[codecname]/
+role="url">ftp://upload.mplayerhq.hu/MPlayer/incoming/<replaceable>&lt;codecname&gt;</replaceable>/
 </systemitem>
 </para>
 
-------------- next part --------------
--- en/codecs.xml	Sun Nov  5 14:43:59 2006
+++ en/codecs.xml.new	Sun Nov  5 13:57:54 2006
@@ -102,7 +102,7 @@
 <para>
 <application>MPlayer</application> contains
 <systemitem class="library">libavcodec</systemitem>.
-Just run <filename>configure</filename> and compile.
+Just run <filename>./configure</filename> and compile.
 </para>
 
 </sect2>
@@ -310,7 +310,7 @@
   <systemitem class="library">x264</systemitem> support is easy.
   Just run the standard:
   <screen>./configure &amp;&amp; make &amp;&amp; sudo make install</screen>
-  The configure script will autodetect that you have satisfied the
+  The <filename>./configure</filename> script will autodetect that you have satisfied the
   requirements for <systemitem class="library">x264</systemitem>.
 </para>
 </sect3>
@@ -435,7 +435,7 @@
 
 <para>
 If you have a proper installation of <systemitem class="library">libmad</systemitem>,
-<filename>configure</filename>
+<filename>./configure</filename>
 will notice and support for MPEG audio decoding via
 <systemitem class="library">libmad</systemitem> will be built automatically.
 </para>
@@ -469,7 +469,7 @@
 If you use gcc 3.2 which fails to compile our internal FAAD or want to use
 the external library for some other reason, download the library from the
 <ulink url="http://www.audiocoding.com/modules/mydownloads/">download page</ulink>
-and pass <option>--enable-faad-external</option> to <filename>configure</filename>.
+and pass <option>--enable-faad-external</option> to <filename>./configure</filename>.
 You do not need all of faad2 to decode AAC files, libfaad is enough. Build
 it like this:
 <screen>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: not available
URL: <http://lists.mplayerhq.hu/pipermail/mplayer-docs/attachments/20061105/080aa4b1/attachment.pgp>


More information about the MPlayer-DOCS mailing list