Re: [sdx-developers] Documentation

[Patrice Pillot]

On Thu, Feb 07, 2002 at 09:49:40AM +0100, Pierrick Brihaye wrote:
> Bonjour,
> 
> Suite au message de sdx-users mentionnant que la documentation faisait 
> encore référence à Sourceforge, j'ai mis à jour la doc XML et régénré 
> HTML, fo, et PDF.
> 
> J'en ai profité pour faire un peu de ménage dans makedocs.bat (toujours 
> pas de contrepartie Unix) pour que ça tourne sous mon Win 98.

Douloureux souvenir. En fait le "build system" est prêt et fonctionne
(modulo un prob avec "ant" dont je n'ai pas présentement le souvenir
précis) mais comme j'obtiens des bugs au niveau fonctionnement j'ai
préféré ne rien vous soumettre pour l'instant, je préférais tester
avant pour m'assurer que ce n'était pas un problème dû au build... ce
qu'évidemment je n'ai pas eu le temps de faire. Il me faudrait faire
ça à la maison car je n'ai pas trop le temps au boulot en ce moment.
Peut-être la solution la plus sage serait-elle que je soumette ce que
j'ai fait afin que d'autres plus disponibles s'y mettent sans avoir à
repartir de zéro. C'est à ça que ça sert après tout un CVS...

> 
> En gros, j'ai viré la référence à "DEL /Q" (j'imagine que Q veut dire 
> "quiet" et évite de confirmer la destruction) pour laquelle je n'ai 
> trouvé *aucune* documentation et je l'ai remplacée par un FOR (avec 
> extension explicite car DEL *.* nécessite lui aussi une confirmation ;-).
> 
> Si vous pouviez tester sur vos Windows respectifs...
> 
> Ceci m'amène à poser une question : doit-on livrer les HTML et PDF dans 
> la distrib ? On pourrait concevoir d'avoir, dans les répertoires 
> respectifs, un makedocs spécifique ou un CALL vers "le" makedocs.

C'est pas mal d'avoir la doc avec les sources, et, de mémoire, ce
n'est pas ce qui pèse le plus lourd. Par contre à ce porpos, la
génération du pdf génère pas mal de warnings chez moi (mais ça marche
bien). Est-ce pareil chez vous ?

> J'ai également passé la classe XSLTConverter en binaire...

Par contre j'ai un fix à rajouter pour le source de cette classe qui
plante en l'état sur mon système. Martin doit se souvenir de ce
problème.

> 
> Par ailleurs, sous la racine CVS, pourrait-on concevoir d'avoir un 
> répertoire (pardon un "module") "demos" qui pourrait recevoir des appli 
> SDX (toutes versions confondues, pour plus d'infos lire le README) libres ?

Oui, l'équivalent des "examples" qu'on trouve dans d'autres packages.
Bonne idée ! Par contre je vois bien plutôt un répertoire qu'un
module. Autant downloader les démos avec le source (et ainsi pouvoir
le tester) puisque de toutes façons on ne downloadera qu'une fois et
que la compatibilité V1 V2 n'est pas assurée à 100%.

Bon, j'essaie de prendre un peu de temps ce week-end pour documenter
ce que j'ai fait (ça fait la même chose que les .bat mais avec un peu
plus de tests) et je vous envoie ça.

A +,

pp