Update documentation page for translators

Started by PG Bug reporting formover 4 years ago6 messagesdocs
Jump to latest
#1PG Bug reporting form
noreply@postgresql.org

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/nls-translator.html
Description:

In the documentation for translators
(https://www.postgresql.org/docs/11/nls-translator.html) it is mentioned to
use any text editor for translating .po files. It can be very error prone
with regular text editors, especiially for non-tech people such as
translators.

I thought you it would be useful to suggest usage of dedicated editors for
.po files, such as "Free PO editor" (https://pofile.net/free-po-editor)
which will guide them how to translate, without file structure errors.

#2Daniel Gustafsson
daniel@yesql.se
In reply to: PG Bug reporting form (#1)
Re: Update documentation page for translators

On 22 Oct 2021, at 13:12, PG Doc comments form <noreply@postgresql.org> wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/nls-translator.html
Description:

In the documentation for translators
(https://www.postgresql.org/docs/11/nls-translator.html) it is mentioned to
use any text editor for translating .po files. It can be very error prone
with regular text editors, especiially for non-tech people such as
translators.

I think this makes sense, having done some translation work myself I agree that
the PO editors out there can help quite a bit. Now, I'm sure anyone interested
is perfectly capable of Googling, but since this chapter is there to help
potential or new contributors I think it's fine to lower the bar and be a bit
more verbose.

I don't feel like linking to any specific tool though, so I just added a small
sentence to indicate that options exist, and that we don't necessarily require
anyone to use a text editor.

CC:ing developers who have spent time with translations for input.

--
Daniel Gustafsson https://vmware.com/

Attachments:

translations.diffapplication/octet-stream; name=translations.diff; x-unix-mode=0644Download+3-1
#3Bruce Momjian
bruce@momjian.us
In reply to: Daniel Gustafsson (#2)
Re: Update documentation page for translators

Is there a reason this patch was not applied?

---------------------------------------------------------------------------

On Fri, Nov 12, 2021 at 02:46:40PM +0100, Daniel Gustafsson wrote:

On 22 Oct 2021, at 13:12, PG Doc comments form <noreply@postgresql.org> wrote:

The following documentation comment has been logged on the website:

Page: https://www.postgresql.org/docs/11/nls-translator.html
Description:

In the documentation for translators
(https://www.postgresql.org/docs/11/nls-translator.html) it is mentioned to
use any text editor for translating .po files. It can be very error prone
with regular text editors, especiially for non-tech people such as
translators.

I think this makes sense, having done some translation work myself I agree that
the PO editors out there can help quite a bit. Now, I'm sure anyone interested
is perfectly capable of Googling, but since this chapter is there to help
potential or new contributors I think it's fine to lower the bar and be a bit
more verbose.

I don't feel like linking to any specific tool though, so I just added a small
sentence to indicate that options exist, and that we don't necessarily require
anyone to use a text editor.

CC:ing developers who have spent time with translations for input.

--
Daniel Gustafsson https://vmware.com/

diff --git a/doc/src/sgml/nls.sgml b/doc/src/sgml/nls.sgml
index d49f44f3f2..0b3c638594 100644
--- a/doc/src/sgml/nls.sgml
+++ b/doc/src/sgml/nls.sgml
@@ -202,7 +202,9 @@ make update-po
<title>Editing the PO Files</title>
<para>
-    The PO files can be edited with a regular text editor.  The
+    The PO files can be edited with a regular text editor. There are also
+    several specialized editors for PO files which can help the process with
+    translation specific features.  The
translator should only change the area between the quotes after
the msgstr directive, add comments, and alter the fuzzy flag.
There is (unsurprisingly) a PO mode for Emacs, which I find quite

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

Indecision is a decision. Inaction is an action. Mark Batterson

#4Daniel Gustafsson
daniel@yesql.se
In reply to: Bruce Momjian (#3)
Re: Update documentation page for translators

On 17 Aug 2022, at 22:56, Bruce Momjian <bruce@momjian.us> wrote:

Is there a reason this patch was not applied?

Only that it fell of my radar, if you think it's adding value I'm happy to get
it done now.

--
Daniel Gustafsson https://vmware.com/

#5Bruce Momjian
bruce@momjian.us
In reply to: Daniel Gustafsson (#4)
Re: Update documentation page for translators

On Wed, Aug 17, 2022 at 10:58:55PM +0200, Daniel Gustafsson wrote:

On 17 Aug 2022, at 22:56, Bruce Momjian <bruce@momjian.us> wrote:

Is there a reason this patch was not applied?

Only that it fell of my radar, if you think it's adding value I'm happy to get
it done now.

Sure, it looked useful to me too.

--
Bruce Momjian <bruce@momjian.us> https://momjian.us
EDB https://enterprisedb.com

Indecision is a decision. Inaction is an action. Mark Batterson

#6Daniel Gustafsson
daniel@yesql.se
In reply to: Bruce Momjian (#5)
Re: Update documentation page for translators

On 17 Aug 2022, at 23:24, Bruce Momjian <bruce@momjian.us> wrote:

On Wed, Aug 17, 2022 at 10:58:55PM +0200, Daniel Gustafsson wrote:

On 17 Aug 2022, at 22:56, Bruce Momjian <bruce@momjian.us> wrote:

Is there a reason this patch was not applied?

Only that it fell of my radar, if you think it's adding value I'm happy to get
it done now.

Sure, it looked useful to me too.

Done, thanks.

--
Daniel Gustafsson https://vmware.com/