Comedilib.pdf can now be generated with
authorBernd Porr <berndporr@f2s.com>
Sun, 22 Apr 2012 23:23:03 +0000 (00:23 +0100)
committerBernd Porr <berndporr@f2s.com>
Sun, 22 Apr 2012 23:23:03 +0000 (00:23 +0100)
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.

doc/Makefile.am
doc/calibration_funcref.txt
doc/comedilib.xml
doc/command_funcref.txt
doc/deprecated_funcref.txt
doc/dio_funcref.txt
doc/error_funcref.txt
doc/extensions_funcref.txt
doc/funcref
doc/mkref
doc/reference.xml

index d5e1db5d037bb6b6637c4f41972d24fe45abcff8..f304226b936576f7584827856af3ded2862680fe 100644 (file)
@@ -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
index e07fc460c8e7d4a5ea3e7eabaa5847a22217a16a..9bb05ad8c8d97503146a4122b47c33f19e68387a 100644 (file)
@@ -1,3 +1,4 @@
+Calibration
 Function: comedi_apply_calibration -- set hardware calibration from file
 Retval: int
 Param: comedi_t *device
index 5bb9ed52787e89e65fc0efe8abb63a7cf73ff1ff..f7bfabed5d41d574fa1ce25279960d85ef4ecc93 100644 (file)
 
        </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>
index f360b26c20165bfc8c2ccd4b0a33f2f01252ca29..167fe0adee772e1f22ab2a8b93b479f2c0d13ba3 100644 (file)
@@ -1,3 +1,4 @@
+Asynchronous commands
 Function: comedi_cancel -- stop streaming input/output in progress
 Retval: int
 Param: comedi_t * device
index 63be5942f64d4f6052b355a7f7220db3419a82c3..5ddb10ce6658d008eb1d7a89b9b10ddbb9a2b70d 100644 (file)
@@ -1,3 +1,4 @@
+Deprecated functions
 Function: comedi_dio_bitfield -- read/write multiple digital channels
 Retval: int
 Param: comedi_t * device
index fb78a6c1d0261a0c49f972b3b161b46ce76d7ccf..ffe2e2e83b19a65a85cf06769a0d3f3d518b64cc 100644 (file)
@@ -1,3 +1,4 @@
+Digital I/O
 Function: comedi_dio_bitfield2 -- read/write multiple digital channels
 Retval: int
 Param: comedi_t * device
index 133b4fc0a5cdfd39fb487af76563e725b58bc727..58728023b5714b1062d31c5c622c9b93cc918db7 100644 (file)
@@ -1,3 +1,4 @@
+Error reporting
 Function: comedi_errno -- number of last Comedilib error
 Retval: int
 Param: void
index bb533efd6167b973267eb4c725ea13d8519dc46e..0abb2012057933958d49006b8d88b718374e12dc 100644 (file)
@@ -1,3 +1,4 @@
+Extensions
 Function: comedi_arm -- arm a subdevice
 Retval: int
 Param: comedi_t * device
index 3b880e6a0743576bf7d53bcae31b66aa186a2e63..1df2f31b3b90313e16c1bebc83c54fb3b294bc21 100644 (file)
@@ -1,3 +1,4 @@
+Core Functions
 Function: comedi_close -- close a Comedi device
 Retval: int
 Param: comedi * device
index 8ded9c1911a58bc6cb1580ec880eb4cd7606bf65..10a62844206f553f622d204cb9144230628f598a 100755 (executable)
--- 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 = <>){
index 465ea2e92cafad9183a77b650b8b3dac6b4ca2ed..6a5320dfd6e91a922339dfe3e0094e0a6946e8ab 100644 (file)
@@ -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>