cvs: phpdoc-fr / LISEZ_MOI.txt

From: Date: Fri, 27 Feb 2004 19:00:42 +0000
Subject: cvs: phpdoc-fr / LISEZ_MOI.txt
Groups: php.doc.fr 
Request: Send a blank email to doc-fr+get-1896@lists.php.net to get a copy of this message
didou Fri Feb 27 14:00:42 2004 EDT Added files: /phpdoc-fr LISEZ_MOI.txt Log: première version http://cvs.php.net/co.php/phpdoc-fr/LISEZ_MOI.txt?r=1.1&p=1 Index: phpdoc-fr/LISEZ_MOI.txt +++ phpdoc-fr/LISEZ_MOI.txt $Revision: 1.1 $ But : Ce fichier à pour but de définir les règles à respecter lors de vos traductions/mises à jour de fichiers. Structure : I - Indentation II - Coding Standards III - Revision tracking IV - Commentaires dans les fichiers V - Commits et messages de log VI - Commandes utiles VII - Traductions de quelques mots I - Indentation : Le pas à respecter pour l'indentation est de 1. Exemple : <note> _<para> __<example> ___<title> ___</title> __</example> _</para> </note> Le caractère d'indentation est un espace (aucune tabulation n'est admise dans les fichiers .xml) II - Coding standards : Le groupe de documentation PHP a choisi d'utiliser les coding standards de PEAR, vous les trouverez ici : http://pear.php.net/manual/fr/standards.php Merci donc de les lire et de les appliquer. Le code source PHP commence à la colonne zéro de l'exemple : <?php ca_commence_ici(); // bien ca_commence_ici(); // pas bien ?> On nottera aussi qu'on privilégie les echo à print (echo sans parenthèses). Tous le code est sensé être compatible avec error_reporting(E_ALL) et register_globals = Off. III - Revision tracking. Vers la fin février, la documentation française a adopté la méthode de Revision Tracking par balises : http://fr.php.net/manual/howto/translation-revtrack.html (9.4.2). Dans un premier temps, nous avons rajouté la balise suivante dans tous les fichiers : <!-- EN-Revision: 1.1 Maintainer: nobody Status: partial --> Pourquoi avons-nous fais cela ? L'adoption de cette méthode permet de mieux suivre les différences entre la doc anglaise et française. Vous pourrez le constater en utilisant le script revcheck.php (dans phpdoc-fr/scripts/) ou en visitant http://didou.keliglia.com/php/revcheck_php.php (mis à jour tous les matin à 2h) IV - Commentaires dans les fichiers Les seuls commentaires qui doivent figurer en début de fichier sont : <!-- $Revision: 1.1 $ --> <!-- EN-Revision: 1.5 Maintainer: XXXX Status: YYYYY --> Et bien sur les commentaires des traducteurs (<!-- ne touchez pas ce fichier svp, utilisateur -->) V - Commits et messages de log Essayez (dans la mesure du possible) de commiter répertoire par répertoire. Dans fr/reference/ commitez extension par extension. En ce qui concerne les messages de logs pour les commits, on essayera de : - faire des messages en anglais (au cas où jamais un non-francophone a besoin de comprendre les modifications) - faire des messages explicites (ne pas mettre "typo" quand on rajoute du texte..) Bon, évidement, on n'est pas chez les scouts, les écarts seront tolérés. VI - Commandes utiles (On suppose par la suite qu'on est d'office dans le répertoire racine du module de la doc française) Voici quelques commandes utiles lors de vos traductions/commits : 1 - Commiter de grosses modifications dans fr/reference/ si vous avez modifié plusieurs fichiers dans plusieurs extensions : cd reference for i in $(ls); do cvs ci -m "message de log" $i; done 2 - Rechercher un "mot" dans toute la doc : rgrep -ni "mot" .

« previous php.doc.fr (#1896) next »