[FFmpeg-devel] [PATCH] Use makeinfo to generate html doc for the new website

[Timothy Gu]

On Jul 23, 2014 7:44 PM, "Michael Niedermayer" <michaelni at gmx.at> wrote:
>
> On Wed, Jul 23, 2014 at 05:20:10PM -0700, Timothy Gu wrote:
> > On Sun, Jul 20, 2014 at 2:26 PM, Timothy Gu <timothygu99 at gmail.com>
wrote:
> > > texi2html is deprecated by upstream in favor of makeinfo/texi2any.
See:
> > >
> > > -
https://www.gnu.org/software/texinfo/manual/texinfo/html_node/texi2html.html
> > > - https://wiki.debian.org/Texi2htmlTransition
> > > - https://lists.debian.org/debian-devel/2013/05/msg01516.html
> > >
> > > This is actually two separate changes. But as makeinfo and texi2html
> > > adopt 2 (very) different init file syntaxes, it is easier to do the
two
> > > transitions at once.
> > >
> > > Based on a patch by Andreas Cadhalpun <
Andreas.Cadhalpun at googlemail.com>.
> > >
> > > Fixes Trac ticket #3232.
> > >
> > > Signed-off-by: Timothy Gu <timothygu99 at gmail.com>
> > > ---
> > >
> > > Removed some now-extraneous settings.
> > >
> > >  configure         |   5 +-
> > >  doc/Makefile      |   8 +-
> > >  doc/platform.texi |   2 +-
> > >  doc/t2h.init      | 123 ------------------------------
> > >  doc/t2h.pm        | 220
++++++++++++++++++++++++++++++++++++++++++++++++++++++
> > >  5 files changed, 226 insertions(+), 132 deletions(-)
> > >  delete mode 100644 doc/t2h.init
> > >  create mode 100644 doc/t2h.pm
> >
> > Ping
>
> does this patchset affect how the html output looks ?

Yes.

The pros about this patch set:

- the double title is removed (see e.g. https://ffmpeg.org/ffmpeg.html) and
bogus "FFmpeg documentation" for all the doc pages are changed to the real
one.

- For client-side doc generation the title style is more consistent with
the website (the underline is removed and background is darker)

- @float is handled more elegantly (see the currently really out-of-place
output that looks like Libav's:
https://ffmpeg.org/general.html#OpenCORE_002c-VisualOn_002c-and-Fraunhofer-libraries
)

The neutral changes made by this set:
- Chapter titles are now <h2>. I can change this back to <h1> if desired
but I think <h2> is more visually appealing.
- Chapter titles follow the format of (1 Blah) instead of (1. Blah).
Section title format is not changed.

The cons:
- Anchor names are changed.

>
> also applying this patchset will not affect how our server
> generates the html, as it does not execute files from git.
> If its intended to also change what the server does, this would need
> some volunteer to update the scripts used.

OK. You can send me privately the server scripts and I'll see what I can do.

Timothy