nvaccessAuto commented 13 years ago

Reported by orcauser on 2011-03-10 00:17 To improve the quality of localizations, each message marked for translation should have a translators comment, informing the user where and when the message will be presented. These comments are automatically pulled out along with the messages by the po tools, and presented as part of the comments in the po file. This way the translator can easely reproduce the situation, or find the location where the message is being presented, so that they can check if the correct information is being conveyed.

An example of this is:

Translators, this is what is spoken when the user moves onto a line that has no contents

return _("blank")

I realize that there are many such messages that have no comments at the moment, but if new commits follow this convension, then the old messages that do not have comments can be done at a later date.

Thank you.

nvaccessAuto commented 11 years ago

Attachment 1410_new_translatorComments_part1.diff added by nvdakor on 2013-02-03 03:03 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_new_translatorComments_part2.diff added by nvdakor on 2013-02-03 07:44 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130206.diff added by nvdakor on 2013-02-06 11:47 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130208.diff added by nvdakor on 2013-02-08 15:11 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130410.patch added by nvdakor on 2013-04-11 04:58 Description: Latest translator comments as of April 10, 2013.

nvaccessAuto commented 11 years ago

Attachment 1410_20130412.patch added by nvdakor on 2013-04-13 02:27 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130417GitVersion.patch added by nvdakor on 2013-04-18 02:51 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130503.patch added by nvdakor on 2013-05-03 11:10 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130607.patch added by nvdakor on 2013-06-08 09:33 Description:

nvaccessAuto commented 11 years ago

Attachment 1410_20130612.patch added by nvdakor on 2013-06-12 13:23 Description:

nvaccessAuto commented 13 years ago

Comment 1 by jteh on 2011-03-10 00:19 Changes: Milestone changed from None to near-term

nvaccessAuto commented 13 years ago

Comment 2 by jteh on 2011-05-26 00:20 Is the blank comment line actually required or can we just do:

# Translators, this is what is spoken when the user moves onto a line that has no contents
return _("blank")

To do this, we'll need to move to using xgettext instead of pygettext, as pygettext doesn't support translator comments.

nvaccessAuto commented 13 years ago

Comment 3 by jteh on 2011-05-26 00:50 See also #1524 re switching to xgettext.

nvaccessAuto commented 13 years ago

Comment 4 by jteh on 2011-05-26 07:26 The blank comment line isn't required.

We want to add --add-comments=Translators: to the xgettext command line.

nvaccessAuto commented 12 years ago

Comment 5 by jteh on 2012-01-18 07:47 We now use xgettext as of b2870388332675fc2c0b0e96bbf3976ad6d0a461. The build server has been updated accordingly.

What should be the criteria for closing this ticket? The framework is all there and we're already starting to use them, but it'll probably be some time before we update all existing strings. I think a gradual process makes much more sense than trying to do them all at once.

nvaccessAuto commented 12 years ago

Comment 6 by orcauser (in reply to comment 5) on 2012-01-20 09:22 Replying to jteh:

What should be the criteria for closing this ticket?

At the moment about 17% of messages have associated translator comments. I think we should keep this open for a bit longer so that we get to add translator comments for the most difficult cases.

I think a gradual process makes much more sense than trying to do them all at once.

Agreed, maybe if a file is touched for other reasons, we should take the opportunity to add comments on a follow up commit.

nvaccessAuto commented 11 years ago

Comment 7 by nvdakor on 2013-02-02 21:33 Hi, This is quite an old ticket, but thought I'd comment on it in case we return to this. Can we extend the scope of translator comments to add-ons as well? This would benefit translators of add-ons who may need examples and would help them better understand what the add-on message is saying. Thanks.

nvaccessAuto commented 11 years ago

Comment 8 by jteh (in reply to comment 7) on 2013-02-03 00:01 Replying to nvdakor:

Can we extend the scope of translator comments to add-ons as well?

That's up to the add-on maintainers. There's nothing that we can or need to do in NVDA itself to make this happen for add-ons.

nvaccessAuto commented 11 years ago

Comment 9 by nvdakor on 2013-02-03 03:05 Hi, I have attached the first of a series of new translator comments (some of them have example outputs). This would mostly benefit new translators. The bundle is a BZR bundle (working on a separate branch on my computer).

nvaccessAuto commented 11 years ago

Comment 10 by nvdakor on 2013-02-03 07:45 Hi, As of part 2, about 60% of messages has translator comments. Thanks.

nvaccessAuto commented 11 years ago

Comment 11 by nvdakor on 2013-02-06 11:47 Hi, Attached the latest translator comment additions as of February 6th. So far, 62 percent of messages have translator comments, including some appModule messages, names of braille displays and some global commands. A few difficulties/concerns:

Some messages are grouped together on same line (examples are quick navigation commands for virtual buffer).
What should the translator comments be fore input help mode messages? Thanks.

nvaccessAuto commented 11 years ago

Comment 12 by nvdakor on 2013-02-08 15:11 Hi, As of 02/08, about 70 percent of translatable strings have translator comments. New in this edit: settings dialogs have translator comments. MOdified some comments to fix spelling errors and to provide more info. I think the progress is sufficient that I present the newest diff for code review. Thanks.

nvaccessAuto commented 11 years ago

Comment 13 by nvdakor on 2013-04-13 02:28 Hi, Latest comments as of April 12th. About 6 out of 7 messages has comments. Thanks. P.S. I'm taking a break...

nvaccessAuto commented 11 years ago

Comment 14 by nvdakor on 2013-04-18 02:52 Hi, The Git version of new translator comments. Thanks.

nvaccessAuto commented 11 years ago

Comment 15 by nvdakor on 2013-05-03 11:12 Hi, As of May 3rd, 1100 messages have translator comments. Newest entries comes from NvDA menu items. The patch is ready for code review. Thanks.

nvaccessAuto commented 11 years ago

Comment 16 by nvdakor on 2013-06-08 09:34 Hi, Attached is the June edition of translator comments. New in this one includes more global commands, virtual buffers and others. Please try git apply --reject or similar via git am, as some hunks may fail. Thanks.

nvaccessAuto commented 11 years ago

Comment 17 by nvdakor on 2013-06-12 13:24 Hi, As of June 12, 2013, 90 percent of messages have translator comments. Since I'll take a break from this ticket, I present the current patch for code review. When applying, please try git apply --reject. Thank you.

nvaccessAuto commented 11 years ago

Comment 18 by Michael Curran <mick@... on 2013-06-14 00:44 In [9a927bb03914cfd5331acee78cef6a8eec1a860c]:

More translator comments. Now covers 90% of strings. Re #1410 June 12 patch.

nvaccessAuto commented 11 years ago

Comment 19 by nvdakor on 2013-08-05 01:38 Hi, Added comments on review modes and others. Specifically:

Added input help mode and actual speech output for various review modes.
Script Handler: added comment for braille display commands which emulates keys such as Alt key.
Bonus: in version info, changed the URL from nvda-project.org to nvaccess.org due to web address changes. Also added translator comments, with one of them noting that NONVisual Desktop Access should be left as English as possible. Starting this time, the new comments can be found at: https://bitbucket.org/josephsl/nvda-dev Branch: t1410 Thanks.

nvaccessAuto commented 11 years ago

Comment 20 by nvdakor on 2013-09-12 21:58 September 2013 updates:

Review modes added.
Document revision related strings for WinWord has been added (although some messages may need further revision). Repo: https://bitbucket.org/josephsl/nvda-dev Branch: t1410 Thanks.

nvaccessAuto commented 11 years ago

Comment 21 by MHameed on 2013-10-20 18:40 Thanks Joseph, Merged into master, with some minor fixes. The end is in sight for this ticket :) Please pull or merge master before continuing.

nvaccessAuto commented 11 years ago

Comment 22 by nvdakor on 2013-11-18 01:08 Hi, November 2013 updates:

Added comments for tooltips in NvDA menu entries.
Added comments for cursorManager, scriptManager and few more states in control types. Work in progress at:
Repo: https://bitbucket.org/josephsl/nvda-dev
Branch: t1410
Latest commit: 1b46cb5 Thanks.

nvaccessAuto commented 11 years ago

Comment 23 by nvdakor on 2013-11-22 02:20 Hi, Almost done - 99% of messages have translator comments (excluding Newfon messages). Latest commit:

Repo: http://bitbucket.org/josephsl/nvda-dev
Branch: t1410
Commit: c2676ea

Also added changes entry. Thanks.

jcsteh commented 8 years ago

Almost all strings have translator comments now, so closing this. We can just address any that don't as we discover them.

nvaccess / nvda

Provide comments for translators alongside messages to be localized. #1410

Translators, this is what is spoken when the user moves onto a line that has no contents