Olivier Cessenat <cessenat@free.fr>

Ftagshtml, navigation sur du fortran 77, 90 et du C "simple".

ftagshtml's logo

License de ftagshtml.

ftagshtml est un produit libre sous licence GPL: droits de copie, modification, promotion pour toute personne ou société sous réserve de faire connaître cette notice.
L'enrobage de ce produit dans un produit commercial est interdit comme spécifié dans la GNU GENERAL PUBLIC LICENSE.
Les modules de ftagshtml sont aussi sous license GPL.

Synopsis de ftagshtml.

Ftagshtml est un produit pour naviguer sur du code source fortran 77 et éventuellement C. Le code source est transformé en Html pour une navigation avec Netscape ou Emacs-W3.
  1. analyse des points de définition des subroutines et fonctions à l'aide du propramme etags fournis avec emacs,
  2. même analyse sur le fortran 90 avec la notion de modules, de surcharges de fonctions ou routines, ceci n'utilise pas le programme etags,
  3. analyse des appels de fichiers includes et des appels de fonctions ou subroutines ainsi que des fichiers LaTeX appelés dans les commentaires par la commande '\input'
  4. écriture des fichiers HTML sur lesquels naviguer avec Netscape en fontifiant un certain nombre d'éléments syntaxiques du fortran, du C et du LaTeX. Une mini transformation du LaTeX en HTML est effectuée (commandes de formatage de base, titres, listes, références...)
  5. Construction des index et en option transformation des fichiers LaTeX appelés à partir du source par la commande '\input' en HTML à l'aide d'hevea.
  6. En option, construction d'un index JavaScript supplémentaire pour chaque fichier source donnant la descendance et parenté des programmes du fichier source en cours.
  7. En option, construction d'un index LaTeX pour générer un papier au format PDF avec pdflatex (même si vos commentaires ne sont pas en LaTeX).
  8. En option, construction d'un index pour LaTeX2HTML au cas où vous voudriez référencer des programmes à partir de votre documentation LaTeX du code source. Si RepEcrFtagshtmlCode est le nom du répertoire sur lequel ftagshtml crée ses fichiers, mettez
    \externallabel{/RepEcrFtagshtmlCode}{/RepEcrFtagshtmlCode/latex2html.pl}
    
    en début de votre document LaTeX. Vous pouvez effectuer des renvois HTML à la fonction "Subroutine" de votre code en mettant
    \externalref{R_Subroutine}
    
    dans le source LaTeX.
  9. En option, possibilité d'appel du moteur de recherche intelligent getin si vous disposez d'un serveur WEB avec CGI-perl.

Installation.

  1. Obligatoire.Installer perl version 5 ou supérieur sur votre machine et le rendre accessible dans votre variable PATH. Si vous avez linux, c'est normalement déjà le cas.
  2. Obligatoire.Installer etags sur votre machine et le rendre accessible dans votre variable PATH. Si vous avez emacs, c'est normalement déjà le cas.
  3. Optionnel. Si vous comptez faire de la programmation littéraire en tapant vos commentaires en LaTeX, installez aussi LaTeX2e, hevea et ocaml.
  4. Optionnel. Si vous comptez générer des documentations papier, installés LaTeX2e et pour une documentation PDF il vous faudra pdflatex.
  5. Décompressez et détarez le fichier ftagshtml.tar.gz sur le répertoire /usr/local/cessenat avec la commande
           mkdir -p /usr/local/cessenat && mv ftagshtml.tar.gz /usr/local/cessenat/.
           cd /usr/local/cessenat
           gunzip ftagshtml.tar.gz && tar xvf ftagshtml.tar
    
    puis supprimez le fichier inutile:
           rm -f /usr/local/cessenat/ftagshtml.tar.gz
    
  6. Configurez votre environnement en positionnant les variables d'environnement suivantes:
    VariableValeur
    FTAGSHTML_DIR/usr/local/cessenat
    PATH$PATH:$FTAGSHTML_DIR/bin
    MANPATH$MANPATH:$FTAGSHTML_DIR/man
  7. Si perl n'est pas installé sur /usr/bin/perl modifiez la première ligne de /usr/local/cessenat/bin/ftagshtml en fonction de ce que vous donne la commande which perl (ou whence perl sur certains systèmes).
  8. Si vous comptez utiliser netscape et la programmation littéraire LaTeX transformée par hevea, configurez votre navigateur.
D'autres variables d'environnement peuvent être utilisées par ftagshtml pour spécifier des couleurs. Consultez la page de man de ftagshtml.

Vérification de l'installation.

  1. Fonctionnalités de base.
    Sur le répertoire cessenat/example/ftagshtml/FORTRAN tapez la commande
    ftagshtml -cgi "http://papitou.magic/cgi-perso" -conf "FORTRAN" -www "/code/FORTRAN/HTML/ftagshtml" -code "Fortran" -l2h -latexindex -hevea -I ./include *.f *.c
    
    et vérifiez que vous pouvez surfer à partir de cessenat/example/ftagshtml/HTML/ftagshtml/progindex.html de la même façon que sur Program Fortran Exemple.

  2. Fonctionnalités avancées.
    Tapez maintenant la commande:
    ftagshtml -hevea -latexindex *.f *.c
    
    pour générer une navigation sur des fichiers où les commentaires sont en LaTeX.
    Sur le répertoire HTML/ftagshtml tapez la commande
    latex Lindex && latex Lindex && dvips -f Lindex.dvi -o Lindex.ps && pdflatex Lindex && xpdf Lindex.pdf &
         
    Vérifiez que le fichier créé est identique à Program Fortran Exemple Format PDF.
  3. Fonctionnalités avancées.
    Tapez maintenant la commande:
    ftagshtml -hevea -latexindex -l2h *.f *.c
    
    pour générer un index de références externes pour LaTeX2HTML
    Sur le répertoire Exemple de documentation en LaTeX, tapez la commande
    latex exemple && latex exemple && latex2html exemple
         
    Vérifiez que le fichier créé est identique à Documentation LaTeX convertie en HTML.

Guide d'utilisation.

Consultez la page de man de ftagshtml, particulièrement pour ce qui concerne la customisation et les commentaires en LaTeX.

Remerciements.

emacs, perl, linux... ma femme et ma fille qui supportent ma passion du logiciel libre!
Olivier Cessenat <cessenat@free.fr>
Last modified: Mon May 28 00:37:49 2001


ftagshtml's logo