[FFmpeg-devel] [PATCH] web/documentation: mention ff*-all pages

[Stefano Sabatini]

On date Monday 2013-04-08 10:47:06 -0800, Lou Logan encoded:
> On Sun, 7 Apr 2013 23:09:46 +0200, Stefano Sabatini wrote:
> 
> > From 5234ab068adafe297abcc9e3064dc8d2ce895b0f Mon Sep 17 00:00:00 2001
> > From: Stefano Sabatini <stefasab at gmail.com>
> > Date: Fri, 5 Apr 2013 10:24:25 +0200
> > Subject: [PATCH] web/documentation: rework manuals presentation and mention
> >  ff*-all pages
> > 
> > ---
> >  src/documentation |   35 ++++++++++++++++++++++-------------
> >  1 file changed, 22 insertions(+), 13 deletions(-)
> > 
> > diff --git a/src/documentation b/src/documentation
> > index cc3c91c..4ddf3af 100644
> > --- a/src/documentation
> > +++ b/src/documentation
> > @@ -6,23 +6,32 @@ Consult your locally installed documentation for older versions.
> >  
> >  <h2>Command Line Tools Documentation</h2>
> >  <ul>
> > -<li><a href="ffmpeg.html">ffmpeg</a></li>
> > -<li><a href="ffplay.html">ffplay</a></li>
> > -<li><a href="ffprobe.html">ffprobe</a></li>
> > -<li><a href="ffserver.html">ffserver</a> and a <a href="sample.html">sample ffserver configuration file</a></li>
> > +<li><a href="ffmpeg.html">ffmpeg</a> (<tt>ffmpeg tool</tt>)
> > +  and <a href="ffmpeg-all.html">ffmpeg-all</a> (<tt>ffmpeg</tt> tool and FFmpeg subcomponents)
> > +</li>
> > +<li><a href="ffplay.html">ffplay</a> (<tt>ffplay tool</tt>)
> > +  and <a href="ffplay-all.html">ffplay-all</a> (<tt>ffplay</tt> tool and FFmpeg subcomponents)
> > +</li>
> > +<li><a href="ffprobe.html">ffprobe</a> (<tt>ffprobe tool</tt>)
> > +  and <a href="ffprobe-all.html">ffprobe-all</a> (<tt>ffprobe</tt> tool and FFmpeg subcomponents)
> > +</li>
> > +<li><a href="ffserver.html">ffserver</a> (<tt>ffserver</tt> tool),
> > +  <a href="ffserver-all.html">ffserver-all</a> (<tt>ffserver</tt> tool and FFmpeg subcomponents),
> > +  and a <a href="sample.html">sample ffserver configuration file</a>
> > +</li>
> >  </ul>
> >  
> >  <h2>Components Documentation</h2>
> >  <ul>
> > -<li><a href="ffmpeg-utils.html">FFmpeg utilities</a></li>
> > -<li><a href="ffmpeg-scaler.html">FFmpeg video scaling and pixel format converter</a></li>
> > -<li><a href="ffmpeg-resampler.html">FFmpeg audio resampler</a></li>
> > -<li><a href="ffmpeg-codecs.html">FFmpeg encoders and decoders (codecs)</a></li>
> > -<li><a href="ffmpeg-bitstream-filters.html">FFmpeg bitstream filters</a></li>
> > -<li><a href="ffmpeg-formats.html">FFmpeg muxers and demuxers (formats)</a></li>
> > -<li><a href="ffmpeg-protocols.html">FFmpeg protocols</a></li>
> > -<li><a href="ffmpeg-devices.html">FFmpeg input and output devices</a></li>
> > -<li><a href="ffmpeg-filters.html">FFmpeg filters</a></li>
> > +<li><a href="ffmpeg-utils.html">ffmpeg-utils</a> (FFmpeg utilities)</li>
> > +<li><a href="ffmpeg-scaler.html">ffmpeg-scaler</a> (FFmpeg video scaling and pixel format converter)</li>
> > +<li><a href="ffmpeg-resampler.html">ffmpeg-resampler</a> (FFmpeg audio resampler)</li>
> > +<li><a href="ffmpeg-codecs.html">ffmpeg-codecs</a> (FFmpeg encoders and decoders (codecs))</li>
> > +<li><a href="ffmpeg-bitstream-filters.html">ffmpeg-bitstream-filters</a>  (FFmpeg bitstream filters)</li>
> > +<li><a href="ffmpeg-formats.html">ffmpeg-formats</a> (FFmpeg muxers and demuxers (formats))</li>
> > +<li><a href="ffmpeg-protocols.html">ffmpeg-protocols</a> (FFmpeg protocols)</li>
> > +<li><a href="ffmpeg-devices.html">ffmpeg-devices</a> (FFmpeg input and output devices)</a></li>
> > +<li><a href="ffmpeg-filters.html">ffmpeg-filters</a> (FFmpeg filters)</li>
> 
> A colon instead of parentheses might look cleaner for this section:
> 
> ffmpeg-devices: FFmpeg input and output devices

For consistency then I should use the same form also in the tool
section:
<li><a href="ffmpeg.html">ffmpeg</a>: <tt>ffmpeg tool</tt></li>
<li><a href="ffmpeg-all.html">ffmpeg-all</a>: <tt>ffmpeg</tt> tool and FFmpeg subcomponents</li>
...

> 
> Otherwise the patch is fine with me.
-- 
FFmpeg = Friendly Fiendish Mega Pure Enchanting Geisha