2004-08-16 17:41:11 +01:00
|
|
|
#!/bin/bash
|
|
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
## ================================================================
|
|
|
|
|
## Logtalk - Open source object-oriented logic programming language
|
2007-06-24 14:27:35 +01:00
|
|
|
## Release 2.30.2
|
2004-08-16 17:41:11 +01:00
|
|
|
##
|
2007-01-10 12:46:10 +00:00
|
|
|
## Copyright (c) 1998-2007 Paulo Moura. All Rights Reserved.
|
2007-06-12 11:39:47 +01:00
|
|
|
## ================================================================
|
|
|
|
|
|
|
|
|
|
if ! [ "$LOGTALKHOME" ]; then
|
|
|
|
|
echo "The environment variable LOGTALKHOME should be defined first, pointing"
|
|
|
|
|
echo "to your Logtalk installation directory!"
|
|
|
|
|
echo "Trying the default locations for the Logtalk installation..."
|
|
|
|
|
if [ -d "/usr/local/share/logtalk" ]; then
|
|
|
|
|
LOGTALKHOME=/usr/local/share/logtalk
|
|
|
|
|
echo "... using Logtalk installation found at /usr/local/share/logtalk"
|
|
|
|
|
elif [ -d "/usr/share/logtalk" ]; then
|
|
|
|
|
LOGTALKHOME=/usr/share/logtalk
|
|
|
|
|
echo "... using Logtalk installation found at /usr/share/logtalk"
|
|
|
|
|
elif [ -d "/opt/local/share/logtalk" ]; then
|
|
|
|
|
LOGTALKHOME=/opt/local/share/logtalk
|
|
|
|
|
echo "... using Logtalk installation found at /opt/local/share/logtalk"
|
|
|
|
|
elif [ -d "/opt/share/logtalk" ]; then
|
|
|
|
|
LOGTALKHOME=/opt/share/logtalk
|
|
|
|
|
echo "... using Logtalk installation found at /opt/share/logtalk"
|
|
|
|
|
else
|
|
|
|
|
echo "... unable to locate Logtalk installation directory!"
|
|
|
|
|
echo
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
echo
|
|
|
|
|
elif ! [ -d "$LOGTALKHOME" ]; then
|
|
|
|
|
echo "The environment variable LOGTALKHOME points to a non-existing directory!"
|
|
|
|
|
echo "Its current value is: $LOGTALKHOME"
|
|
|
|
|
echo "The variable must be set to your Logtalk installation directory!"
|
|
|
|
|
echo
|
|
|
|
|
exit 1
|
|
|
|
|
fi
|
|
|
|
|
export LOGTALKHOME
|
|
|
|
|
|
|
|
|
|
if ! [ "$LOGTALKUSER" ]; then
|
|
|
|
|
echo "The environment variable LOGTALKUSER should be defined first, pointing"
|
|
|
|
|
echo "to your Logtalk user directory!"
|
|
|
|
|
echo "Trying the default location for the Logtalk user directory..."
|
|
|
|
|
export LOGTALKUSER=$HOME/logtalk
|
|
|
|
|
if [ -d "$LOGTALKUSER" ]; then
|
|
|
|
|
echo "... using Logtalk user directory found at $LOGTALKUSER"
|
|
|
|
|
else
|
|
|
|
|
echo "... Logtalk user directory not found at default location. Creating a"
|
|
|
|
|
echo "new Logtalk user directory by running the \"cplgtdirs\" shell script:"
|
|
|
|
|
cplgtdirs
|
|
|
|
|
fi
|
|
|
|
|
elif ! [ -d "$LOGTALKUSER" ]; then
|
|
|
|
|
echo "Cannot find \$LOGTALKUSER directory! Creating a new Logtalk user directory"
|
|
|
|
|
echo "by running the \"cplgtdirs\" shell script:"
|
|
|
|
|
cplgtdirs
|
|
|
|
|
fi
|
|
|
|
|
echo
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2004-12-05 21:52:49 +00:00
|
|
|
html_xslt="$LOGTALKUSER/xml/lgthtml.xsl"
|
|
|
|
|
xhtml_xslt="$LOGTALKUSER/xml/lgtxhtml.xsl"
|
2004-08-16 17:41:11 +01:00
|
|
|
|
|
|
|
|
format=xhtml
|
|
|
|
|
|
|
|
|
|
directory="."
|
|
|
|
|
|
|
|
|
|
index_file=index.html
|
|
|
|
|
index_title="Entity documentation index"
|
|
|
|
|
|
|
|
|
|
processor=xsltproc
|
|
|
|
|
# processor=xalan
|
|
|
|
|
# processor=sabcmd
|
|
|
|
|
|
|
|
|
|
usage_help()
|
|
|
|
|
{
|
|
|
|
|
echo
|
|
|
|
|
echo "This script converts all Logtalk XML files documenting files in the"
|
|
|
|
|
echo "current directory to XHTML or HTML files"
|
|
|
|
|
echo
|
|
|
|
|
echo "Usage:"
|
|
|
|
|
echo " $0 -f format -d directory -i index -t title -p processor"
|
|
|
|
|
echo " $0 -h"
|
|
|
|
|
echo
|
|
|
|
|
echo "Optional arguments:"
|
|
|
|
|
echo " -f output file format (either xhtml or html; default is $format)"
|
|
|
|
|
echo " -d output directory for the generated files (default is $directory)"
|
|
|
|
|
echo " -i name of the index file (default is $index_file)"
|
|
|
|
|
echo " -t title to be used on the index file (default is $index_title)"
|
|
|
|
|
echo " -p XSLT processor (xsltproc, xalan, or sabcmd; default is $processor)"
|
|
|
|
|
echo " -h help"
|
|
|
|
|
echo
|
|
|
|
|
exit 1
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
create_index_file()
|
|
|
|
|
{
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "" > "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
|
|
|
|
|
case "$format" in
|
|
|
|
|
xhtml)
|
2005-05-24 00:33:41 +01:00
|
|
|
echo "<?xml version=\"1.0\" encoding=\"utf-8\"?>" >> "$index_file"
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "<?xml-stylesheet href=\"logtalk.css\" type=\"text/css\"?>" >> "$index_file"
|
|
|
|
|
echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">" >> "$index_file"
|
|
|
|
|
echo "<html lang=\"en\" xml:lang=\"en\" xmlns=\"http://www.w3.org/1999/xhtml\">" >> "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
;;
|
|
|
|
|
html)
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\" \"http://www.w3.org/TR/html4/strict.dtd\">" >> "$index_file"
|
|
|
|
|
echo "<html>" >> "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
;;
|
|
|
|
|
esac
|
|
|
|
|
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "<head>" >> "$index_file"
|
|
|
|
|
echo " <meta http-equiv=\"content-type\" content=\"text/html; charset=utf-8\"/>" >> "$index_file"
|
|
|
|
|
echo " <title>"$index_title"</title>" >> "$index_file"
|
|
|
|
|
echo " <link rel=\"stylesheet\" href=\"logtalk.css\" type=\"text/css\"/>" >> "$index_file"
|
|
|
|
|
echo "</head>" >> "$index_file"
|
|
|
|
|
echo "<body>" >> "$index_file"
|
|
|
|
|
echo "<h1>"$index_title"</h1>" >> "$index_file"
|
|
|
|
|
echo "<ul>" >> "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
|
|
|
|
|
for file in *.xml; do
|
|
|
|
|
name="`expr "$file" : '\(.*\)\.[^./]*$' \| "$file"`"
|
2005-08-08 13:13:45 +01:00
|
|
|
entity=${name%_*}
|
|
|
|
|
pars=${name##*_}
|
2004-08-16 17:41:11 +01:00
|
|
|
echo " indexing $name.html"
|
2005-08-08 13:13:45 +01:00
|
|
|
if [ $pars -gt 0 ]
|
|
|
|
|
then
|
|
|
|
|
echo " <li><a href=\""$name".html\">"$entity"/"$pars"</a></li>" >> "$index_file"
|
|
|
|
|
else
|
|
|
|
|
echo " <li><a href=\""$name".html\">"$entity"</a></li>" >> "$index_file"
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
done
|
|
|
|
|
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "</ul>" >> "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
|
|
|
|
|
date="`eval date`"
|
|
|
|
|
|
2005-04-23 00:57:45 +01:00
|
|
|
echo "<p>Generated on "$date"</p>" >> "$index_file"
|
|
|
|
|
echo "</body>" >> "$index_file"
|
|
|
|
|
echo "</html>" >> "$index_file"
|
2004-08-16 17:41:11 +01:00
|
|
|
}
|
|
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
while getopts "f:d:i:t:p:h" Option
|
|
|
|
|
do
|
|
|
|
|
case $Option in
|
|
|
|
|
f) f_arg="$OPTARG";;
|
|
|
|
|
d) d_arg="$OPTARG";;
|
|
|
|
|
i) i_arg="$OPTARG";;
|
|
|
|
|
t) t_arg="$OPTARG";;
|
|
|
|
|
p) p_arg="$OPTARG";;
|
|
|
|
|
h) usage_help;;
|
|
|
|
|
*) usage_help;;
|
|
|
|
|
esac
|
|
|
|
|
done
|
|
|
|
|
|
|
|
|
|
if [[ "$f_arg" != "" && "$f_arg" != "xhtml" && "$f_arg" != "html" ]]
|
2005-12-24 18:00:21 +00:00
|
|
|
then
|
2007-06-12 11:39:47 +01:00
|
|
|
echo "Error! Unsupported output format: $f_arg"
|
|
|
|
|
usage_help
|
2005-12-24 18:00:21 +00:00
|
|
|
exit 1
|
2007-06-12 11:39:47 +01:00
|
|
|
elif [ "$f_arg" != "" ]
|
2004-08-16 17:41:11 +01:00
|
|
|
then
|
2007-06-12 11:39:47 +01:00
|
|
|
format=$f_arg
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [[ "$d_arg" != "" && ! -d "$d_arg" ]]
|
|
|
|
|
then
|
|
|
|
|
echo "Error! directory does not exists: $d_arg"
|
|
|
|
|
usage_help
|
|
|
|
|
exit 1
|
|
|
|
|
elif [ "$d_arg" != "" ]
|
|
|
|
|
then
|
|
|
|
|
directory=$d_arg
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [[ "$i_arg" != "" ]]
|
|
|
|
|
then
|
|
|
|
|
index_file=$i_arg
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [[ "$t_arg" != "" ]]
|
|
|
|
|
then
|
|
|
|
|
index_title=$t_arg
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [[ "$p_arg" != "" && "$p_arg" != "xsltproc" && "$p_arg" != "xalan" && "$p_arg" != "sabcmd" ]]
|
|
|
|
|
then
|
|
|
|
|
echo "Error! Unsupported XSLT processor: $p_arg"
|
|
|
|
|
usage_help
|
|
|
|
|
exit 1
|
|
|
|
|
elif [ "$p_arg" != "" ]
|
|
|
|
|
then
|
|
|
|
|
processor=$p_arg
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [ "$format" = "xhtml" ]
|
|
|
|
|
then
|
|
|
|
|
xslt=$xhtml_xslt
|
|
|
|
|
else
|
|
|
|
|
xslt=$html_xslt
|
|
|
|
|
fi
|
2006-11-07 17:11:47 +00:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if ! [[ -a "./logtalk.dtd" ]]
|
|
|
|
|
then
|
|
|
|
|
cp "$LOGTALKHOME"/xml/logtalk.dtd .
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if ! [[ -a "./custom.ent" ]]
|
|
|
|
|
then
|
|
|
|
|
cp "$LOGTALKUSER"/xml/custom.ent .
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if ! [[ -a "./logtalk.xsd" ]]
|
|
|
|
|
then
|
|
|
|
|
cp "$LOGTALKHOME"/xml/logtalk.xsd .
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if ! [[ -a "$directory/logtalk.css" ]]
|
|
|
|
|
then
|
|
|
|
|
cp "$LOGTALKUSER"/xml/logtalk.css "$directory"
|
|
|
|
|
fi
|
2004-08-16 17:41:11 +01:00
|
|
|
|
2007-06-12 11:39:47 +01:00
|
|
|
if [[ `(ls *.xml | wc -l) 2> /dev/null` -gt 0 ]]
|
|
|
|
|
then
|
|
|
|
|
echo
|
|
|
|
|
echo "converting XML files..."
|
|
|
|
|
for file in *.xml; do
|
|
|
|
|
echo " converting $file"
|
|
|
|
|
name="`expr "$file" : '\(.*\)\.[^./]*$' \| "$file"`"
|
|
|
|
|
case "$processor" in
|
|
|
|
|
xsltproc) eval xsltproc -o \"$directory\"/\"$name.html\" \"$xslt\" \"$file\";;
|
|
|
|
|
xalan) eval xalan -o \"$directory\"/\"$name.html\" \"$file\" \"$xslt\";;
|
|
|
|
|
sabcmd) eval sabcmd \"$xslt\" \"$file\" \"$directory\"/\"$name.html\";;
|
|
|
|
|
esac
|
|
|
|
|
done
|
|
|
|
|
echo "conversion done"
|
|
|
|
|
echo
|
|
|
|
|
echo "generating index file..."
|
|
|
|
|
index_file="$directory/$index_file"
|
|
|
|
|
create_index_file
|
|
|
|
|
echo "index file generated"
|
|
|
|
|
echo
|
|
|
|
|
else
|
|
|
|
|
echo
|
|
|
|
|
echo "No XML files exist in the current directory!"
|
|
|
|
|
echo
|
2004-08-16 17:41:11 +01:00
|
|
|
fi
|
2007-06-12 11:39:47 +01:00
|
|
|
|
|
|
|
|
exit 0
|
