doc: modify style for texi2html 1.78+
authorJanne Grunau <janne-ffmpeg@jannau.net>
Sat, 29 Jan 2011 12:24:13 +0000 (13:24 +0100)
committerMichael Niedermayer <michaelni@gmx.at>
Sun, 30 Jan 2011 02:41:47 +0000 (03:41 +0100)
The generated HTML files are similar to the ones generated with
texi2html 1.56k used on the website.

Tested with texi2html 1.78 and 5.0. 1.78 is the minimal recommended
version.

The removed @sp from the titlepage section were ignored until
texi2html 5.0. If not removed the pages generated by 5.0 will have ugly
empty space around the title.
(cherry picked from commit a8f0814a742dee4783afaa5bedb01aa0c77b1fc4)

Makefile
doc/developer.texi
doc/faq.texi
doc/ffmpeg.texi
doc/ffplay.texi
doc/ffprobe.texi
doc/ffserver.texi
doc/general.texi
doc/libavfilter.texi
doc/t2h.init [new file with mode: 0644]

index c5e74f0..2658a30 100644 (file)
--- a/Makefile
+++ b/Makefile
@@ -123,8 +123,8 @@ doc/ffprobe.pod doc/ffprobe.html: doc/demuxers.texi doc/indevs.texi doc/protocol
 doc/libavfilter.html: doc/filters.texi
 
 doc/%.html: TAG = HTML
-doc/%.html: doc/%.texi
-       $(M)cd doc && texi2html -monolithic -number $(<:doc/%=%)
+doc/%.html: doc/%.texi $(SRC_PATH_BARE)/doc/t2h.init
+       $(M)cd doc && texi2html -monolithic --init-file $(SRC_PATH_BARE)/doc/t2h.init $(<:doc/%=%)
 
 doc/%.pod: TAG = POD
 doc/%.pod: doc/%.texi
index 89bc339..b9e246f 100644 (file)
@@ -2,11 +2,12 @@
 
 @settitle Developer Documentation
 @titlepage
-@sp 7
 @center @titlefont{Developer Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter Developers Guide
 
index c03a2e1..100adff 100644 (file)
@@ -2,11 +2,12 @@
 
 @settitle FFmpeg FAQ
 @titlepage
-@sp 7
 @center @titlefont{FFmpeg FAQ}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter General Questions
 
index 98f2031..047444a 100644 (file)
@@ -2,11 +2,13 @@
 
 @settitle FFmpeg Documentation
 @titlepage
-@sp 7
 @center @titlefont{FFmpeg Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
+
 @chapter Synopsis
 
 The generic syntax is:
index c03905c..e0518b8 100644 (file)
@@ -2,11 +2,13 @@
 
 @settitle FFplay Documentation
 @titlepage
-@sp 7
 @center @titlefont{FFplay Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
+
 @chapter Synopsis
 
 @example
index bc96bd5..de65eee 100644 (file)
@@ -2,11 +2,13 @@
 
 @settitle FFprobe Documentation
 @titlepage
-@sp 7
 @center @titlefont{FFprobe Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
+
 @chapter Synopsis
 
 The generic syntax is:
index 77deb85..0cab3c8 100644 (file)
@@ -2,11 +2,13 @@
 
 @settitle FFserver Documentation
 @titlepage
-@sp 7
 @center @titlefont{FFserver Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
+
 @chapter Synopsys
 
 The generic syntax is:
index c1fecef..950159f 100644 (file)
@@ -2,11 +2,12 @@
 
 @settitle General Documentation
 @titlepage
-@sp 7
 @center @titlefont{General Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter external libraries
 
index 8745928..f0b4482 100644 (file)
@@ -2,11 +2,12 @@
 
 @settitle Libavfilter Documentation
 @titlepage
-@sp 7
 @center @titlefont{Libavfilter Documentation}
-@sp 3
 @end titlepage
 
+@top
+
+@contents
 
 @chapter Introduction
 
diff --git a/doc/t2h.init b/doc/t2h.init
new file mode 100644 (file)
index 0000000..cd38a3e
--- /dev/null
@@ -0,0 +1,24 @@
+# no horiz rules between sections
+$end_section = \&FFMPEG_end_section;
+sub FFMPEG_end_section($$)
+{
+}
+
+$print_page_foot = \&FFMPEG_print_page_foot;
+sub FFMPEG_print_page_foot($$)
+{
+    my $fh = shift;
+    print $fh "$SMALL_RULE\n";
+    T2H_DEFAULT_print_page_foot($fh);
+}
+
+# no navigation elements
+$SECTION_NAVIGATION = 0;
+# the same for texi2html 5.0
+$HEADERS = 0;
+
+# TOC and Chapter headings link
+$TOC_LINKS = 1;
+
+# print the TOC where @contents is used
+$INLINE_CONTENTS = 1;