Re: Emacs manuals translation readme

[Jean-Christophe Helary <jean.christophe.helary@traductaire-libre.org>]

[-- Attachment #1: Type: text/plain, Size: 1335 bytes --]



> On Feb 18, 2024, at 17:00, Eli Zaretskii <eliz@gnu.org> wrote:
> 
>> Date: Sat, 17 Feb 2024 15:07:05 +0000
>> From: Jean-Christophe Helary <jean.christophe.helary@traductaire-libre.org>
>> Cc: emacs-devel@gnu.org
>> 
>> Thank you, Eli.
>> 
>> Here are the patches. And comments inline.
> 
> Thanks, installed on master.

Eli,

I did not think you'd install the file right away and had sent to 
document to a professional proofreader I work with to polish the 
wording.

This patch includes her modifications and a few small things I had 
added in between.

Would you mind considering the propositions?


> I thought you and Stefan preferred to have the files in
> doc/translations/?  So I moved the files there, and also fixed a few
> minor issues I found in README.

Thank you. It looks like a misunderstanding on our parts.

> So now this stuff is in its place and ready for adding more
> translations.  What is still missing is the Make wizardry to produce
> the translated manuals as part of the build and install then as part
> of "make install".  Patches welcome.  When this is done, we should
> call out the translations in NEWS.

I'll need more time to understand the build process but I'll do my best 
to provide a patch, unless somebody does that before me...

Jean-Christophe


[-- Attachment #2: 0001-proofreading-of-translations-README.patch --]
[-- Type: application/octet-stream, Size: 10700 bytes --]

From d0b1ad8babeef25f44035d23f8fc76681f7d61f0 Mon Sep 17 00:00:00 2001
From: Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
Date: Mon, 19 Feb 2024 20:05:14 +0900
Subject: [PATCH] proofreading of translations/README

---
 doc/translations/README | 135 ++++++++++++++++++++--------------------
 1 file changed, 67 insertions(+), 68 deletions(-)

diff --git a/doc/translations/README b/doc/translations/README
index c689f0b14b3..35b9b9e9cf9 100644
--- a/doc/translations/README
+++ b/doc/translations/README
@@ -15,22 +15,23 @@ any later version published by the Free Software Foundation.
 
 See https://www.gnu.org/licenses/fdl-1.3.html for more information.
 
-If you have questions regarding the use of the FDL license in your
-translation work that are not answered in the FAQ, do not hesitate to
-contact the GNU project: https://www.gnu.org/contact/
+If you have any questions regarding the use of the FDL license in your
+translation work that do not appear in the FAQ, feel free to contact the
+GNU project.
 
-** Location
+See https://www.gnu.org/contact/ for more information.
+
+** Location of the translated files
 
 *** Texinfo source files
 
-The source files of the translated manuals are located in the doc/
-directory, under the directory whose name corresponds to the translated
-language.
+The source files of the translated manuals are located in the
+doc/translations directory, under the translated language sub-directory.
 
-  E.g., French manuals sources are found under doc/fr.
+  E.g., French manual sources are found under doc/translations/fr.
 
-The structure of the language folders should match the structure of the
-English manuals (i.e. include misc, man, lispref, lispintro, emacs).
+The structure of each language folder should match that of the English
+manuals (i.e. include misc, man, lispref, lispintro, emacs).
 
 *** built files
 
@@ -38,22 +39,21 @@ Translated deliverables in info format are built at release time and are
 made available for local installation.
 
 
-** Format
+** Source files format
 
 The manuals and their translations are written in the Texinfo format
-(with the exception of the org-mode manual that is written in org-mode
-and of illustrations for the Introduction to Emacs Lisp Programming that
-are written in eps).
+(with the exception of the org-mode manual, which is written in
+org-mode, and illustrations for the Introduction to Emacs Lisp
+Programming, which are written in eps).
 
 See https://www.gnu.org/software/Texinfo/ for more information.
 
-You should install the Texinfo utilities to be able to verify the
-translated files, and refer to the Texinfo manual if you do not
-understand the meaning of the various Texinfo declarations.
+You must install the Texinfo utilities in order to verify the translated
+files, and refer to the Texinfo manual for information on the various
+Texinfo declarations.
 
-Emacs has a Texinfo mode that properly highlights the Texinfo code to
-make it easier to see which parts are text to be translated and which
-parts are not.
+Emacs has a Texinfo mode that highlights the parts of the Texinfo code
+to be translated for easy reference.
 
 
 *** Texinfo specific issues
@@ -61,21 +61,21 @@ parts are not.
 Until the Emacs/Texinfo projects provide better solutions, here are a
 few rules to follow:
 
-- Under each @node, add an @anchor that has the same content at the
-original English @node.
+- Under each @node, add an @anchor that has the same content as the
+  original English @node.
 
 - Translate the @node content but leave the @anchor in English.
 
 - Most Emacs manuals are set to include the docstyle.Texi file.  This
-file adds the @documentencoding UTF-8 directive to the targeted manual.
-There is no need to add this directive in a manual that includes
-docstyle.Texi.
+  file adds the @documentencoding UTF-8 directive to the targeted
+  manual. There is no need to add this directive in a manual that
+  includes docstyle.texi.
 
 - Add a @documentlanguage directive that includes your language.
 
   E.g., @documentlanguage zh
 
-This directive has currently little effect but will be useful in the
+This directive currently has little effect but will be useful in the
 future.
 
 - The @author directive can be used for the translator's name.
@@ -85,34 +85,35 @@ future.
 
 ** Fixing the original document
 
-During the course of the translation, you might find parts of the
-original document that need to be updated or otherwise fixed, or even
-bugs in Emacs.  If you do not intend to provide fixes right away, please
-file a bug report promptly so someone can fix it soon.
+During the course of the translation, you might encounter passages in
+the original document that need to be updated or otherwise corrected, or
+even run into a bug in Emacs.  If you cannot immediately correct the
+problem, please file a bug report promptly.
 
 See the 'Bugs' section in the Emacs manual.
 
-** Sending contributions
+** Sending your contributions
 
-Send your contributions (either files or revisions) to
-emacs-devel@gnu.org for review.
+Send your contributions (files or revisions) for review to the Emacs
+development list at emacs-devel@gnu.org. Subscribing to the list is not
+obligatory.
 
 Always send contributions in the format of the original document.  Most
-of the contents in the Emacs manuals are in Texinfo format, so do not
-send contributions that are in derivative formats (e.g., info, html,
-docbook, plain text, etc.)
+of the content in the Emacs manuals is in Texinfo format, so please do
+not send contributions in derivative formats (e.g. info, html, docbook,
+plain text, etc.)
 
-Before sending files for review, ensure that they have been properly
-checked for spelling/grammar/typography by at least using the tools that
-Emacs provides.
+Before sending files for review, please ensure that they have been
+thoroughly checked for spelling/grammar/typography by at least using the
+tools provided by Emacs.
 
-You should also make sure that the Texinfo files build properly on your
+Please also make sure that the Texinfo files build properly on your
 system.
 
 Send your contributions as patches (git diff -p --stat), and prefer the
-git format-patch form because the format allows easier review and easier
-installation of the changes by someone with write access to the
-repository.
+git format-patch form, since the format allows for easier review and
+easier installation of the changes by the persons with write access to
+the repository.
 
 The Emacs project has a lot of coding, documentation and commenting
 conventions.  Sending such patches allows the project managers to make
@@ -121,25 +122,24 @@ sure that the contributions comply with the various conventions.
 
 ** Discussing translation issues
 
-Translation-related discussions are welcome on the emacs-devel list.
-Discussions specific to your language do not have to take place in
+Translation-related discussions are welcome on the emacs development
+list. Discussions specific to your language do not have to be in
 English.
 
 
 ** Translation teams
 
-The number of words in the Emacs manuals is above 2,000,000 words and
+The number of words in the Emacs manuals is over 2,000,000 words and
 growing.  While one individual could theoretically translate all the
 files, it is more practical to work in language teams.
 
-If you have a small group of translators willing to help, make sure that
-the files are properly reviewed before sending them to emacs-devel (see
-above).
+If you have a small group of translators willing to help, please make
+sure that the files are properly reviewed before sending them to the
+Emacs development list (see above).
 
-You are invited to refer to the translation-related documents that the
-GNU Project maintains and to get in touch with your language's
-translation team to learn from the practices they have developed over
-the years.
+Please refer to the translation-related documents maintained by the GNU
+Project, and contact your language translation team to learn the
+practices they have developed over the years.
 
 See https://www.gnu.org/server/standards/README.translations.html for
 more information.
@@ -148,46 +148,45 @@ more information.
 ** Translation processes
 
 Emacs does not yet provide tools that significantly help the translation
-process.  A few useful functions would be
+process.  A few useful functions would be:
 
 - automatic lookup of a list of glossary items when starting to work on
-a translation "unit" (paragraph or otherwise), such glossary terms
-should be easily insertable at point,
+  a translation "unit" (paragraph or otherwise); such glossary terms
+  should be easily insertable at point,
 
 - automatic lookup of past translations to check for similarity and
-improve homogeneity over the whole document set, such past translation
-matches should be easily insertable at point,
-
-etc.
+  improve homogeneity over the whole document set; such past translation
+  matches should be easily insertable at point, etc.
 
 
 *** Using the PO format as an intermediate translation format
 
 Although the PO format has not been developed with documentation in
-mind, it is well known among free software translation teams and you can
-easily use the po4a utility to convert Texinfo to PO for work in
+mind, it is well-known among free software translation teams, and you
+can easily use the po4a utility to convert Texinfo to PO for work in
 translation tools that support the PO format.
 
 See https://po4a.org for more information.
 
 However, regardless of the intermediate file format that you might use,
-you should only send Texinfo files for review to emacs-devel.
+you should only send files in the original format (Texinfo, org-mode,
+eps) for review and installation.
 
 
 *** Free tools that you can use in your processes
 
-A number of free software tools exist, outside the Emacs ecosystem, to
-help translators (amateurs and professionals alike) with the translation
-process.
+A number of free software tools are available outside the Emacs
+ecosystem, to help translators (both amateur and professional) in the
+translation process.
 
-If you find that Emacs should implement some of their features, you are
+If they have any features that you think Emacs should implement, you are
 welcome to provide patches to the Emacs project.
 
 Such tools include:
 
 - the GNOME Translation Editor, https://wiki.gnome.org/Apps/Gtranslator/
 - KDE's Lokalize, https://apps.kde.org/lokalize/
-- OmegaT, http://omegat.org
+- OmegaT, https://omegat.org
 - the Okapi Framework, https://www.okapiframework.org
 - pootle, https://pootle.translatehouse.org
 
-- 
2.43.0