Bib-1 and SRU diagnostics in manual (appendix) YAZ-748

Tables in manual pages don't work well. So no man entry at this
time.

diff --git a/doc/Makefile.am b/doc/Makefile.am
index b6edb89..a6efd8e 100644 (file)
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -8,7 +8,7 @@ XMLFILES=bookinfo.xml introduction.xml installation.xml \
  asn.xml tools.xml odr.xml comstack.xml server.xml license.xml \
  future.xml zoom.xml credits.xml gfs-options.xml \
  yaz.xml soap.xml gfs-virtual.xml gfs-synopsis.xml \
- std-oid-table.xml manref.xml local.ent
+ std-oid-table.xml  bib1-diag-table.xml srw-diag-table.xml manref.xml local.ent
 
 HTMLFILES = index.html
 
@@ -34,6 +34,12 @@ EXTRA_DIST = $(XMLFILES) $(SUPPORTFILES) $(man_MANS) $(REFFILES) \
 std-oid-table.xml: $(srcdir)/../src/oid.csv
        $(TCLSH) $(srcdir)/../src/oidtoc.tcl $(srcdir) $(srcdir)/../src/oid.csv std-oid-table.xml
 
+bib1-diag-table.xml: $(srcdir)/../src/bib1.csv
+       $(TCLSH) $(srcdir)/../src/csvtodiag.tcl $(srcdir)/../src/bib1.csv bib1-diag-table.xml bib1-diag-table
+
+srw-diag-table.xml: $(srcdir)/../src/srw.csv
+       $(TCLSH) $(srcdir)/../src/csvtodiag.tcl $(srcdir)/../src/srw.csv srw-diag-table.xml srw-diag-table
+
 yaz-client.1: $(srcdir)/yaz-client-man.xml
        $(MAN_COMPILE) $(srcdir)/yaz-client-man.xml
 

diff --git a/doc/entities.ent b/doc/entities.ent
index eabcb33..4007fd4 100644 (file)
--- a/doc/entities.ent
+++ b/doc/entities.ent
@@ -11,6 +11,8 @@
 <!ENTITY chap-server SYSTEM "server.xml">
 <!ENTITY chap-future SYSTEM "future.xml">
 <!ENTITY std-oid-table SYSTEM "std-oid-table.xml">
+<!ENTITY bib1-diag-table SYSTEM "bib1-diag-table.xml">
+<!ENTITY srw-diag-table SYSTEM "srw-diag-table.xml">
 <!ENTITY app-license SYSTEM "license.xml">
 <!ENTITY app-indexdata SYSTEM "indexdata.xml">
 <!ENTITY app-credits SYSTEM "credits.xml">

diff --git a/doc/yaz.xml b/doc/yaz.xml
index 17989c6..e3445a4 100644 (file)
--- a/doc/yaz.xml
+++ b/doc/yaz.xml
@@ -40,6 +40,20 @@
  &std-oid-table;
  </appendix>
 
+ <appendix id="bib1-diagnostics"><title>Bib-1 diagnostics</title>
+   <para>
+     List of Bib-1 diagnostics that are known to YAZ.
+   </para>
+   &bib1-diag-table;
+ </appendix>
+
+ <appendix id="sru-diagnostics"><title>SRU diagnostics</title>
+   <para>
+     List of SRU diagnostics that are known to YAZ.
+   </para>
+   &srw-diag-table;
+ </appendix>
+
  &app-license;
  &app-indexdata;
  &app-credits;

diff --git a/src/Makefile.am b/src/Makefile.am
index 3987081..07e125b 100644 (file)
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -17,7 +17,7 @@ illdata_DATA=ill9702.asn item-req.asn ill.tcl oclc-ill-req-ext.asn
 
 EXTRA_DIST=$(tabdata_DATA) $(illdata_DATA) \
  charconv.tcl codetables.xml codetables-iso5426.xml \
- csvtodiag.tcl csvtobib1.tcl csvtosrw.tcl bib1.csv srw.csv \
+ csvtodiag.tcl bib1.csv srw.csv \
  csvtosru_update.tcl sru_update.csv mk_version.tcl \
  oidtoc.tcl oid.csv sc_test.c
 
@@ -50,11 +50,11 @@ oid_std.c $(top_srcdir)/include/yaz/oid_std.h: oidtoc.tcl oid.csv
        $(TCLSH) $(srcdir)/oidtoc.tcl $(srcdir) $(srcdir)/oid.csv oid_std.c oid_std.h
 
 # Generate diagnostics from CSVs
-diagbib1.c $(top_srcdir)/include/yaz/diagbib1.h: csvtobib1.tcl bib1.csv
-       $(TCLSH) $(srcdir)/csvtobib1.tcl $(srcdir)
+diagbib1.c $(top_srcdir)/include/yaz/diagbib1.h: bib1.csv
+       $(TCLSH) $(srcdir)/csvtodiag.tcl $(srcdir)/bib1.csv $(srcdir)/diagbib1.c $(top_srcdir)/include/yaz/diagbib1.h bib1 diagbib1_str
 
-diagsrw.c $(top_srcdir)/include/yaz/diagsrw.h: csvtosrw.tcl srw.csv
-       $(TCLSH) $(srcdir)/csvtosrw.tcl $(srcdir)
+diagsrw.c $(top_srcdir)/include/yaz/diagsrw.h: srw.csv
+       $(TCLSH) $(srcdir)/csvtodiag.tcl $(srcdir)/srw.csv $(srcdir)/diagsrw.c $(top_srcdir)/include/yaz/diagsrw.h srw
 
 diagsru_update.c $(top_srcdir)/include/yaz/diagsru_update.h: csvtosru_update.tcl sru_update.csv
        $(TCLSH) $(srcdir)/csvtosru_update.tcl $(srcdir)

diff --git a/src/csvtobib1.tcl b/src/csvtobib1.tcl
deleted file mode 100644 (file)
index 3cfcd28..0000000
--- a/src/csvtobib1.tcl
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/usr/bin/tclsh
-#
-# This file is part of the YAZ toolkit
-# Copyright (C) Index Data
-# See the file LICENSE for details.
-#
-#
-# Converts a CSV file with Bib-1 diagnostics to C+H file for easy
-# maintenance
-#
-
-source [lindex $argv 0]/csvtodiag.tcl
-
-csvtodiag [list [lindex $argv 0]/bib1.csv diagbib1.c [lindex $argv 0]/../include/yaz/diagbib1.h] bib1 diagbib1_str

diff --git a/src/csvtodiag.tcl b/src/csvtodiag.tcl
index 6dcd1be..12e263c 100644 (file)
--- a/src/csvtodiag.tcl
+++ b/src/csvtodiag.tcl
@@ -94,3 +94,55 @@ YAZ_END_CDECL
     close $hfile
 }
 
+proc csvto_xml {csvfname xmlfname id} {
+    set xfile [open $xmlfname w]
+    set csv [open $csvfname r]
+
+    puts $xfile "<!-- Generated by csvtodiag.tcl from $csvfname -->"
+    puts $xfile "<informaltable id=\"${id}\">"
+    puts $xfile {<tgroup cols="2">}
+    puts $xfile {<colspec colwidth="1*" colname="code"></colspec>}
+    puts $xfile {<colspec colwidth="4*" colname="text"></colspec>}
+    puts $xfile {<thead>}
+    puts $xfile {<row>}
+    puts $xfile {<entry>Code</entry>}
+    puts $xfile {<entry>Text</entry>}
+    puts $xfile {</row>}
+    puts $xfile {</thead>}
+    puts $xfile {<tbody>}
+
+    set lineno 0
+    while {1} {
+       incr lineno
+       set cnt [gets $csv line]
+       if {$cnt < 0} {
+           break
+       }
+       if {[regexp {([0-9]+)[^\"]*"([^\"]*)"} $line s code msg]} {
+           puts $xfile {<row>}
+           puts $xfile {<entry>}
+           puts $xfile $code
+           puts $xfile {</entry><entry>}
+           puts $xfile $msg
+           puts $xfile {</entry>}
+           puts $xfile {</row>}
+       }
+    }
+    puts $xfile {</tbody>}
+    puts $xfile {</tgroup>}
+    puts $xfile {</informaltable>}
+
+    close $xfile
+    close $csv
+}
+
+if {[llength $argv] >= 4} {
+    set alias {}
+    if {[llength $argv] >= 5} {
+       set alias [lindex $argv 4]
+    }
+    csvtodiag [list [lindex $argv 0] [lindex $argv 1] [lindex $argv 2]] \
+       [lindex $argv 3] $alias
+} elseif {[llength $argv] == 3} {
+    csvto_xml [lindex $argv 0] [lindex $argv 1] [lindex $argv 2]
+}
\ No newline at end of file

diff --git a/src/csvtosrw.tcl b/src/csvtosrw.tcl
deleted file mode 100644 (file)
index 699eea6..0000000
--- a/src/csvtosrw.tcl
+++ /dev/null
@@ -1,14 +0,0 @@
-#!/usr/bin/tclsh
-#
-# This file is part of the YAZ toolkit
-# Copyright (C) Index Data
-# See the file LICENSE for details.
-#
-#
-# Converts a CSV file with SRW diagnostics to C+H file for easy
-# maintenance
-#
-
-source [lindex $argv 0]/csvtodiag.tcl
-
-csvtodiag [list [lindex $argv 0]/srw.csv diagsrw.c [lindex $argv 0]/../include/yaz/diagsrw.h] srw {}

diff --git a/win/makefile b/win/makefile
index fd1b194..9d9395d 100644 (file)
--- a/win/makefile
+++ b/win/makefile
@@ -862,11 +862,11 @@ $(SRCDIR)\oid_std.c: $(SRCDIR)\oid.csv
 
 $(SRCDIR)\diagbib1.c: $(SRCDIR)\bib1.csv
        @cd $(SRCDIR)
-       $(TCL) csvtobib1.tcl $(SRCDIR)
+       $(TCL) csvtodiag.tcl bib1.csv diagbib1.c $(INCLDIR)\yaz\diagbib1.h bib1 diagbib1_str
 
 $(SRCDIR)\diagsrw.c: $(SRCDIR)\srw.csv
        @cd $(SRCDIR)
-       $(TCL) csvtosrw.tcl $(SRCDIR)
+       $(TCL) csvtodiag.tcl srw.csv diagsrw.c $(INCLDIR)\yaz\diagsrw.h srw
 
 $(SRCDIR)\diagsru_update.c: $(SRCDIR)\sru_update.csv
        @cd $(SRCDIR)