Re: [Maitretarot-devel-fr] Documentation

[Yves Mettier]

>> - suppression de protocol.sgml qui prete a confusion avec le code sgml 
>> genere par
>> "cardgame_server --print-protocol".
>> - suppression de tous les fichiers texte sauf le fichier readme.
>>
> Bonne idee aussi, c'est fichiers etaient en trop et la version sgml
> est mieux presentee.
>
>
> Par contre, je trouve l'idee de virer protocol.sgml assez mauvaise.
> Je pense qu'il nous faut un document de reference qui ne depende pas
> d'une implementation particuliere (ici "cardgame_server --print-protocol"),
> mais qui soit au contraire facile d'acces.

Rien n'empeche de generer cette doc avec "cardgame_server --print-protocol" et 
de la
mettre a disposition quelque part. Mais je pense que cette doc ne doit pas 
aller sur le
CVS si elle est generee automatiquement.

Ensuite, la question est de savoir si c'est cardgame_server et son generateur 
de doc la
reference ou si ca doit etre autre chose.
Si c'est cardgame_server, le protocole est dependant de l'implementation de 
celui-ci
dans cardgame_server, avec neanmoins la possibilite de faire un fork de cette
documentation a tout moment si besoin.
Inversement, si ce n'est pas cardgame_server la reference, nous aurons dans ce 
cas dans
cardgame_server l'etat de l'avancement de l'implementation du protocole, mais 
par
contre, l'obligation de maintenir deux versions du protocole: la version de 
reference et
celle de cardgame_server.

Dans l'etat actuel des choses, je pense qu'il est preferable que ce soit 
cardgame_server
la reference car cela fait moins de boulot. Les structures ont juste a etre
implementees, meme si le code de traitement des donnees n'y est pas. Ensuite, 
si le
besoin s'en fait sentir, on fera un fork de la doc genereee par cardgame_server 
et on la
maintiendra a jour a la main.

>
> Surtout que le protocole dans guide.sgml a fait un sacré bon en arriere:
> - utilisation de virgules pour separer les champs d'une commande, alors qu'un
> espace est largement suffisent
> - Les commandes ne sont pas de la forme INFO_order comme indique au debut de 
> la doc.
> - manque INFO_king_in_chien...

En fait, la, c'est moi qui ai laisse le texte tel quel. Je n'ai pas regarde si 
c'etait a
jour. Et je suis presque persuade que c'est pas a jour du tout !!!

> Enfin, bon ce serait une bonne idee de remettre protocole.sgml sur le CVS
> ou alors d'integrer un protocole a jour dans guide.sgml.

Moi, je n'y suis pas favorable pour les raisons qui precedent. J'etais meme a 
deux
doigts de prendre la partie protocole qui se trouve dans guide.sgml et de la 
coder dans
cardgame_server pour que cardgame_server soit capable de generer la totalite du 
document
de reference.


Question: est-il envisageable de mettre la partie definition du protocole dans
libmaitretarot, et ensuite d'avoir deux projets: cardgame_server qui fait son 
boulot de
serveur, et un autre, qui ne ferait que generateur de doc ?
Du coup, une partie serait toujours liee a l'implementation de ce protocole 
dans un
element de logiciel, libmaitretarot en l'occurence, et a la place de 
cardgame_server.
Mais par contre, on pourrait faire des trucs plus sympas en utilisant par 
exemple
libxslt pour parser un document docbook (xml) et y integrer le protocole ?

Mais cela represente du boulot et ne resoud pas vraiment le probleme.

Yves

-- 
- Homepage    - http://ymettier.free.fr - http://www.logicacmg.com -
- GPG key     - http://ymettier.free.fr/gpg.txt                    -
- Maitretarot - http://www.nongnu.org/maitretarot/                 -
- GTKtalog    - http://www.nongnu.org/gtktalog/                    -