1. ffmpeg
  2. Commit a8f0814a742dee4783afaa5bedb01aa0c77b1fc4
Browse code

doc: modify style for texi2html 1.78+

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.

Janne Grunau authored on 2011/01/29 21:24:13
Showing 10 changed files
Makefile
History View file @ a8f0814
... ... 
@@ -123,8 +123,8 @@ doc/ffprobe.pod doc/ffprobe.html: doc/demuxers.texi doc/indevs.texi doc/protocol
123 123 
 doc/libavfilter.html: doc/filters.texi
124 124
125 125 
 doc/%.html: TAG = HTML
126 
-doc/%.html: doc/%.texi
127 
-	$(M)cd doc && texi2html -monolithic -number $(<:doc/%=%)
126 
+doc/%.html: doc/%.texi $(SRC_PATH_BARE)/doc/t2h.init
127 
+	$(M)cd doc && texi2html -monolithic --init-file $(SRC_PATH_BARE)/doc/t2h.init $(<:doc/%=%)
128 128
129 129 
 doc/%.pod: TAG = POD
130 130 
 doc/%.pod: doc/%.texi
doc/developer.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,12 @@
2 2
3 3 
 @settitle Developer Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{Developer Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
10 11
11 12 
 @chapter Developers Guide
12 13
doc/faq.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,12 @@
2 2
3 3 
 @settitle FFmpeg FAQ
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{FFmpeg FAQ}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
10 11
11 12 
 @chapter General Questions
12 13
doc/ffmpeg.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,13 @@
2 2
3 3 
 @settitle FFmpeg Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{FFmpeg Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
11 
+
10 12 
 @chapter Synopsis
11 13
12 14 
 The generic syntax is:
doc/ffplay.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,13 @@
2 2
3 3 
 @settitle FFplay Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{FFplay Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
11 
+
10 12 
 @chapter Synopsis
11 13
12 14 
 @example
doc/ffprobe.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,13 @@
2 2
3 3 
 @settitle FFprobe Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{FFprobe Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
11 
+
10 12 
 @chapter Synopsis
11 13
12 14 
 The generic syntax is:
doc/ffserver.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,13 @@
2 2
3 3 
 @settitle FFserver Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{FFserver Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
11 
+
10 12 
 @chapter Synopsys
11 13
12 14 
 The generic syntax is:
doc/general.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,12 @@
2 2
3 3 
 @settitle General Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{General Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
10 11
11 12 
 @chapter external libraries
12 13
doc/libavfilter.texi
History View file @ a8f0814
... ... 
@@ -2,11 +2,12 @@
2 2
3 3 
 @settitle Libavfilter Documentation
4 4 
 @titlepage
5 
-@sp 7
6 5 
 @center @titlefont{Libavfilter Documentation}
7 
-@sp 3
8 6 
 @end titlepage
9 7
8 
+@top
9 
+
10 
+@contents
10 11
11 12 
 @chapter Introduction
12 13
doc/t2h.init
History View file @ a8f0814
13 14 
new file mode 100644
... ... 
@@ -0,0 +1,24 @@
0 
+# no horiz rules between sections
1 
+$end_section = \&FFMPEG_end_section;
2 
+sub FFMPEG_end_section($$)
3 
+{
4 
+}
5 
+
6 
+$print_page_foot = \&FFMPEG_print_page_foot;
7 
+sub FFMPEG_print_page_foot($$)
8 
+{
9 
+    my $fh = shift;
10 
+    print $fh "$SMALL_RULE\n";
11 
+    T2H_DEFAULT_print_page_foot($fh);
12 
+}
13 
+
14 
+# no navigation elements
15 
+$SECTION_NAVIGATION = 0;
16 
+# the same for texi2html 5.0
17 
+$HEADERS = 0;
18 
+
19 
+# TOC and Chapter headings link
20 
+$TOC_LINKS = 1;
21 
+
22 
+# print the TOC where @contents is used
23 
+$INLINE_CONTENTS = 1;