cvs: peardoc /fr/guide/developers documentation.xml
| From: | Christophe Gesch� | Date: | Thu, 10 Jun 2004 21:18:31 +0000 |
| Subject: | cvs: peardoc /fr/guide/developers documentation.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-4370@lists.php.net to get a copy of this message | ||
moosh Thu Jun 10 17:18:31 2004 EDT
Modified files:
/peardoc/fr/guide/developers documentation.xml
Log:
synchro is done, now I need to translate new blocks
http://cvs.php.net/diff.php/peardoc/fr/guide/developers/documentation.xml?r1=1.6&r2=1.7&ty=u Index: peardoc/fr/guide/developers/documentation.xml diff -u peardoc/fr/guide/developers/documentation.xml:1.6 peardoc/fr/guide/developers/documentation.xml:1.7 --- peardoc/fr/guide/developers/documentation.xml:1.6 Tue Jun 8 03:15:37 2004 +++ peardoc/fr/guide/developers/documentation.xml Thu Jun 10 17:18:31 2004 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.6 $ --> -<!-- EN-Revision: 1.21 Maintainer: moosh status: synchrobegin --> +<!-- $Revision: 1.7 $ --> +<!-- EN-Revision: 1.21 Maintainer: moosh status: synchroready translationstart --> <!-- Daniel add lot of change in english version - I begin to insert english in good place and after translate. + I begin to insert english in good place and after translate. --> <chapter id="developers.documentation"> @@ -61,7 +61,7 @@ Leonard Muellner et publié par <ulink url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink>, est <ulink url="&url.docbook.book.read;">disponible online</ulink>. - Il est aussi disponible en <ulink url="http://www.oreilly.fr/catalogue/docbook.html">français</ulink> + Il est aussi disponible en <ulink url="http://www.oreilly.fr/catalogue/docbook.html">français</ulink> Il propose une ressource importante pour les personnes déésireuses d'apprendre DocBook. </para> @@ -200,7 +200,7 @@ Le chemin <filename>peardoc/fr/package/</filename> est l'endroit où créer votre documentation. Si vous avez des questions sur la structure de la documentation, contactez la - <ulink url="&email.pear.doc;">mailinglist documentation</ulink>. + <ulink url="&email.pear.doc;">mailinglist de la documentation de PEAR</ulink>. </para> </sect2> @@ -222,9 +222,9 @@ </simpara> <simpara> L'arbre CVS est un ensemble complet de template DocBook XML. - These files provide the standard of how PEAR - documentation should look. - + + Ces fichiers fournissent une normr de l'apparence que doit + avoir la documentation de PEAR. </simpara> <simpara> La manière la plus simple de les utiliser est de les copier @@ -254,8 +254,8 @@ <listitem> <simpara> <ulink - url="&url.pear.cvs.peardoc;en/package/xml/xml-beautifier/">XML - Beautifier</ulink> + url="&url.pear.cvs.peardoc;en/package/xml/xml-beautifier/">Embelisseur + XML</ulink> </simpara> <simpara> @@ -359,12 +359,11 @@ <title>Conseils pour une bonne documentation</title> <titleabbrev>Conseil pour la doc</titleabbrev> - <para> - Cette section du chapitre - This section of the chapter does not deal with the specifics of - organizing documentation in the <literal>peardoc</literal> standard, - but instead with how to organize documentation logically. + Cette section du chapitre ne traite pas les détails de l'organisation + de la documentation dans la norme <literal>peardoc</literal>, + mais de la façon organiser la documentation logiquement. + </para> <para> @@ -373,61 +372,87 @@ <para> Premièrement, chaque package résoud un problème. Quel est ce problème? + Try to figure out what assumptions your end-users might not have about the problem (they may not realize that this is a problem that needs solving). - For instance, a template package solves the - problem of both separating design from code, and separating - business logic from display logic. + Par exemple, un package de template + résout à la fois le problème de la séparation du code et du design, + et celui de séparer la logique de traitement de la logique d'affichage. - If possible, explain the - problem in terms that even a novice programmer can understand. + Si possible, expliquez le problème en termes + que même un programmeur de débutant peut comprendre. </para> </listitem> <listitem> <para> - Next, how does the package uniquely solve the problem? - This is something that most documentation lacks. - For example, there are many template engines. - All of them solve the same problem, - but none of them do it in the same way. -<!-- 67 10 234567 20 234567 30 234567 40 234567 50 234567 60 234567 70 234567--> - A block-based template engine does not have any logic at all, - whereas a template like - Smarty defines a whole new template language. Some template - engines compile their templates, others don't. What is unique - about your package? Can someone who has never seen the code get - a good idea of how it solves the problem? + Ensuite, comment le paquet résout-il individuellement le problème? + <!-- + ndt : need a confirm for translation of uniquely + Next, how does the package uniquely solve the problem? + --> + + C'est quelque chose dont la plupart des documentations manquent. + + Par exemple, il y a beaucoup de moteurs de template. + + Tous résolvent le même problème, + mais aucun d'eux ne le fait de la même manière. + + Un moteur de template basé sur des bloc n'a aucune logique du tout, + tandis qu'un template comme Smarty définit + une nouvelle langage de template complet. + + Quelques moteurs de template compilent leurs templates, d'autres pas. + + Qu'est-ce qui est unique au sujet de votre paquet? + + Est-ce que quelqu'un que n'a jamais vu le code + peut avoir une bonne idée de la façon dont il résout le problème? </para> </listitem> <listitem> <para> - Donnez des exemples! - - Start right away with simple examples that - shows the basic feature set -- they will show users how to - quickly start using the package. - More complex examples will help - the users in understanding advanced ways of using the package. + Donnez DES exemples! + + Commencez tout de suite par des exemples simples + qui montrent les fonctionalités de base + -- + ils montreront aux utilisateurs comment commencer + rapidement à employer le package. + + Des exemples plus complexes aideront les utilisateurs + à la compréhension des façons avançées d'employer le package. </para> </listitem> <listitem> <para> - If your package exposes complex interfaces or multiple constants - that can't be fully explained in one or two examples (which is - very likely), do not miss to explain them thoroughly in the - documentation. Document any interfaces that users must use, such - as a database DSN, command-line arguments for applications, - configuration file contents, or any other non-code element. + Si votre paquet expose les interfaces complexes + ou les constantes multiples + qui ne peuvent pas être entièrement expliquées + dans un ou deux exemples (ce qui est très probable), + ne manquez pas de les expliquer complètement dans la documentation. + + Documentez toutes les interfaces + que les utilisateurs doivent employer, + comme une base de données DSN, + les arguments pour les applications ligne de commande, + le contenu de dossier de configuration, + ou n'importe quel autre élément de non-code. + <!-- ndt : need a translation of non-code --> </para> </listitem> <listitem> <para> Last, proofread your documentation. - If possible, have someone else who is not as familiar with your - project take a look at the documentation. - They will catch assumptions that you have missed. + + Finalement, faites relire votre documentation. + + Si possible, ayez quelqu'un d'autre + qui n'est pas trop au courant de votre projet. + + Ils remarqueront les hypothèses que vous avez manquées. </para> </listitem> </orderedlist>
http://cvs.php.net/diff.php/peardoc/fr/guide/developers/documentation.xml?r1=1.6&r2=1.7&ty=u Index: peardoc/fr/guide/developers/documentation.xml diff -u peardoc/fr/guide/developers/documentation.xml:1.6 peardoc/fr/guide/developers/documentation.xml:1.7 --- peardoc/fr/guide/developers/documentation.xml:1.6 Tue Jun 8 03:15:37 2004 +++ peardoc/fr/guide/developers/documentation.xml Thu Jun 10 17:18:31 2004 @@ -1,9 +1,9 @@ <?xml version="1.0" encoding="iso-8859-1" ?> -<!-- $Revision: 1.6 $ --> -<!-- EN-Revision: 1.21 Maintainer: moosh status: synchrobegin --> +<!-- $Revision: 1.7 $ --> +<!-- EN-Revision: 1.21 Maintainer: moosh status: synchroready translationstart --> <!-- Daniel add lot of change in english version - I begin to insert english in good place and after translate. + I begin to insert english in good place and after translate. --> <chapter id="developers.documentation"> @@ -61,7 +61,7 @@ Leonard Muellner et publié par <ulink url="&url.oreilly;">O'Reilly & Associates, Inc.</ulink>, est <ulink url="&url.docbook.book.read;">disponible online</ulink>. - Il est aussi disponible en <ulink url="http://www.oreilly.fr/catalogue/docbook.html">français</ulink> + Il est aussi disponible en <ulink url="http://www.oreilly.fr/catalogue/docbook.html">français</ulink> Il propose une ressource importante pour les personnes déésireuses d'apprendre DocBook. </para> @@ -200,7 +200,7 @@ Le chemin <filename>peardoc/fr/package/</filename> est l'endroit où créer votre documentation. Si vous avez des questions sur la structure de la documentation, contactez la - <ulink url="&email.pear.doc;">mailinglist documentation</ulink>. + <ulink url="&email.pear.doc;">mailinglist de la documentation de PEAR</ulink>. </para> </sect2> @@ -222,9 +222,9 @@ </simpara> <simpara> L'arbre CVS est un ensemble complet de template DocBook XML. - These files provide the standard of how PEAR - documentation should look. - + + Ces fichiers fournissent une normr de l'apparence que doit + avoir la documentation de PEAR. </simpara> <simpara> La manière la plus simple de les utiliser est de les copier @@ -254,8 +254,8 @@ <listitem> <simpara> <ulink - url="&url.pear.cvs.peardoc;en/package/xml/xml-beautifier/">XML - Beautifier</ulink> + url="&url.pear.cvs.peardoc;en/package/xml/xml-beautifier/">Embelisseur + XML</ulink> </simpara> <simpara> @@ -359,12 +359,11 @@ <title>Conseils pour une bonne documentation</title> <titleabbrev>Conseil pour la doc</titleabbrev> - <para> - Cette section du chapitre - This section of the chapter does not deal with the specifics of - organizing documentation in the <literal>peardoc</literal> standard, - but instead with how to organize documentation logically. + Cette section du chapitre ne traite pas les détails de l'organisation + de la documentation dans la norme <literal>peardoc</literal>, + mais de la façon organiser la documentation logiquement. + </para> <para> @@ -373,61 +372,87 @@ <para> Premièrement, chaque package résoud un problème. Quel est ce problème? + Try to figure out what assumptions your end-users might not have about the problem (they may not realize that this is a problem that needs solving). - For instance, a template package solves the - problem of both separating design from code, and separating - business logic from display logic. + Par exemple, un package de template + résout à la fois le problème de la séparation du code et du design, + et celui de séparer la logique de traitement de la logique d'affichage. - If possible, explain the - problem in terms that even a novice programmer can understand. + Si possible, expliquez le problème en termes + que même un programmeur de débutant peut comprendre. </para> </listitem> <listitem> <para> - Next, how does the package uniquely solve the problem? - This is something that most documentation lacks. - For example, there are many template engines. - All of them solve the same problem, - but none of them do it in the same way. -<!-- 67 10 234567 20 234567 30 234567 40 234567 50 234567 60 234567 70 234567--> - A block-based template engine does not have any logic at all, - whereas a template like - Smarty defines a whole new template language. Some template - engines compile their templates, others don't. What is unique - about your package? Can someone who has never seen the code get - a good idea of how it solves the problem? + Ensuite, comment le paquet résout-il individuellement le problème? + <!-- + ndt : need a confirm for translation of uniquely + Next, how does the package uniquely solve the problem? + --> + + C'est quelque chose dont la plupart des documentations manquent. + + Par exemple, il y a beaucoup de moteurs de template. + + Tous résolvent le même problème, + mais aucun d'eux ne le fait de la même manière. + + Un moteur de template basé sur des bloc n'a aucune logique du tout, + tandis qu'un template comme Smarty définit + une nouvelle langage de template complet. + + Quelques moteurs de template compilent leurs templates, d'autres pas. + + Qu'est-ce qui est unique au sujet de votre paquet? + + Est-ce que quelqu'un que n'a jamais vu le code + peut avoir une bonne idée de la façon dont il résout le problème? </para> </listitem> <listitem> <para> - Donnez des exemples! - - Start right away with simple examples that - shows the basic feature set -- they will show users how to - quickly start using the package. - More complex examples will help - the users in understanding advanced ways of using the package. + Donnez DES exemples! + + Commencez tout de suite par des exemples simples + qui montrent les fonctionalités de base + -- + ils montreront aux utilisateurs comment commencer + rapidement à employer le package. + + Des exemples plus complexes aideront les utilisateurs + à la compréhension des façons avançées d'employer le package. </para> </listitem> <listitem> <para> - If your package exposes complex interfaces or multiple constants - that can't be fully explained in one or two examples (which is - very likely), do not miss to explain them thoroughly in the - documentation. Document any interfaces that users must use, such - as a database DSN, command-line arguments for applications, - configuration file contents, or any other non-code element. + Si votre paquet expose les interfaces complexes + ou les constantes multiples + qui ne peuvent pas être entièrement expliquées + dans un ou deux exemples (ce qui est très probable), + ne manquez pas de les expliquer complètement dans la documentation. + + Documentez toutes les interfaces + que les utilisateurs doivent employer, + comme une base de données DSN, + les arguments pour les applications ligne de commande, + le contenu de dossier de configuration, + ou n'importe quel autre élément de non-code. + <!-- ndt : need a translation of non-code --> </para> </listitem> <listitem> <para> Last, proofread your documentation. - If possible, have someone else who is not as familiar with your - project take a look at the documentation. - They will catch assumptions that you have missed. + + Finalement, faites relire votre documentation. + + Si possible, ayez quelqu'un d'autre + qui n'est pas trop au courant de votre projet. + + Ils remarqueront les hypothèses que vous avez manquées. </para> </listitem> </orderedlist>