From: Bernd Porr <berndporr@f2s.com>
Date: Sun, 22 Apr 2012 23:23:03 +0000 (+0100)
Subject: Comedilib.pdf can now be generated with
X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=0d8c6e966124e8dd7a1f7fe66bc9b9b87c186557;p=comedilib.git

Comedilib.pdf can now be generated with
dblatex -t pdf ./comedilib.xml

There were two major issues in the comedilb.xml:
1) there were too many nested sections so that
   latex ran out of sub-sub-sub-sub-sections.
2) A section needs a title and can no longer
   exist without one. The first line
   of the textfiles contains now the title
   and will be inserted by mkref into the xml file.

todo: switch from xmlto to dblatex for the pdf generation
and re-enable it in the makefile.
---

diff --git a/doc/Makefile.am b/doc/Makefile.am
index d5e1db5..f304226 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -20,8 +20,7 @@ all_html = $(srcdir)/doc_html
 install_html = install_html
 uninstall_html = uninstall_html
 
-#pdf output for xmlto is broken in debian etch
-#dist_pdf_DATA = comedilib.pdf
+# dist_pdf_DATA = comedilib.pdf
 dist_pdf_DATA =
 
 all_man = $(srcdir)/man
diff --git a/doc/calibration_funcref.txt b/doc/calibration_funcref.txt
index e07fc46..9bb05ad 100644
--- a/doc/calibration_funcref.txt
+++ b/doc/calibration_funcref.txt
@@ -1,3 +1,4 @@
+Calibration
 Function: comedi_apply_calibration -- set hardware calibration from file
 Retval: int
 Param: comedi_t *device
diff --git a/doc/comedilib.xml b/doc/comedilib.xml
index 5bb9ed5..f7bfabe 100644
--- a/doc/comedilib.xml
+++ b/doc/comedilib.xml
@@ -81,19 +81,12 @@
 
 	</articleinfo>
 
-	<section>
-		<!--			This section prevents docbook from pulling the entire next section into the
-			main table of contents page of the html output//-->
-	</section>
-	<section>
-		<title>&comedi;</title>
-		<xi:include href="intro.xml"/>
-		<xi:include href="install.xml"/>
-		<xi:include href="tutorial.xml"/>
-		<xi:include href="other.xml"/>
-		<xi:include href="driverwriting.xml"/>
-	</section>
+	<xi:include href="intro.xml"/>
+	<xi:include href="install.xml"/>
+	<xi:include href="tutorial.xml"/>
+	<xi:include href="other.xml"/>
 	<xi:include href="reference.xml"/>
+	<xi:include href="driverwriting.xml"/>
 	<xi:include href="glossary.xml"/>
 
 </article>
diff --git a/doc/command_funcref.txt b/doc/command_funcref.txt
index f360b26..167fe0a 100644
--- a/doc/command_funcref.txt
+++ b/doc/command_funcref.txt
@@ -1,3 +1,4 @@
+Asynchronous commands
 Function: comedi_cancel -- stop streaming input/output in progress
 Retval: int
 Param: comedi_t * device
diff --git a/doc/deprecated_funcref.txt b/doc/deprecated_funcref.txt
index 63be594..5ddb10c 100644
--- a/doc/deprecated_funcref.txt
+++ b/doc/deprecated_funcref.txt
@@ -1,3 +1,4 @@
+Deprecated functions
 Function: comedi_dio_bitfield -- read/write multiple digital channels
 Retval: int
 Param: comedi_t * device
diff --git a/doc/dio_funcref.txt b/doc/dio_funcref.txt
index fb78a6c..ffe2e2e 100644
--- a/doc/dio_funcref.txt
+++ b/doc/dio_funcref.txt
@@ -1,3 +1,4 @@
+Digital I/O
 Function: comedi_dio_bitfield2 -- read/write multiple digital channels
 Retval: int
 Param: comedi_t * device
diff --git a/doc/error_funcref.txt b/doc/error_funcref.txt
index 133b4fc..5872802 100644
--- a/doc/error_funcref.txt
+++ b/doc/error_funcref.txt
@@ -1,3 +1,4 @@
+Error reporting
 Function: comedi_errno -- number of last Comedilib error
 Retval: int
 Param: void
diff --git a/doc/extensions_funcref.txt b/doc/extensions_funcref.txt
index bb533ef..0abb201 100644
--- a/doc/extensions_funcref.txt
+++ b/doc/extensions_funcref.txt
@@ -1,3 +1,4 @@
+Extensions
 Function: comedi_arm -- arm a subdevice
 Retval: int
 Param: comedi_t * device
diff --git a/doc/funcref b/doc/funcref
index 3b880e6..1df2f31 100644
--- a/doc/funcref
+++ b/doc/funcref
@@ -1,3 +1,4 @@
+Core Functions
 Function: comedi_close -- close a Comedi device
 Retval: int
 Param: comedi * device
diff --git a/doc/mkref b/doc/mkref
index 8ded9c1..10a6284 100755
--- a/doc/mkref
+++ b/doc/mkref
@@ -7,6 +7,9 @@ $header="#include &lt;comedilib.h&gt;";
 $end = "";
 $refentry_end = "";
 
+$s = <>;
+chomp $s;
+
 print
 '<?xml version="1.0" encoding="utf-8"?>
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
@@ -16,6 +19,9 @@ print
 ]>
 <!--This file is autogenerated.  Do not edit-->
 <section>
+<title>';
+print $s;
+print '</title>
 ';
 
 while($s = <>){
diff --git a/doc/reference.xml b/doc/reference.xml
index 465ea2e..6a5320d 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -727,34 +727,13 @@ raw/physical conversion functions.
 
 	<section id="functionreference">
 		<title>Functions</title>
-		<section>
-			<title>Core</title>
 			<xi:include href="funcref.xml"/>
-		</section>
-		<section>
-			<title>Asyncronous commands</title>
 			<xi:include href="command_funcref.xml"/>
-		</section>
-		<section>
-			<title>Calibration</title>
 			<xi:include href="calibration_funcref.xml"/>
-		</section>
-		<section>
-			<title>Digital I/O</title>
 			<xi:include href="dio_funcref.xml"/>
-		</section>
-		<section>
-			<title>Error reporting</title>
 			<xi:include href="error_funcref.xml"/>
-		</section>
-		<section>
-			<title>Extensions</title>
 			<xi:include href="extensions_funcref.xml"/>
-		</section>
-		<section>
-			<title>Deprecated</title>
 			<xi:include href="deprecated_funcref.xml"/>
-		</section>
 	</section>
 	<xi:include href="drivers.xml"/>
 </section>