diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 47b183f6..a95dfcf6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -68,7 +68,7 @@ version locale. git fetch upstream -On créé ensuite une branche. Il est pratique de nommer la branche en fonction du +On crée ensuite une branche. Il est pratique de nommer la branche en fonction du fichier sur lequel on travaille. Par exemple, si vous travaillez sur « library/sys.po », vous pouvez nommer votre branche « library-sys ». Cette nouvelle branche nommée « library-sys » est basée sur « upstream/3.9 ». @@ -93,22 +93,27 @@ Ici, remplacez « library/sys.po » par le fichier que vous avez choisi préc Ou lancez simplement Poedit puis « Fichier » → « Ouvrir ». -Si vous n'utilisez pas Poedit, vous pouvez utiliser `powrap `_ -(voir la section *outils*) qui reformate correctement le fichier que vous avez modifié. -Exécutez `powrap -m` (reformater tous les fichiers modifiés) -ou `powrap library/sys.po` (un fichier en particulier) : - -.. code-block:: bash - - powrap -m - Traduction ~~~~~~~~~~ -Vous pouvez dès à présent commencer à traduire le fichier en respectant les `Conventions`_ du projet. +Vous pouvez dès à présent commencer à traduire le fichier en respectant les `conventions`_ du projet. +Pour vous aider à ne pas faire de fautes d'orthographe, vous pouvez vérifier que tous les mots utilisés sont +bien dans le dictionnaire (ça ne vérifie pas la grammaire, pour cela utilisez `padpo (beta)`_). En cas +de doute, un `glossaire`_ répertorie déjà les traductions retenues pour certains termes techniques ou faux amis +en anglais. -La commande suivante lance les vérifications nécessaires : +.. code-block:: bash + + make spell + +Vous pouvez aussi réindenter les fichiers avec : + +.. code-block:: bash + + make wrap + +Et pour faire les deux à la fois, lancez : .. code-block:: bash @@ -133,11 +138,18 @@ La documentation est publiée l'adresse ``_``. Balises -~~~~~~~ ++++++++ Ne traduisez pas le contenu des balises comme ``:ref:...`` ou ``:class:...``. Vous devez cependant traduire les balises ``:term:...``, qui font référence à -un concept ou une primitive Python défini dans le `glossaire `_. +un concept ou une primitive défini dans le `glossaire Python `_. La syntaxe est ``:term:nom_français``. Par exemple, traduisez ``:term:`dictionary``` en ``:term:`dictionaire ```. Comme le glossaire est déjà traduit, il y a forcément une correspondance à chaque terme que vous pouvez rencontrer. -Style -~~~~~ - -Une bonne traduction est une traduction qui transcrit fidèlement l'idée originelle -en français, sans rien ajouter ni enlever au fond, tout en restant claire, concise et -agréable à lire. Les traductions mot-à-mot sont à proscrire et il est permis — même -conseillé — d'intervertir des propositions ou de réarranger des phrases de la -documentation anglaise, si le rythme l'exige. Il faut aussi chercher des -équivalents français aux termes techniques et aux idiotismes rencontrés, et prendre -garde aux anglicismes. - -Utilisation du futur -~~~~~~~~~~~~~~~~~~~~ - -Dans la description du comportement de Python (au sens large, c'est-à-dire -l'interpréteur lui-même mais aussi toutes les bibliothèques), la version -originale utilise souvent le futur : « if you do this, it will produce -that… ». En français, l'utilisation du présent convient tout à fait et le -présent est souvent plus facile à lire : « si vous faites ceci, il se -produit cela… ». On ne conserve le futur que si la seconde proposition -se situe réellement dans le futur (par exemple, on peut penser qu'un -processus de compilation n'est pas immédiat) ou pour des raisons de -concordance des temps. - -Utilisation du conditionnel -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -La version originale est très polie envers le lecteur ; elle lui intime -rarement des obligations, préférant employer « you should ». Cependant, en -français, il est d'usage d'être plus direct pour être correctement compris : -« vous devez ». *Vous devriez* est en effet généralement compris comme quelque -chose dont l'on peut de temps en temps se passer, alors que c'est très -rarement le cas pour les « you should » de cette documentation. -De la même manière, « can » est souvent mieux traduit sans introduire de notion -de possibilité, en particulier quand la phrase est à la voix passive ; la -phrase « these objects can be accessed by… » se traduit mieux par « on accède à -ces objets en… ». - -Utilisation du masculin -~~~~~~~~~~~~~~~~~~~~~~~ - -Dans un souci de lisibilité et en accord avec la préconisation de -l'Académie française, nous utilisons le masculin pour indiquer un -genre neutre. Par exemple : l'utilisateur ou le lecteur. Glossaire ~~~~~~~~~ @@ -423,6 +444,36 @@ underscore tiret bas, *underscore* whitespace caractère d'espacement ========================== =============================================== +Ressources de traduction +------------------------ + +- les canaux IRC sur freenode : + + - `#python-docs-fr `_ — communauté python autour de la documentation française, + - `#python-fr `_ — communauté python francophone, + - `#python-doc `_ — communauté python autour de la documentation anglophone ; +- les listes de diffusion relatives à la documentation (courriel) : + + - `de l'AFPy `_, + - `de cpython `_ ; +- des glossaires et dictionnaires : + + - le `glossaire de la documentation Python `_, car il est déjà traduit, + - les `glossaires et dictionnaires de traduc.org `_, en particulier le `grand dictionnaire terminologique `_ de l'Office québécois de la langue française, + - Wikipédia. En consultant un article sur la version anglaise, puis en basculant sur la version francaise pour voir comment le sujet de l'article est traduit ; +- le `guide stylistique pour le français de localisation des produits Sun + `_ donne + beaucoup de conseils pour éviter une traduction trop mot à mot ; +- `Petites leçons de typographie `_, + résumé succint de typographie, utile pour apprendre le bon usage des + majuscules, des espaces, etc. + +L'utilisation de traducteurs automatiques comme `DeepL https://www.deepl.com/` ou semi-automatiques comme +`reverso https://context.reverso.net/traduction/anglais-francais/` est proscrite. +Les traductions générées sont très souvent à retravailler, ils ignorent les règles énoncées sur cette +page et génèrent une documentation au style très « lourd ». + + Caractères spéciaux et typographie ---------------------------------- @@ -531,8 +582,8 @@ En français, nous mettons une espace insécable devant nos deux-points, comme : Pour saisir une espace insécable faites :kbd:`Compose SPACE SPACE` -Le cas des doubles-espaces -~~~~~~~~~~~~~~~~~~~~~~~~~~ +Les doubles-espaces +~~~~~~~~~~~~~~~~~~~ La documentation originale comporte beaucoup de doubles-espaces. Cela se fait en anglais, mais pas en français. De toute manière, @@ -606,38 +657,8 @@ Powrap | `Lien vers le dépôt `__ -Ressources de traduction ------------------------- - -- les canaux IRC sur freenode : - - - `#python-docs-fr `_ — communauté python autour de la documentation française, - - `#python-fr `_ — communauté python francophone, - - `#python-doc `_ — communauté python autour de la documentation anglophone ; -- les listes de diffusion relatives à la documentation (courriel) : - - - `de l'AFPy `_, - - `de cpython `_ ; -- des glossaires et dictionnaires : - - - le `glossaire de la documentation Python `_, car il est déjà traduit, - - les `glossaires et dictionnaires de traduc.org `_, en particulier le `grand dictionnaire terminologique `_ de l'Office québécois de la langue française, - - Wikipédia. En consultant un article sur la version anglaise, puis en basculant sur la version francaise pour voir comment le sujet de l'article est traduit ; -- le `guide stylistique pour le français de localisation des produits Sun - `_ donne - beaucoup de conseils pour éviter une traduction trop mot à mot ; -- `Petites leçons de typographie `_, - résumé succint de typographie, utile pour apprendre le bon usage des - majuscules, des espaces, etc. - -L'utilisation de traducteurs automatiques comme `DeepL https://www.deepl.com/` ou semi-automatiques comme -`reverso https://context.reverso.net/traduction/anglais-francais/` est proscrite. -Les traductions générées sont très souvent à retravailler, ils ignorent les règles énoncées sur cette -page et génèrent une documentation au style très « lourd ». - - Simplification des diffs git ----------------------------- +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Les diffs git sont souvent encombrés de changements inutiles de numéros de ligne, comme : @@ -698,31 +719,6 @@ Fusion des fichiers *pot* de CPython make merge -Trouver les chaînes de caractères *fuzzy* -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: bash - - make fuzzy - - -*build* local -~~~~~~~~~~~~~ - -.. code-block:: bash - - make - - -Serveur de documentation en local -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: bash - - make serve - - - Synchronisation de la traduction avec Transifex ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ diff --git a/README.rst b/README.rst index be773b6b..bf9aa91c 100644 --- a/README.rst +++ b/README.rst @@ -11,6 +11,24 @@ Traduction française de la documentation Python :width: 45% +Contribuer à la traduction +-------------------------- + +Vous pouvez contribuer : + +- en proposant des *pull requests* Github (solution recommandée) ; +- en envoyant un correctif à la liste `traductions `_. + +Consultez le +`guide `_ +pour apprendre les conventions à respecter. + +Le coordinateur de cette traduction est `Julien Palard (mdk) `_. +Vous pouvez obtenir de l'aide sur le canal ``#python-fr`` sur `freenode +`_ (ne nécessite pas d'inscription) ou poser vos questions sur la +`liste de diffusion `_ des traductions de l'AFPy. + + Accord de contribution à la documentation ----------------------------------------- @@ -34,40 +52,11 @@ En soumettant votre travail à la PSF pour inclusion dans la documentation, vous signifiez votre acceptation de cet accord. -Contribuer à la traduction --------------------------- - -Comment contribuer -~~~~~~~~~~~~~~~~~~ - -Vous pouvez contribuer : - -- en proposant des *pull requests* Github (solution recommandée) ; -- en envoyant un correctif à la liste `traductions `_. - -Consultez le -`guide `_ -pour apprendre les conventions à respecter. - - -Où obtenir de l'aide ? -~~~~~~~~~~~~~~~~~~~~~~ - -Le coordinateur de cette traduction est `Julien Palard `_. - -N'hésitez pas à poser vos questions sur le canal ``#python-fr`` sur `freenode -`_ (ne nécessite pas d'inscription) ou par la -`liste de diffusion `_ des traductions de l'AFPy. - - Historique du projet -------------------- -Ce projet a été lancé `vers 2000 -`_ puis -repris `vers 2012 `_ par -l'`AFPy `_. En 2017 ce projet est devenu la -traduction officielle de la documentation Python en français grâce à -la `PEP 545 `_. `Jules Lasne -`_ a publié fin 2019 une `vidéo de -l'histoire du dépôt `_. +- vers 2000 : `lancement du projet `_ ; +- vers 2012 : `reprise `_ par l'`AFPy `_ ; +- 2017 : le projet devient traduction officielle de la documentation Python par la `PEP 545 `_. + +Une `vidéo `_ de `Jules Lasne `_ montre l'évolution du dépôt.