Bonjour a tous,
dans le cadre d'un stage au SCG a Berne, j'ai cree un package qui extrait le code de vos classes et de vos methodes au format LaTeX ou XML (d'autres formats vont venir aujourd'hui ou demain).
Ce package est disponible depuis SqueakSource sous le nom SmallAutoDoc.
Pour lancer la generation en LaTeX :
SADGenerator new fileName: 'collections.tex'; packageName: 'Collections'; generateLaTeX.
ou en XML :
SADGenerator new fileName: 'sad.xml'; packageName: 'SmallAutoDoc'; generateXML.
Faites tous les commentaires que vous voulez, je suis a l'ecoute et j'ai pleins de choses a apprendre. N'hesitez pas a critiquer l'implementation, a demander ou implementer de nouvelles fonctions...
Merci beaucoup pour tous les commentaires que vous ferez !
dans le cadre d'un stage au SCG a Berne, j'ai cree un package qui extrait le code de vos classes et de vos methodes
En fait de code, c'est les commentaires que le package extrait (plus d'autres infos utiles).
Ce qui serait bien est que tu generes non pas du latex
\section{}
dans le texte mais une macro comme cela en redefinissant la macro on pourrait changer le document plus facilement.
definir une macro en latex dans le preambule est \newcommand{\macsection}[1]{\section{#1}}
On 20 juil. 05, at 16:12, Damien Cassou wrote:
dans le cadre d'un stage au SCG a Berne, j'ai cree un package qui extrait le code de vos classes et de vos methodes
En fait de code, c'est les commentaires que le package extrait (plus d'autres infos utiles).
-- Damien Cassou pour le Software Composition Group a Berne _______________________________________________ Squeak-fr mailing list Squeak-fr@lists.squeakfoundation.org http://lists.squeakfoundation.org/listinfo/squeak-fr
Le 20 juil. 05, à 16:04, Damien Cassou a écrit :
Bonjour a tous,
dans le cadre d'un stage au SCG a Berne, j'ai cree un package qui extrait le code de vos classes et de vos methodes au format LaTeX ou XML (d'autres formats vont venir aujourd'hui ou demain).
Ce package est disponible depuis SqueakSource sous le nom SmallAutoDoc.
Pour lancer la generation en LaTeX :
SADGenerator new fileName: 'collections.tex'; packageName: 'Collections'; generateLaTeX.
ou en XML :
SADGenerator new fileName: 'sad.xml'; packageName: 'SmallAutoDoc'; generateXML.
Faites tous les commentaires que vous voulez, je suis a l'ecoute et j'ai pleins de choses a apprendre. N'hesitez pas a critiquer l'implementation, a demander ou implementer de nouvelles fonctions...
Merci beaucoup pour tous les commentaires que vous ferez !
Cela permet de gérer un fichier pdf avec des liens hypertextes dedans ? Lien vers la superclasse, méthodes rédéfinies, etc ...
-- oooo Dr. Serge Stinckwich OOOOOOOO Université de Caen>CNRS UMR 6072>GREYC>MAD OOESUGOO http://purl.org/net/SergeStinckwich oooooo Smalltalkers do: [:it | All with: Class, (And love: it)] \ / ##
Cela permet de gerer un fichier pdf avec des liens hypertextes dedans ? Lien vers la superclasse, methodes redefinies, etc ...
Oui et non.
Oui parce que le fichier LaTeX est specialement fait pour gerer les fichiers pdf (la table des matieres a la fin contient des liens clickables par exemple).
Non parce que je n'ai pas pense a faire des liens vers tout ca. Je m'en occupe.
Merci du commentaire
Le 20 juil. 05, à 16:21, Damien Cassou a écrit :
Cela permet de gerer un fichier pdf avec des liens hypertextes dedans ? Lien vers la superclasse, methodes redefinies, etc ...
Oui et non.
Oui parce que le fichier LaTeX est specialement fait pour gerer les fichiers pdf (la table des matieres a la fin contient des liens clickables par exemple).
Non parce que je n'ai pas pense a faire des liens vers tout ca. Je m'en occupe.
Tu peux utiliser le paquet hyperref avec pdflatex pour faire cela facilement.
Sinon, il me semble qu'il y a déjà un outil pour générer de la documentation qui s'appelle Dandelion : http://www.mars.dti.ne.jp/~umejava/smalltalk/stClasses/dandelion/
A+ -- oooo Dr. Serge Stinckwich OOOOOOOO Université de Caen>CNRS UMR 6072>GREYC>MAD OOESUGOO http://purl.org/net/SergeStinckwich oooooo Smalltalkers do: [:it | All with: Class, (And love: it)] \ / ##
Tu peux utiliser le paquet hyperref avec pdflatex pour faire cela facilement.
Les liens marchent deja. J'utilise :
\usepackage[pdftex,colorlinks=true,pdfstartview=FitV,linkcolor=blue,citecolor=blue,urlcolor=blue]{hyperref}
Sinon, il me semble qu'il y a déjà un outil pour générer de la documentation qui s'appelle Dandelion : http://www.mars.dti.ne.jp/~umejava/smalltalk/stClasses/dandelion/
Merci pour l'info, Stephane m'avait cache ca. Cela dit, ca a l'air assez lourd, je ne sais pas.
Bonjour a tous,
beaucoup de changement on ete fait sur SmallAutoDoc depuis le premier post :
- Les classes ont maintenant des liens vers leurs super classes (si ces dernieres sont dans le meme package), Les liens sont clickables si vous compilez en pdf.
- Les infos de chaque classe sont affichees en dessous de la classe (variables d'instances, super classe, variables de classe...)
- Export au format HTML (utilisation de CSS pour l'apparence, tres austere pour le moment)
- Affichage des methodes des supers classes (desole pour l'oubli)
- Format LaTeX totalement parametrable grace a l'utilisation d'environements specifiques.
- Acceleration du processus de l'ordre de 500% (merci a Markus Denker de m'avoir dit que la methode #who n'etait pas tres efficace :-))
- Refactorisation complete du code (merci Kent Beck, Stephane Ducasse et Adrian Lienhard)
- corrections de bugs
Exemples d'utilisation :
(SADGenerator filename: 'collections.tex' package: 'Collections') generateLaTeX. (SADGenerator filename: 'sad.htm' package: 'SmallAutoDoc') generateHTML
Si quelqu'un a 2 minutes pour me faire une petite interface en morph pour ces appels, je lui serait tres reconnaissant (je ne connais pas Morphic). Je peux aussi ouvrir le repository squeak source si vous voulez faire des modifications et les inclure dans le projet.
N'hesitez pas a commenter en tout cas, je n'attends que ca !
Merci d'avoir lu jusque la :-)
squeak-fr@lists.squeakfoundation.org
-
Damien Cassou -
Serge Stinckwich -
stéphane ducasse