Do better about being able to build developer documentation on many

platforms.  This still sucks, but it sucks less. Hopefully I can shame
someone to go further.

diff --git a/doc/developer/Makefile b/doc/developer/Makefile
index 217244f690daf2053c9d370b3095ea25b22aea0b..62e1c7c71bc4f1e4ced186eea4419bd405f0c8ab 100644 (file)
--- a/doc/developer/Makefile
+++ b/doc/developer/Makefile
@@ -3,16 +3,14 @@
 MAX_TEX_RECURSION=4
 
 # For Debian :
-XML_DECL=/usr/lib/sgml/declaration/xml.decl
-HTML_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/html/docbook.dsl
-PRINT_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/print/docbook.dsl
+#XML_DECL=/usr/lib/sgml/declaration/xml.decl
+#HTML_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/html/docbook.dsl
+#PRINT_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/print/docbook.dsl
 
 # For RedHat :
-#XML_DECL=/usr/lib/sgml/stylesheets/nwalsh-modular/dtds/decls/xml.dcl
-#HTML_SS=/usr/lib/sgml/stylesheets/nwalsh-modular/html/docbook.dsl
-#PRINT_SS=/usr/lib/sgml/stylesheets/nwalsh-modular/print/docbook.dsl
-
-JADE=jade
+# XML_DECL=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/dtds/decls/xml.dcl
+# HTML_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/html/docbook.dsl
+# PRINT_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/print/docbook.dsl
 
 # For Mac OS X :
 #XML_DECL=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/dtds/decls/xml.dcl
@@ -20,6 +18,13 @@ JADE=jade
 #PRINT_SS=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/print/docbook.dsl
 #JADE=openjade
 
+JADE=openjade
+
+XML_DECL=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/dtds/decls/xml.dcl
+HTML_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/html/docbook.dsl
+PRINT_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/print/docbook.dsl
+
+
 all: manual
 
 

diff --git a/doc/developer/Makefile.in b/doc/developer/Makefile.in
new file mode 100644 (file)
index 0000000..27d3a65
--- /dev/null
+++ b/doc/developer/Makefile.in
@@ -0,0 +1,59 @@
+# Extract from the Debian SGML/XML HOWTO by Stéphane Bortzmeyer
+
+MAX_TEX_RECURSION=4
+
+# For Debian :
+#XML_DECL=/usr/lib/sgml/declaration/xml.decl
+#HTML_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/html/docbook.dsl
+#PRINT_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/print/docbook.dsl
+
+# For RedHat :
+# XML_DECL=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/dtds/decls/xml.dcl
+# HTML_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/html/docbook.dsl
+# PRINT_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/print/docbook.dsl
+
+# For Mac OS X :
+#XML_DECL=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/dtds/decls/xml.dcl
+#HTML_SS=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/html/docbook.dsl
+#PRINT_SS=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/print/docbook.dsl
+#JADE=openjade
+
+JADE=@JADE@
+
+XML_DECL=@XML_DECL@
+HTML_SS=@HTML_SS@
+PRINT_SS=@PRINT_SS@
+
+
+all: manual
+
+
+manual: manual.txt manual.ps manual.html
+
+manual.tex: audio_output.xml debugging.xml decoders.xml gfdl.xml glossary.xml history.xml input.xml interface.xml manual.xml overview.xml ports.xml video_output.xml
+       $(JADE) -t tex -V %section-autolabel% -d $(PRINT_SS) $(XML_DECL) manual.xml
+       perl -i.bak -pe 's/\000//g' $@ && rm $*.tex.bak
+# No it's not a joke
+
+manual.html: audio_output.xml debugging.xml decoders.xml gfdl.xml glossary.xml history.xml input.xml interface.xml manual.xml overview.xml ports.xml video_output.xml
+       $(JADE) -t sgml -V %section-autolabel% -V nochunks \
+         -d $(HTML_SS) $(XML_DECL) manual.xml > $@
+
+manual.dvi: manual.tex modules.eps ps.eps stream.eps ts.eps
+       jadetex manual.tex
+       jadetex manual.tex
+       jadetex manual.tex
+
+manual.ps: manual.dvi
+       dvips -f $< > $@
+
+manual.txt: audio_output.xml debugging.xml decoders.xml gfdl.xml glossary.xml history.xml input.xml interface.xml manual.xml overview.xml ports.xml video_output.xml
+       $(JADE) -t sgml -V nochunks -d $(HTML_SS) $(XML_DECL) manual.xml > dump.html
+       lynx -force_html -dump dump.html > $@
+       -rm -f dump.html
+
+clean:
+       rm -f manual.txt
+       rm -f *.html *.aux *.log *.dvi *.ps *.tex
+       rm -f *.bck *~ .\#* \#*
+

diff --git a/doc/developer/configure.ac b/doc/developer/configure.ac
new file mode 100644 (file)
index 0000000..08f9225
--- /dev/null
+++ b/doc/developer/configure.ac
@@ -0,0 +1,74 @@
+dnl $Id: configure.ac,v 1.1 2004/02/13 04:22:39 rocky Exp $
+dnl Process this file with autoconf to produce a configure script.
+
+AC_INIT(manual.xml.in,0.0.1)
+
+AC_CHECK_PROGS(JADE, openjade jade, [nogood])
+
+if test "$JADE" = nogood ; then
+  AC_MSG_ERROR(You need jade to build the documentation. 
+  Get it http://openjade.sourceforge.net/)
+fi
+
+AC_CANONICAL_SYSTEM
+dnl ========================================================================
+case "$host_os" in
+  linux* ) 
+    if test -f /etc/redhat-release ; then
+      XML_DECL=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/dtds/decls/xml.dcl
+      HTML_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/html/docbook.dsl
+      PRINT_SS=/usr/share/sgml/docbook/dsssl-stylesheets-1.76/print/docbook.dsl
+      DOCBOOKX_DTD=/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd
+    else 
+      # Assume Debian
+      XML_DECL=/usr/lib/sgml/declaration/xml.decl
+      HTML_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/html/docbook.dsl
+      PRINT_SS=/usr/lib/sgml/stylesheet/dsssl/docbook/nwalsh/print/docbook.dsl
+      DOCBOOKX_DTS=/usr/share/sgml/docbook/dtd/xml/4.1/docbookx.dtd
+    fi
+    ;; 
+  darwin5* | darwin6* )
+    XML_DECL=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/dtds/decls/xml.dcl
+    HTML_SS=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/html/docbook.dsl
+    PRINT_SS=/sw/share/sgml/dsssl/docbook-dsssl-nwalsh/print/docbook.dsl
+    DOCBOOKX_DTD=/sw/share/xml/dtd/docbookx/4.1.2/docbookx.dtd
+    ;; 
+  * ) 
+    echo "Don't know $host_os. Picking up from environment."
+    XML_DECL=$XML_DECL
+    HTML_SS=$HTML_SS
+    PRINT_SS=$PRINT_SS
+esac
+
+AC_ARG_WITH(xml_decl,
+[  --with-xml-dcl=PATH    place to find xml.dcl file])
+if test -n "${xml_decl}"; then
+   XML_DECL=$xml_decl
+fi
+
+AC_ARG_WITH(html_ss,
+[  --with-html-ss=PATH    place to find html/docbook.dsl file])
+if test -n "${html_ss}"; then
+   HTML_SS=$html_ss
+fi
+
+AC_ARG_WITH(print_ss,
+[  --with-print-ss=PATH    place to find print/docbook.dsl file])
+if test -n "${print_ss}"; then
+   PRINT_SS=$print_ss
+fi
+
+AC_ARG_WITH(docbook_dtd,
+[  --with-dockbook-dtd=PATH    place to find docbookx.dtd file])
+if test -n "${docbook_dtd}"; then
+   DOCBOOKX_DTD=$docbook_dtd
+fi
+
+AC_SUBST(XML_DECL)
+AC_SUBST(HTML_SS)
+AC_SUBST(PRINT_SS)
+AC_SUBST(DOCBOOKX_DTD)
+AC_SUBST(JADE)
+
+AC_CONFIG_FILES([manual.xml Makefile])
+AC_OUTPUT

diff --git a/doc/developer/manual.xml b/doc/developer/manual.xml
index 2d08a34a5d7012b26e6f219501b60cb504df69f8..639acced36969862df8ec439ccc5a7f2b3c77ce9 100644 (file)
--- a/doc/developer/manual.xml
+++ b/doc/developer/manual.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
 
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/sw/share/xml/dtd/docbookx/4.1.2/docbookx.dtd"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "/usr/share/sgml/docbook/xml-dtd-4.1.2/docbookx.dtd"
 [
     <!ENTITY glossary SYSTEM "glossary.xml">
     <!ENTITY overview SYSTEM "overview.xml">
@@ -57,7 +57,7 @@
       <orgname> VideoLAN project </orgname>
     </affiliation>
   </collab>
-  <pubdate> $Id: manual.xml,v 1.6 2003/12/21 23:32:58 sam Exp $ </pubdate>
+  <pubdate> $Id: manual.xml,v 1.7 2004/02/13 04:22:39 rocky Exp $ </pubdate>
   <copyright> <year> 2001 </year>
               <holder> Christophe Massiot, for IDEALX S.A.S. </holder>
   </copyright>

diff --git a/doc/developer/manual.xml.in b/doc/developer/manual.xml.in
new file mode 100644 (file)
index 0000000..9c1857c
--- /dev/null
+++ b/doc/developer/manual.xml.in
@@ -0,0 +1,131 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "@DOCBOOKX_DTD@"
+[
+    <!ENTITY glossary SYSTEM "glossary.xml">
+    <!ENTITY overview SYSTEM "overview.xml">
+    <!ENTITY interface SYSTEM "interface.xml">
+    <!ENTITY input SYSTEM "input.xml">
+    <!ENTITY decoders SYSTEM "decoders.xml">
+    <!ENTITY video_output SYSTEM "video_output.xml">
+    <!ENTITY audio_output SYSTEM "audio_output.xml">
+    <!ENTITY ports SYSTEM "ports.xml">
+    <!ENTITY debugging SYSTEM "debugging.xml">
+    <!ENTITY history SYSTEM "history.xml">
+    <!ENTITY gfdl SYSTEM "gfdl.xml">
+]>
+
+<book>
+
+<title> VideoLAN Client API Documentation </title>
+
+<bookinfo>
+
+  <author>
+    <firstname> Christophe </firstname>
+    <surname> Massiot </surname>
+    <affiliation>
+      <jobtitle> <ulink url="mailto:christophe.massiot@idealx.com">
+      Developer </ulink> </jobtitle>
+      <orgname> <ulink url="http://www.idealx.com/"> IDEALX
+      S.A.S. </ulink> </orgname>
+      <orgdiv> Industrial Computing </orgdiv>
+    </affiliation>
+  </author>
+  <collab>
+    <collabname> <ulink url="mailto:sam@zoy.org"> Samuel Hocevar
+    </ulink> </collabname>
+    <affiliation>
+      <jobtitle> Developer </jobtitle>
+      <orgname> VideoLAN project </orgname>
+    </affiliation>
+  </collab>
+  <collab>
+    <collabname> Jean-Fran&ccedil;ois Lecomte </collabname>
+    <affiliation>
+      <jobtitle> <ulink url="mailto:jean-francois.lecomte@idealx.com">
+      Developer </ulink> </jobtitle>
+      <orgname> <ulink url="http://www.idealx.com/"> IDEALX
+      S.A.S. </ulink> </orgname>
+    </affiliation>
+  </collab>
+  <collab>
+    <collabname> <ulink url="mailto:henri@via.ecp.fr">Henri Fallon
+    </ulink> </collabname>
+    <affiliation>
+      <jobtitle> Developer </jobtitle>
+      <orgname> VideoLAN project </orgname>
+    </affiliation>
+  </collab>
+  <pubdate> $Id: manual.xml.in,v 1.1 2004/02/13 04:22:39 rocky Exp $ </pubdate>
+  <copyright> <year> 2001 </year>
+              <holder> Christophe Massiot, for IDEALX S.A.S. </holder>
+  </copyright>
+
+  <legalnotice> <para>
+      Permission is granted to copy, distribute and/or modify this document
+      under the terms of the GNU Free Documentation License, Version 1.1
+      or any later version published by the Free Software Foundation;
+      A copy of the license is included in the section entitled "GNU
+      Free Documentation License".
+  </para> </legalnotice>
+</bookinfo>
+
+<toc />
+
+<!-- ============================ GLOSSARY ============================
+  -->
+
+&glossary;
+
+<!-- ============================ OVERVIEW ============================
+  -->
+
+&overview;
+
+<!-- =========================== INTERFACE ============================
+  -->
+
+&interface;
+
+<!-- ============================= INPUT ==============================
+  -->
+
+&input;
+
+<!-- ============================ DECODERS ============================
+  -->
+
+&decoders;
+
+<!-- ========================== VIDEO OUTPUT ==========================
+  -->
+
+&video_output;
+
+<!-- ========================== AUDIO OUTPUT ==========================
+  -->
+
+&audio_output;
+
+<!-- ============================= PORTS ==============================
+  -->
+
+&ports;
+
+<!-- ======================= ADVANCED DEBUGGING =======================
+  -->
+
+&debugging;
+
+<!-- ======================== PROJECT HISTORY =========================
+  -->
+
+&history;
+
+<!-- ============================= GFDL ===============================
+  -->
+
+&gfdl;
+
+</book>