Closed Bug 1424683 Opened 7 years ago Closed 7 years ago

Introduce brand.ftl

Categories

(Core :: Internationalization, defect, P3)

defect

Tracking

()

RESOLVED FIXED
mozilla60
Tracking Status
firefox60 --- fixed

People

(Reporter: zbraniecki, Assigned: zbraniecki)

References

Details

Attachments

(1 file)

Many sections of migrating Preferences to Fluent require brand.ftl to exist. I'd like to isolate the introduction of this file to a separate bug to be able to land it earlier and make all other patches smaller.
Assignee: nobody → gandalf
Blocks: 1415730
Status: NEW → ASSIGNED
Priority: -- → P3
No longer blocks: 1415730
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review215038 We'll need good localization notes in each branding file. Both on how to extend these, and on the trademark policies. Might need help from flod and Pei to get those started, and then maintained. Also, in our 0.5-or-not, can we use private-message `-` prefix, or does that depend on 0.5? playground gives me a parsing error. ::: browser/branding/nightly/locales/en-US/brand.ftl:5 (Diff revision 1) > +# This Source Code Form is subject to the terms of the Mozilla Public > +# License, v. 2.0. If a copy of the MPL was not distributed with this > +# file, You can obtain one at http://mozilla.org/MPL/2.0/. > + > +-brand-short-name = Firefox This should be `Nightly`. ::: python/l10n/fluent_migrations/bug_1424683_brand_short_name.py:4 (Diff revision 1) > +# coding=utf8 > + > +# Any copyright is dedicated to the Public Domain. > +# http://creativecommons.org/publicdomain/zero/1.0/ This file fails in the python linter.
Attachment #8937641 - Flags: review?(l10n) → review-
Thanks Axel! > We'll need good localization notes in each branding file. Both on how to extend these, and on the trademark policies. Might need help from flod and Pei to get those started, and then maintained. Yep, NI'ing both. > Also, in our 0.5-or-not, can we use private-message `-` prefix, or does that depend on 0.5? playground gives me a parsing error. No, this is 0.5 syntax. Updating dependencies :)
Depends on: 1426053
Flags: needinfo?(pmo)
Flags: needinfo?(francesco.lodolo)
I feel like the comment needs to be explicit. # Firefox must be treated as a brand, and kept in English. # It cannot be: # - Declined to adapt to grammatical case. # - Transliterated. # - Translated. # # Reference: https://www.mozilla.org/styleguide/communications/translation/ I wonder if we should go as far as to write 'Firefox' in the l10n files in migration, since right now we have localized versions. https://transvision.mozfr.org/string/?entity=browser/branding/official/brand.dtd:brandShortName&repo=gecko_strings We hope it will change in the future, since we started the discussion, but we're not there yet. On Peiying is the next step for that process in January (write doc, share it with branding and legal). If we can decline it in the future, we will update the comment and add examples on how to do it.
Flags: needinfo?(francesco.lodolo)
(In reply to Francesco Lodolo [:flod] from comment #5) > I wonder if we should go as far as to write 'Firefox' in the l10n files in > migration, since right now we have localized versions. > https://transvision.mozfr.org/string/?entity=browser/branding/official/brand. > dtd:brandShortName&repo=gecko_strings I guess that will mess up attribution, so it might not be a wonderful idea.
Side question: only the official (release) brand is exposed these days, here we're exposing Nightly as well. Have we considered why it wasn't exposed in the past (I don't know…), and if those reasons are still valid?
IIRC, it was "let's not bother localizers about strings only used in pre-release channels".
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review215352 Drats, forgot `browser/locales/l10n.*` config files. l10n.toml, l10n.ini, filter.py.
Attachment #8937641 - Flags: review?(l10n) → review-
> Drats, forgot `browser/locales/l10n.*` config files. l10n.toml, l10n.ini, filter.py. I don't understand. Can you explain what is needed with those files for brand.ftl?
Flags: needinfo?(l10n)
You'll need to replicate what's done for browser/branding/official for each of the new branding directories, https://dxr.mozilla.org/mozilla-central/search?q=browser%2Fbranding%2Fofficial+path%3Abrowser%2Flocales&redirect=false find the spots where we do stuff right now.
Flags: needinfo?(l10n)
> You'll need to replicate what's done for browser/branding/official for each of the new branding directories, But... I think I'm not introducing any new branding directories... Or am I? I'm confused.
You are exposing existing branding directories to localizers that weren't exposed before. That's why we need to update the l10n configs for it. In the current state of your patch, I expect that the branding for nightly or aurora won't be reported as missing strings against a full localization.
> You are exposing existing branding directories to localizers that weren't exposed before. That's why we need to update the l10n configs for it. I am not doing that either I think. aurora, nightly and unofficial carry the "en-US/" path in jar.mn making them always pick the en-US directory rather than "%". Only "official" directory gets exposed, much like it is today. > In the current state of your patch, I expect that the branding for nightly or aurora won't be reported as missing strings against a full localization. Should it be tho? I'm confused. I tried to replicate the same behavior as the current code does.
Oh, right, somehow my brain thought we had exposed the pre-release branding files to l10n already, but we didn't yet. Sorry, ignore my ramblings.
(In reply to Francesco Lodolo [:flod] from comment #5) > I feel like the comment needs to be explicit. > > # Firefox must be treated as a brand, and kept in English. > # It cannot be: > # - Declined to adapt to grammatical case. > # - Transliterated. > # - Translated. This comment looks good: stating it must remain in English. If this is Firefox only, then leave it as is. But this branding policy extends to Mozilla and Pocket, let's add the brands to the list. Do we have a Product/Feature Name file list? Most people get confused with Brands. Are we ok to let people localize product names? If this is a separate topic, do we have plan for a file for that? > # > # Reference: https://www.mozilla.org/styleguide/communications/translation/ > > I wonder if we should go as far as to write 'Firefox' in the l10n files in > migration, since right now we have localized versions. > https://transvision.mozfr.org/string/?entity=browser/branding/official/brand. > dtd:brandShortName&repo=gecko_strings > > We hope it will change in the future, since we started the discussion, but > we're not there yet. On Peiying is the next step for that process in January > (write doc, share it with branding and legal). Will send out a draft for all of you to review before reaching out to Tim M and Elvin L. > > If we can decline it in the future, we will update the comment and add > examples on how to do it. If the Brand file can be modified when policy is officially changed and can be implemented, we can communicate it later. Yes, having examples in the file will be good, or explicit examples are provided in a localizer-doc file.
Flags: needinfo?(pmo)
(In reply to Peiying Mo [:CocoMo] (PTO Dec 18-21) from comment #16) > This comment looks good: stating it must remain in English. If this is > Firefox only, then leave it as is. But this branding policy extends to > Mozilla and Pocket, let's add the brands to the list. This is "Firefox" only. We might end up adding other brands in the future (e.g. Pocket), but that's out of scope for this bug. > Do we have a Product/Feature Name file list? What do you mean?
> > > Do we have a Product/Feature Name file list? > > What do you mean? Screenshots, Sync, Test Pilot... Also, when we have a hybrid of product and brand name such as Firefox Screenshots (assuming Screenshots is localizable), at this interim stage, are we ok with Firefox in English but Screenshots is localized? The discussion a year ago was an yes in such case from branding and legal perspective.
OK, definitely unrelated to this bug, more to the general discussion about branding ;-)
Thanks all, I updated the files to include the comment from comment 5. I set is a section comment in order to allow for clustering of all messages related to Firefox brand under it (and in the future, maybe there'll be other sections for other brands).
I separated out https://github.com/mozilla-l10n/localizer-documentation/issues/104 for documentation discussion. This bug depends on the outcome of that.
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review216420 ::: browser/branding/official/locales/en-US/brand.ftl:7 (Diff revisions 2 - 3) > # License, v. 2.0. If a copy of the MPL was not distributed with this > # file, You can obtain one at http://mozilla.org/MPL/2.0/. > > +## Firefox Brand > +## > +## Firefox must be treated as a brand, and kept in English. nit: drop trailing space
(In reply to Francesco Lodolo [:flod] from comment #6) > (In reply to Francesco Lodolo [:flod] from comment #5) > > I wonder if we should go as far as to write 'Firefox' in the l10n files in > > migration, since right now we have localized versions. > > https://transvision.mozfr.org/string/?entity=browser/branding/official/brand. > > dtd:brandShortName&repo=gecko_strings > > I guess that will mess up attribution, so it might not be a wonderful idea. Further thought on this. We could: * Do the migration of files as they are, to keep attribution. * Revert locales that are translating Firefox (ar, fa, ml, pa-IN, ta, xh) in a separate tracking bug, and communicate out this change to the mailing list, also to give an update on the current status.
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review218168
Attachment #8937641 - Flags: review?(l10n) → review+
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review223204 ::: python/l10n/fluent_migrations/bug_1424683_brand_short_name.py:19 (Diff revision 4) > + ctx.add_transforms( > + 'browser/branding/official/brand.ftl', > + 'browser/branding/official/locales/en-US/brand.ftl', > + [ > + FTL.Message( > + id=FTL.Identifier('brand-short-name'), This should be -brand-short-name
thanks, fixed.
Depends on: 1435183
Comment on attachment 8937641 [details] Bug 1424683 - Introduce brand.ftl and migrate brand-short-name to it. https://reviewboard.mozilla.org/r/208320/#review223292 ::: python/l10n/fluent_migrations/bug_1424683_brand_short_name.py:18 (Diff revision 5) > + > + ctx.add_transforms( > + 'browser/branding/official/brand.ftl', > + 'browser/branding/official/locales/en-US/brand.ftl', > + [ > + FTL.Message( This should be an FTL.Term now :)
Depends on: 1437833
Depends on: 1437950
Pushed by zbraniecki@mozilla.com: https://hg.mozilla.org/integration/autoland/rev/45251f75803b Introduce brand.ftl and migrate brand-short-name to it. r=Pike
Status: ASSIGNED → RESOLVED
Closed: 7 years ago
Resolution: --- → FIXED
Target Milestone: --- → mozilla60
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: