TCode, Tools for documenting Java programs in LaTeX
===================================================

TCode Installation Manual
=======================

1. Requirements
==================================

To use texjava.pl, a Perl 5 interpreter is needed. To produce Javadoc
HTML contents, LaTeX2HTML 2002-2-1 or later is needed.  Under Windows,
these two components have to be installed separately.  A Java 2
Software Development Kit (SDK) is required to take part of TCode.  To
use the Ant tasks, Apache Ant 1.5.3 or later is required.  TCode
assumes that Perl, LaTeX2HTML and JDK's bin directories are part of
the PATH environment variable.

2. Unpacking 
-------------
Unpack the zip file to any location.

Linux command : 
   unzip tcode-<DATE>.zip

Under Microsoft Windows, WinZip can be used to extract the ZIP file.

The created tcode subdirectory will contain the following files

   build.xml - Ant build file to construct TCode
   javatex.pl - Javatex Perl script
   PdfLatex.tex - LaTeX source file for the PdfLatex Ant task
   README - this file
   tcode.jar - TCode JAR archive for Ant tasks
   tcode.pdf - TCode PDF documentation
   tcode.perl - TCode LaTeX2HTML extension
   tcode.properties - User-customizable variables for build process
   tcode.sty - TCode LaTeX package
   tcode.tex - TCode LaTeX documentation
   Tcoderc - TCode C-Shell initialization script
   Tcode.bat - TCode Windows initialization script
   Tcode.sh - TCode Bourne shell initialization script
   Texjava.tex - LaTeX source file for the Texjava Ant task
   texjava.pl - Texjava Perl script
   setl2hinit.pl - LaTex2HTML Perl script

3. Configuring the environment
------------------------
To use TCode, tcode.sty must be accessible to LaTeX and tcode.perl, to
LaTeX2HTML.  Scripts can be used to automatically configure the
environment for TCode. The TCODEHOME environment variable must be set
prior to using the script.

Commands (for C-shell) :
   setenv TCODEHOME <path to TCode>
   source $TCODEHOME/Tcoderc

Commands (for Bourne shell) :
   export TCODEHOME=<path to TCode>
   . $TCODEHOME/Tcode.sh

Commands (for DOS/Windows) :
   set TCODEHOME=<path to TCode>
   call %TCODEHOME%\Tcode.bat

Here, <path to TCode> must be replaced by the full absolute path to
the unpacked tcode subdirectory. These commands should be added to the
appropriate startup files for more convenience.

These scripts define the texjava alias for more convenience. This
alias simply calls texjava.pl using Perl.  Under MS-DOS, the Tcode.bat
script can be used but it does not define an alias to call texjava.pl
becauses aliases are not supported.

Read the documentation
==================================
The TCode full documentation is available in the tcode.pdf file.  A
PDF reader such as Adobe Acrobat Reader, kghostview or xpdf is needed.


Building TCode
==================================
To rebuild the Ant tasks, a Java 2 compiler is required.  To rebuild
TCode, in the unpacked directory, type

   ant lib

This will recompile the Ant tasks and create tcode.jar.

To recreate the document (this requires pdflatex, bibtex and the Pierre L'Écuyer's
 bib files to be available), type

   ant doc

This will create tcode.pdf.  If the documentation does not need or
cannot be created, the tcode.properties file must be modified to
comment the tcode.doc line. This will prevent Ant from trying to
build the PDF file.

To create the tcode distribution, use

   ant dist

This will create tcode.zip containing all the needed files.
