Re: Emacs manuals translation readme

[Eli Zaretskii]

> Date: Tue, 13 Feb 2024 02:25:32 +0000
> From: Jean-Christophe Helary <jean.christophe.helary@traductaire-libre.org>
> 
> I gathered all the comments and integrated them, so I think that the 
> patches are now ready for a formal review and eventual installation.
> 
> Are there things that I have overlooked?

Thanks.  I was about to install those changes, but then I saw a few
minor nits that still needed attention:

> From 28bf850f11bb91fdc957141d37ffa14d2df95c02 Mon Sep 17 00:00:00 2001
> From: Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
> Date: Sun, 21 Jan 2024 11:04:09 +0900
> Subject: [PATCH 1/2] Rename doc/lang to doc/translations
> 
> ---
>  doc/{lang => translations}/fr/misc/ses-fr.texi | 0
>  1 file changed, 0 insertions(+), 0 deletions(-)
>  rename doc/{lang => translations}/fr/misc/ses-fr.texi (100%)
> 
> diff --git a/doc/lang/fr/misc/ses-fr.texi 
> b/doc/translations/fr/misc/ses-fr.texi
> similarity index 100%
> rename from doc/lang/fr/misc/ses-fr.texi
> rename to doc/translations/fr/misc/ses-fr.texi

When I wrote doc/LANG/, I meant doc/fr/, doc/de/, etc.  I didn't mean
a literal "LANG" string.  So the above renaming now has an extra
subdirectory, which was not something I had in mind.  Stefan Kangas
agreed with my proposal back then.  So do you object to have manuals
translated to French in doc/fr/, rather than in doc/translations/fr/ ?
If you do not object, please modify the patch accordingly.

>  doc/translations/readme | 203 ++++++++++++++++++++++++++++++++++++++++

Please make that README, in all-upper case.  That is how we name all
the readme files in the tree.

> +People who contribute translated documents should provide a copyright
> +assignment to the Free Software Foundation. See the 'Copyright
> +Assignment' section in the Emacs manual.  ^^

We use the US English convention of leaving 2 spaces between
sentences (here and everywhere else in the patch).

> +The translated documents are distributed under the same licence as the
                                                           ^^^^^^^
Please use the US English spelling: "license".

> +### texinfo source files
> +
> +Translated manuals source files are located in the `doc/translations`
   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
It is better to say "The source files of the translated manuals...",
as the use of so-called "construct state" for more than 2 words is
problematic in English, and produces potentially confusing text.

> +directory, under the directory whose name corresponds to the
> +translated language.
> +
> +  For ex. French manuals sources are found under

Please use "Fore example" or "E.g.", not the short form.

> +  `doc/translations/fr`.

If you agree to place them under doc/fr, the above needs to be
adjusted.  Also, please quote 'like this', not `like this`.

> +The structure of the language folders should match the structure of
> +the English manuals (i.e. include `misc`, `man`, `lispref`,
> +`lispintro`, `emacs`).

Likewise here (and elsewhere: we don't use the Markdown style of
quoting in our text documents.

> +You should install the texinfo utilities to be able to verify the

"Texinfo", capitalized (here and elsewhere in the patch).

> +Send your contributions (either files or revisions) to the emacs-devel
> +list for review.

Please use emacs-devel@gnu.org, to make the address complete.

> +- automatic lookup of a list of glossary items when starting to work
> +on a translation “unit” (paragraph or otherwise), such glossary
                    ^^^^^^
It is better not to use non-ASCII characters, to make sure any
terminal can display the README file.  Here, I suggest "units", with
ASCII double quotes.

Please post a fixed patch, and I will install it.

Thanks.