stv0g/comedilib
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Comedilib.pdf can now be generated with

Browse source 
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.
This commit is contained in:
Bernd Porr 2012-04-23 00:23:03 +01:00
parent 428ad43ebc
commit 0d8c6e9661
11 changed files with 19 additions and 35 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/Makefile.am
View 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

1
doc/calibration_funcref.txt
View file

@ -1,3 +1,4 @@
Calibration
Function: comedi_apply_calibration -- set hardware calibration from file
Retval: int
Param: comedi_t *device

17
doc/comedilib.xml
View file

@ -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>

1
doc/command_funcref.txt
View file

@ -1,3 +1,4 @@
Asynchronous commands
Function: comedi_cancel -- stop streaming input/output in progress
Retval: int
Param: comedi_t * device

1
doc/deprecated_funcref.txt
View file

@ -1,3 +1,4 @@
Deprecated functions
Function: comedi_dio_bitfield -- read/write multiple digital channels
Retval: int
Param: comedi_t * device

1
doc/dio_funcref.txt
View file

@ -1,3 +1,4 @@
Digital I/O
Function: comedi_dio_bitfield2 -- read/write multiple digital channels
Retval: int
Param: comedi_t * device

1
doc/error_funcref.txt
View file

@ -1,3 +1,4 @@
Error reporting
Function: comedi_errno -- number of last Comedilib error
Retval: int
Param: void

1
doc/extensions_funcref.txt
View file

@ -1,3 +1,4 @@
Extensions
Function: comedi_arm -- arm a subdevice
Retval: int
Param: comedi_t * device

1
doc/funcref
View file

@ -1,3 +1,4 @@
Core Functions
Function: comedi_close -- close a Comedi device
Retval: int
Param: comedi * device

6
doc/mkref
View file

@ -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 = <>){

21
doc/reference.xml
View 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>