• License.
• Synopsis.
• Installation.
• Options.
• Test.
• Guide.
• Thanks.
• Download.

Licence of ftagshtml.

Synopsis of ftagshtml.

1. analyse of the routines's declarations using etags provided with emacs,
2. same analysis using fortran 90, considering modules, functions or routines overloads, this does not use the etags program,
3. localyzes the includes as well as the calls of functions and procedures that possess arguments, also analyzes calls to LaTeX marked with the '\input file' command,
4. In option, builds a JavaScript supplementary index for each source file showing parents and sons of all the programmes of the file being analyzed.
5. writes the HTML files to navigate on using Netscape partially fontifying source code (using an option). A tiny transformation of LaTeX into HTML is performed (titles, lists, references...)
6. Build of the indexes with the option to also transform LaTeX '\input' files into HTML using hevea.
7. In option, build of a LaTeX index to get a PDF file using pdflatex (even though your comments are nor written in LaTeX).
8. As an option, build of an index for LaTeX2HTML in case you wish to get a direct link to your source code from a LaTeX document.. If RepEcrFtagshtmlCode is the directory where ftagshtml outputs, write

   \externallabel{/RepEcrFtagshtmlCode}{/RepEcrFtagshtmlCode/latex2html.pl}
   

   at the beginning of your LaTeX document. You may refer to the function "Subroutine" in your source code writing

   \externalref{R_Subroutine}
   

   in your LaTeX document.
9. As an option, possibility to include calls to the CGI-perl script getin for intelligent search on fortran code.

Installation.

1. Compulsary. Install perl version 5 or more.
2. Obligatoire. Install etags and make it available in your PATH variable.If you have emacs, this should be the case. If you use fortran 90 only, you do not need this step.
3. Optional. For literate programming, install LaTeX2e, hevea and ocaml.
4. Optional. You will need pdflatex to produce PDF output (shipped with linux).
5. Uncompress and untar ftagshtml.tar.gz directly onto directory /usr/local/cessenat using

          mkdir -p /usr/local/cessenat && mv ftagshtml.tar.gz /usr/local/cessenat/.
          cd /usr/local/cessenat
          gunzip ftagshtml.tar.gz && tar xvf ftagshtml.tar
   

   then remove useless archive

          rm -f /usr/local/cessenat/ftagshtml.tar.gz
   

6. Let the following environment variable evaluate to:

   Variable	Valeur
   FTAGSHTML_DIR	/usr/local/cessenat
   PATH	$PATH:$FTAGSHTML_DIR/bin
   MANPATH	$MANPATH:$FTAGSHTML_DIR/man

7. If perl is not installed on /usr/bin/perl modify the first line of /usr/local/cessenat/bin/ftagshtml accordingly using the output of the command which perl (or whence perl on some none Linux or Solaris systems).
8. To use netscape and literate programming using hevea, configure your browser.

Command line options.

Check the installation.

1. Basic functionalities.
   On cessenat/example/ftagshtml/FORTRAN type

   ftagshtml -cgi "http://papitou.magic/cgi-perso" -conf "FORTRAN" -www "/code/FORTRAN/HTML/ftagshtml" -code "Fortran" -l2h -latexindex -hevea -I ./include *.f *.c
   

   and check the surf on cessenat/example/ftagshtml/HTML/ftagshtml/index.html is the same as the one on Program Fortran Exemple.

2. Advanced functionalities.
   Type in

   ftagshtml -hevea -latexindex *.f *.c
   

   where comments are in LaTeX
   On HTML/ftagshtml type

   latex Lindex && latex Lindex && dvips -f Lindex.dvi -o Lindex.ps && pdflatex Lindex && xpdf Lindex.pdf &
        

   Check the file created there is identical to Program Fortran Example Format PDF.
3. Advanced functionalities.
   Type

   ftagshtml -latexindex -hevea -l2h *.f *.c
   

   to get LaTeX2HTML external references
   On Example of a LaTeX documentation, type

   latex exemple && latex exemple && latex2html exemple
        

   Check the file created there is identical to LaTeX Documentation converted into HTML.

User's guide.

Remerciements.