#
# Author: Pekka Riikonen <priikone@silcnet.org>
#
-# Copyright (C) GNU GPL 2001 Pekka Riikonen
+# Copyright (C) GNU GPL 2001 - 2002 Pekka Riikonen
#
# SILC Toolkit Reference Manual documentation script. This will automatically
# generate documentation from the source tree. This will require the
# Arguments checking
if [ $# -lt "4" ]; then
- echo "Usage: ./silcdoc <type> <source directory> <destination directory> <robodoc>"
- echo "Supported types: HTML"
+ echo "Usage: ./silcdoc <type> <source directory> <destination directory/file> <robodoc>"
+ echo "Supported types: HTML PS"
# echo "Supported types: HTML, ASCII, LATEX or RTF"
exit 1
fi
# Get all headers in the source directory
headers=`find $SRC -name "silc*.h"`
+#
+# PS documentation (from LATEX)
+#
+if [ "$TYPE" = "PS" ]; then
+ TYPE="LATEX"
+ rm -rf /tmp/silcdoc.tex
+ mkdir /tmp/silcdoc.tex
+ cp $headers /tmp/silcdoc.tex
+
+ path=`pwd`
+ cd /tmp/silcdoc.tex
+
+ # Generate cross reference files
+ headers=`find . -name "silc*.h" |cut -d/ -f2 |cut -d. -f1`
+ touch silcdoc_xref
+ for i in $headers
+ do
+ $ROBO $i.h $i.h.tex $TYPE INTERNAL GENXREF $i.h.xref
+ echo $i.h.xref >>silcdoc_xref
+ done
+
+ # Generate the detailed documentation
+ headers=`find . -name "silc*.h" |cut -d/ -f2 |cut -d. -f1`
+ for i in $headers
+ do
+ # remove internals
+ rm -rf $i_i.h
+ $ROBO $i.h $i.h.tex XREF silcdoc_xref $TYPE C SORT NOSOURCE SINGLEDOC
+ done
+
+ # Generate the index
+ $ROBO silcdoc_xref toolkit_mi INDEX $TYPE TITLE "SILC Toolkit Reference Manual"
+
+ # Generate the postscript
+ latex toolkit_mi
+ makeindex toolkit_mi
+ latex toolkit_mi
+ latex toolkit_mi
+ dvips toolkit_mi.dvi -o $DST
+
+ cd $path
+
+ rm -rf /tmp/silcdoc.tex
+ exit 0
+fi
+
#
# ASCII documentation
#
# Generate index template from the DIRECTORY files. The template for
# the generated index template is INDEX.tmpl.
- files=`find $SRC -name "DIRECTORY"`
- for i in $files
+ dfiles=`find $SRC -name "DIRECTORY"`
+ for i in $dfiles
do
# Get library name
name=`grep "@LIBRARY=" $i |cut -d= -f2`
f="/tmp/silcdoc_html.html/$i"
sh gen.sh $DST gen_index.php 1 $f $f
cp /tmp/silcdoc_html.html/$i $DST
-echo $f
+ done
+
+ # Generate cross reference files
+ path=`pwd`
+ cd /tmp/silcdoc.html
+ headers=`find . -name "silc*.h" |cut -d/ -f2 |cut -d. -f1`
+ cd $path
+ touch $DST/silcdoc_xref
+ for i in $headers
+ do
+ $ROBO /tmp/silcdoc.html/$i.h $DST/$i.html $TYPE GENXREF $DST/$i.xref
+ echo $DST/$i.xref >>$DST/silcdoc_xref
done
# Generate the actual detailed documentation
cd $path
for i in $headers
do
- $ROBO /tmp/silcdoc.html/$i.h $DST/$i.html $TYPE
+ $ROBO /tmp/silcdoc.html/$i.h $DST/$i.html XREF $DST/silcdoc_xref $TYPE
# Generate the TOC file
sh gen.sh $DST gen_index.php 1 $DST/$i.html $DST/$i.html
done
# Generate the index and TOC files from the DIRECTORY files
- files=`find $SRC -name "DIRECTORY"`
- for i in $files
+ for i in $dfiles
do
# Get library name
name=`grep "@LIBRARY=" $i |cut -d= -f2`
sed -e "/@VERSION@/s//$version/" -e "/@DATE@/s//$curdate/" -e "/@BODY@/ r $DST/index.html.tmp" -e s/@BODY@//g $index >$DST/index.html
sh gen.sh $DST gen_index.php 2 $DST/index.html $DST/index.html
+ # Generate the index toolkit_index.html file
+ $ROBO $DST/silcdoc_xref $DST/toolkit_index.html INDEX HTML TITLE "SILC Toolkit Index"
+ sh gen.sh $DST gen_index.php 2 $DST/toolkit_index.html $DST/toolkit_index.html
+
+ # Cleanup
rm -rf $DST/index.html.tmp
rm -rf /tmp/silcdoc.html
rm -rf /tmp/silcdoc_html.html
+ exit 0
fi