[FFmpeg-devel] [PATCH 3/3] web/documentation: Simplify Components Documentation links

[Alexander Strasser]

Sorry, please ignore my previous mail!

A quirk in my mail setup tricked me into thinking this was new mail.

After looking at current documentation link layout I still think we could still avoid the double links (ffmpeg, ffmpeg-full) and just show one entry per tool always linking to full.

  Alexander

Am 10. November 2015 10:01:23 MEZ, schrieb Alexander Strasser <eclipse7 at gmx.net>:
>
>
>Am 6. September 2014 19:23:25 MESZ, schrieb "Clément Bœsch" <u at pkh.me>:
>>On Sat, Sep 06, 2014 at 09:12:47AM -0800, Lou Logan wrote:
>>> On Sat, Sep 6, 2014, at 04:37 AM, db0company wrote:
>>> > ---
>>> >  src/documentation |   18 +++++++++---------
>>> >  1 files changed, 9 insertions(+), 9 deletions(-)
>>> 
>>> I don't have a strong opinion about this patch but there are two
>>things
>>> I want to bikeshed:
>>> 
>>> 1. One nice thing about the current format is that the link names
>>> (ffmpeg-*) are the same as the man page name for each component,
>such
>>as
>>> "man ffmpeg-filters", but I'm unsure if many users make that
>>connection.
>>>
>>
>>I doubt most users realize that by looking at the page. They can find
>>the
>>appropriate man-page by doing man ffm<tab> in the shell.
>>
>>Currently, the page index is really cluttered for no purpose, and I
>>often
>>see users ending up in "libavfilter" section instead of "filters",
>>probably because the library section is easier to read, and the
>>components
>>just looks like a "FFmpeg words soup".
>
>I fear current situation is not very friendly
>for new (documentation) users :(
>
>>> 2. It is more consistent with the "Command Line Tools Documentation"
>>> section if the ffmpeg-* are preserved.
>>> 
>>
>>Maybe we should change that one as well.
>>
>>Something like:
>>
>>  • ffmpeg (full help)
>>  • ffplay (full help)
>>  • ffprobe (full help)
>>  • ffserver (full help, sample configuration file)
>
>Looks reasonable to me.
>
>[...]
>
>  Alexander
>
>_______________________________________________
>ffmpeg-devel mailing list
>ffmpeg-devel at ffmpeg.org
>http://ffmpeg.org/mailman/listinfo/ffmpeg-devel