1520560 - Change Sync tooltip from "Firefox Account" to "Sync"

Status: VERIFIED FIXED

(Firefox :: Sync, enhancement, P2)

Description

[Ryan Feeley [:rfeeley]]

Let's make our language more clear as Sync preferences should be called that.

current pane title: Firefox Account
proposed panel title: Sync

https://hg.mozilla.org/l10n/gecko-strings/file/default/browser/browser/preferences/preferences.ftl#l62

Comment 1

[Lina Butler [:lina]]

Attachment: Screen Shot 2019-02-05 at 1.11.55 PM.png

To be clear, would you like us to rename "Firefox Account" to "Sync" here?

Comment 2

[Alex Davis [:adavis]]

Yes. The preferences there are all Sync related, not specifically account related.
It's also to not confuse with Accounts web-based preferences

Comment 3

[Lina Butler [:lina]]

Great, thanks!

For this bug, we'll need to change https://searchfox.org/mozilla-central/rev/490ab7f9b84570573a49d7fa018673ce0d5ddf22/browser/locales/en-US/browser/preferences/preferences.ftl#58,60 from "Firefox Accounts" to "Sync", and also change pane-sync-title to pane-sync-title2, since it's a new string.

Then we'll need to change https://searchfox.org/mozilla-central/rev/490ab7f9b84570573a49d7fa018673ce0d5ddf22/browser/components/preferences/in-content/sync.xul#14,73 and https://searchfox.org/mozilla-central/rev/490ab7f9b84570573a49d7fa018673ce0d5ddf22/browser/components/preferences/in-content/preferences.xul#139 to reference pane-sync-title2 instead.

Comment 4

[Adam Czyzewski]

Hi,

I'd like to take this bug and contribute a patch later on if I manage to solve it. I've familiarized myself with Firefox structure, however, I'm a new member and would appreciate any guide.

Could I get assigned to this bug?

Best,

Adam

Comment 5

[Mark Hammond [:markh] [:mhammond]]

Hi Adam,
Thanks for your interest. We generally assign bugs after a patch has been put up, so if you can follow the instructions from Lina in comment 3, and submit a patch via the instructions at https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/How_to_Submit_a_Patch, we'll assign the bug to you, then review the patch (which may request you make a change or 2), and we'll be well on the way to getting your patch landed into Firefox!

Comment 6

[Adam Czyzewski]

Attachment: 1520560.patch

I've followed the instructions and created the patch. Seems to be working fine!

Comment 7

[Lina Butler [:lina]]

Comment on attachment 9044955 [details] [diff] [review]
1520560.patch

Thanks so much, Adam! This looks great to me, but Fluent files need l10n peer review, so adding Flod. :-)

Comment 8

[Francesco Lodolo [:flod]]

Sorry, I need more information.

@Alex (or anyone else who could answer)

What's "Sync" here? It's a generic "sync" (short for synchronize), or the name of the "Sync" feature?

If it's the former, it should be noted in a comment and this can be translated freely. If it's not, we should use the corresponding term { -sync-brand-short-name }.

I assume it's the feature name, but let's make sure.

@Adam

Let's wait for an answer to this question before updating the patch. There's another thing to fix though.

When a string changes, we need to assign a new message ID, to make sure we invalidate all existing translations. In this case, the title changes, and you changed the ID adding a 2.

category-sync =	
    .tooltiptext = { pane-sync-title }

In Fluent, this is a reference to another message, that at this point won't exist anymore. We need to invalidate existing translations for this string too (i.e. it's a string change), and update the ID:

category-sync2 =	
    .tooltiptext = { pane-sync-title }

Comment 9

[Lina Butler [:lina]]

(In reply to Francesco Lodolo [:flod] from comment #8)

I assume it's the feature name, but let's make sure.

It's the feature name, yes. So we should use -sync-brand-short-name.

In Fluent, this is a reference to another message, that at this point won't exist anymore. We need to invalidate existing translations for this string too (i.e. it's a string change), and update the ID...

Oh, interesting! So the ID of pane-sync-title shouldn't change, but the ID of category-sync should change to category-sync2? Or do they both need to change (to pane-sync-title2 and category-sync2, respectively)?

Comment 10

[Francesco Lodolo [:flod]]

(In reply to Lina Cambridge (she/her) [:lina] from comment #9)

Oh, interesting! So the ID of pane-sync-title shouldn't change, but the ID of category-sync should change to category-sync2? Or do they both need to change (to pane-sync-title2 and category-sync2, respectively)?

They both need to change.

If you don't update the ID for pane-sync-title, nobody will notice the change, and Firefox will happily keep using existing translations ("Firefox Account"). Same goes for for category-sync: if you don't update it, old translations will remain in tree, and the tooltip will be broken, since it references a non-existing message.

Comment 11

[Francesco Lodolo [:flod]]

Comment on attachment 9044955 [details] [diff] [review]
1520560.patch

Review of attachment 9044955 [details] [diff] [review]:
-----------------------------------------------------------------

::: browser/locales/en-US/browser/preferences/preferences.ftl
@@ +54,4 @@
>  category-privacy =
>      .tooltiptext = { pane-privacy-title }
>  
> +pane-sync-title2 = Sync

Per bug discussion, instead of `Sync` this should be `{ -sync-brand-short-name }`.

@@ +58,1 @@
>  category-sync =

You need to update this to `category-sync2`. This means you also need to search for references to this element, and update them.

https://searchfox.org/mozilla-central/search?q=category-sync&path=

You care about `data-l10n-id` (used by Fluent), not just `id` (used by CSS and JS)
https://searchfox.org/mozilla-central/rev/93905b660fc99a5d52b683690dd26471daca08c8/browser/components/preferences/in-content/preferences.xul#135

Comment 12

[Adam Czyzewski]

Attachment: 1520560.patch

I've applied the changes :)

Do we would need a comment about the "Sync" being the name of the feature in the browser/locales/en-US/browser/preferences/preferences.ftl file, or is it self explanatory since we are using { -sync-brand-short-name } now?

Comment 13

[Francesco Lodolo [:flod]]

Comment on attachment 9045338 [details] [diff] [review]
1520560.patch

Review of attachment 9045338 [details] [diff] [review]:
-----------------------------------------------------------------

The rest of the changes look good, but need to revert the ID change (not needed). Also no need for a comment in the FTL file, the use of a term is self-explanatory.

::: browser/components/preferences/in-content/preferences.xul
@@ +127,4 @@
>            <label class="category-name" flex="1" data-l10n-id="pane-privacy-title"></label>
>          </richlistitem>
>  
> +        <richlistitem id="category-sync2"

While that's more in Lina's territory, you shouldn't update this ID (and consequently revert changes to preferences.js and preferences.inc.css).

That's only relevant for code (JS, CSS), the change of "message ID" is only needed for localization, and that requires only changes to the data-l10n-id attribute.

Comment 14

[Adam Czyzewski]

Attachment: Patch for bug 1520560

Thanks for providing the feedback!

I thought changing the name of the id to "category-sync2" would be beneficial, since we would keep one name across all the files related to 'Preferences -> Sync' feature.

Comment 15

[Lina Butler [:lina]]

Comment on attachment 9045463 [details] [diff] [review]
Patch for bug 1520560

Review of attachment 9045463 [details] [diff] [review]:
-----------------------------------------------------------------

Great, thanks very much!

Comment 16

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/mozilla-inbound/rev/d4d8f0d1f542
Rename 'Firefox Account' to 'Sync' by using '{ -sync-brand-short-name }' in Preferences. r=lina,flod

Comment 17

[Cristina Coroiu [:ccoroiu]]

https://hg.mozilla.org/mozilla-central/rev/d4d8f0d1f542

Comment 18

[Mohammad Maruf Rahman]

This bug was about "Changing Sync tooltip from "Firefox Account" to "Sync"" and I have seen it being implemented with latest Nightly on Windows 10, 64 Bit!

Build ID : 20190225102402
User Agent : Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:67.0) Gecko/20100101 Firefox/67.0

Comment 19

[Maria Berlinger [:mberlinger], Services QA]

Updating the flags based on comment 18.