[FFmpeg-devel] [PATCH] doc: extend "See Also" chapter rendering for ff* tools

Stefano Sabatini stefasab at gmail.com
Sun Dec 16 21:39:03 CET 2012


Add more references, and generate alternative variants for HTML and POD
output. In particular, this allows to render a "See Also" chapter in the
HTML output.
---
 doc/ffmpeg.texi   |   26 ++++++++++++++++++++++----
 doc/ffplay.texi   |   26 ++++++++++++++++++++++----
 doc/ffprobe.texi  |   26 ++++++++++++++++++++++----
 doc/ffserver.texi |   29 +++++++++++++++++++++++------
 4 files changed, 89 insertions(+), 18 deletions(-)

diff --git a/doc/ffmpeg.texi b/doc/ffmpeg.texi
index b4ad6c2..8e0a16d 100644
--- a/doc/ffmpeg.texi
+++ b/doc/ffmpeg.texi
@@ -1294,6 +1294,28 @@ ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
 @include filters.texi
 @include metadata.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{ffmpeg-utils.html,ffmpeg-utils},
+ at url{ffmpeg-scaler.html,ffmpeg-scale},
+ at url{ffmpeg-resampler.html,ffmpeg-resampler},
+ at url{ffmpeg-codecs.html,ffmpeg-codecs},
+ at url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters.html}
+ at url{ffmpeg-formats.html,ffmpeg-formats},
+ at url{ffmpeg-devices.html,ffmpeg-devices},
+ at url{ffmpeg-protocols.html,ffmpeg-protocols},
+ at url{ffmpeg-filters.html,ffmpeg-filters},
+ at end ifhtml
+
+ at ifnothtml
+ffplay(1), ffprobe(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -1301,10 +1323,6 @@ ffmpeg -i src.ext -lmax 21*QP2LAMBDA dst.ext
 @setfilename ffmpeg
 @settitle ffmpeg video converter
 
- at c man begin SEEALSO
-ffplay(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffplay.texi b/doc/ffplay.texi
index 9886fd8..cb301d5 100644
--- a/doc/ffplay.texi
+++ b/doc/ffplay.texi
@@ -200,6 +200,28 @@ Seek to percentage in file corresponding to fraction of width.
 @include protocols.texi
 @include filters.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffmpeg.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{ffmpeg-utils.html,ffmpeg-utils},
+ at url{ffmpeg-scaler.html,ffmpeg-scale},
+ at url{ffmpeg-resampler.html,ffmpeg-resampler},
+ at url{ffmpeg-codecs.html,ffmpeg-codecs},
+ at url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters.html}
+ at url{ffmpeg-formats.html,ffmpeg-formats},
+ at url{ffmpeg-devices.html,ffmpeg-devices},
+ at url{ffmpeg-protocols.html,ffmpeg-protocols},
+ at url{ffmpeg-filters.html,ffmpeg-filters}
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffprobe(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -207,10 +229,6 @@ Seek to percentage in file corresponding to fraction of width.
 @setfilename ffplay
 @settitle FFplay media player
 
- at c man begin SEEALSO
-ffmpeg(1), ffprobe(1), ffserver(1) and the FFmpeg HTML documentation
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffprobe.texi b/doc/ffprobe.texi
index a5fa5b3..3fde49f 100644
--- a/doc/ffprobe.texi
+++ b/doc/ffprobe.texi
@@ -501,15 +501,33 @@ DV, GXF and AVI timecodes are available in format metadata
 
 @include authors.texi
 
+ at chapter See Also
+
+ at ifhtml
+ at url{ffplay.html,ffmpeg}, @url{ffprobe.html,ffprobe}, @url{ffserver.html,ffserver},
+ at url{ffmpeg-utils.html,ffmpeg-utils},
+ at url{ffmpeg-scaler.html,ffmpeg-scale},
+ at url{ffmpeg-resampler.html,ffmpeg-resampler},
+ at url{ffmpeg-codecs.html,ffmpeg-codecs},
+ at url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters.html}
+ at url{ffmpeg-formats.html,ffmpeg-formats},
+ at url{ffmpeg-devices.html,ffmpeg-devices},
+ at url{ffmpeg-protocols.html,ffmpeg-protocols},
+ at url{ffmpeg-filters.html,ffmpeg-filters},
+ at end ifhtml
+
+ at ifnothtml
+ffmpeg(1), ffplay(1), ffserver(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+ at end ifnothtml
+
 @ignore
 
 @setfilename ffprobe
 @settitle ffprobe media prober
 
- at c man begin SEEALSO
-ffmpeg(1), ffplay(1), ffserver(1) and the FFmpeg HTML documentation
- at c man end
-
 @end ignore
 
 @bye
diff --git a/doc/ffserver.texi b/doc/ffserver.texi
index b85c724..1450778 100644
--- a/doc/ffserver.texi
+++ b/doc/ffserver.texi
@@ -266,6 +266,29 @@ messages to stdout.
 @end table
 @c man end
 
+ at chapter See Also
+
+ at ifhtml
+The @file{doc/ffserver.conf} example,
+ at url{ffmpeg.html,ffmpeg}, @url{ffplay.html,ffplay}, @url{ffprobe.html,ffprobe},
+ at url{ffmpeg-utils.html,ffmpeg-utils},
+ at url{ffmpeg-scaler.html,ffmpeg-scale},
+ at url{ffmpeg-resampler.html,ffmpeg-resampler},
+ at url{ffmpeg-codecs.html,ffmpeg-codecs},
+ at url{ffmpeg-bitstream-filters.html,ffmpeg-bitstream-filters.html}
+ at url{ffmpeg-formats.html,ffmpeg-formats},
+ at url{ffmpeg-devices.html,ffmpeg-devices},
+ at url{ffmpeg-protocols.html,ffmpeg-protocols},
+ at url{ffmpeg-filters.html,ffmpeg-filters}
+ at end ifhtml
+
+ at ifnothtml
+The @file{doc/ffserver.conf} example, ffmpeg(1), ffplay(1), ffprobe(1),
+ffmpeg-utils(1), ffmpeg-scaler(1), ffmpeg-resampler(1),
+ffmpeg-codecs(1), ffmpeg-bitstream-filters(1), ffmpeg-formats(1),
+ffmpeg-devices(1), ffmpeg-protocols(1), ffmpeg-filters(1)
+ at end ifnothtml
+
 @include authors.texi
 
 @ignore
@@ -273,12 +296,6 @@ messages to stdout.
 @setfilename ffserver
 @settitle ffserver video server
 
- at c man begin SEEALSO
-
-ffmpeg(1), ffplay(1), ffprobe(1), the @file{ffserver.conf}
-example and the FFmpeg HTML documentation
- at c man end
-
 @end ignore
 
 @bye
-- 
1.7.9.5



More information about the ffmpeg-devel mailing list