Dans la dernière révision de l'arborescence de développement, il y a une
tentative de création de documentation pour avis:
-Documentation développeur:
Elle utilise phpdocumentor utilisé par exemple par PEAR et est générée à
partir de "docblocs" écrit dans le code.
http://www.phpdoc.org/
Vous pouvez voir le résultats dans le répertoire docs/index.html. C'est
encore loin d'être complet mais si cela plaît à cette liste alors on
peut l'adopter. Dans ce cas, il y a quelques règles d'écriture à
respecter et le plus simple serait probablement d'adopter celles de pear
par exemple:
http://pear.php.net/manual/fr/standards.php
-Manuel utilisateur
La c'est un plagia exhaustif du site de tuxfamilly/galette avec quelques
petits ajouts concernant les préférences. Le résultat html est visible
dans docs/manual/manual.html. On peut générer aussi du pdf à partir des
sources en xml/docbook mais ça reste à faire, et il faut installer Fop
sur la machine qui génère le manuel. Pour fabriquer du html il faut
xsltproc.
Il est théoriquement possible de fabriquer des pages pour un site web
mais dans le cas de tuxfamily, il faudrait écrire ou (modifier beaucoup)
un xsl qui produise un format compatible du wiki tuxfamily. Donc forget
it...
phpdocumentor à la possibilité d'intégrer la doc annexe mais comme ce
n'était pas très convaincant, la création du manuel est restée
indépendante de la doc développeur.
--
John Perr
GPG Id 0xA83889EC
[Galette-devel] Documentation