538883 - Add localized customizations to bookmarks and search plugins

Status: RESOLVED WONTFIX

(Websites Graveyard :: byob.mozilla.com, enhancement, P2)

Description

[Kev Needham [:kev]]

Similar to how AMO provides a facility to customize information by locale, the configuration wizard should support customizations for both bookmarks and search plugins. Information on the format of the distribution.ini file can be found on the wiki (https://wiki.mozilla.org/Distribution_INI_File).

At a high level, the requirements are as follows:

- Provide a method to select a default locale when multiple locales are selected. If en-US is one of the selected locales, this should be used as the default (but should be user-configurable)
- All locales should use the settings in the default locale if no additional information is provided for other locales
- For each locale, the author should be able to modify, remove, or add entries for the bookmarks and search plugins, up to the maximum allowable number of modifications. These modifications would trump the default settings.
- Locale-specific information would be added to the repack's distribution.ini on build per the format listed above.

Comment 1

[Les Orchard [:lorchard]]

Added time estimate to whiteboard

Comment 2

[Les Orchard [:lorchard]]

Oops.  *Now* added time estimate.  Along with bug 538615, this seems to call for a more format-aware handling of the INI generation.  Might need some more examples and possibly some consideration of the UI changes required to make these locale customizations work for BYOB.  That may tweak the time estimate one way or another.

Comment 3

[Kev Needham [:kev]]

Ok. We can bump the priority down as well, if needed. I'd rather get global support for folders and search plugins first, as the majority of repacks will be unilingual, but I can provide additional information on how localization works in the ini and distribution directory.

Comment 4

[Les Orchard [:lorchard]]

Bumping to a v1.5 milestone (Q3)

Comment 5

[Les Orchard [:lorchard]]

r72533 adds an initial stab at an L10N UI for bookmark management. Validation is disabled for now as I figure out how to get it working across locales, so you can enter invalid URLs and such. Hopefully I'll have that worked out soonish

Comment 6

[Les Orchard [:lorchard]]

FWIW, something I realized after butting heads with distribution.{ini,js} for a bit is this: Though individual bookmarks can be localized, locales can't have completely different sets of bookmarks.

That is, you can localize any given bookmark with different title/desc/URL. But, the folder structure, type (eg. livemark/bookmark), and number of bookmarks can't be changed between locales.

If we want to get completely different bookmarks between locales, I think we'd need to have some way of making the repack script pick a per-locale distribution.ini.  That sounds like trouble.

Comment 7

[Les Orchard [:lorchard]]

r72605 should enable both server and client side validation for bookmark data. Not sure the UI is the most intuitive, but it does try to highlight both the locales where errors are present, as well as the fields.

Comment 8

[Les Orchard [:lorchard]]

So... I'm not seeing separate bookmarks sets per locale working, and still not sure how it would work with the current code in distribution.js.  Maybe I've got the syntax wrong, so here's a sample of something I tried building repacks from. 

Only the en-US set of bookmarks shows up, and things like item.de / item.es-AR are ignored. The per-bookmark localizations do work, though.

[BookmarksToolbar]
item.de.1.type=folder
item.de.1.title=Test1
item.de.1.folderId=bm-1283387623159-1
item.de.2.type=bookmark
item.de.2.title=Test2
item.de.2.link=http://decafbad.com/blog/
item.en-GB.1.type=folder
item.en-GB.1.title=Foobar
item.en-GB.1.folderId=bm-1283444576175-1
item.en-GB.2.type=bookmark
item.en-GB.2.title=Bazfoo
item.en-GB.2.link=http://sdfsfsd.com
item.1.type=bookmark
item.1.title=0xDECAFBAD
item.1.title.es-AR=0xDECAFBAD for es-AR
item.1.link=http://es-AR.decafbad.com/blog/
item.2.type=livemark
item.2.title=Blog
item.2.siteLink=http://decafbad.com/blog/
item.2.feedLink=http://decafbad.com/blog/feed/
item.3.type=bookmark
item.3.title=Recommended Addons
item.3.link=https://addons.mozilla.org/en-US/firefox/collection/webdeveloper/
item.3.description=Recommended Addons
item.es-AR.1.type=bookmark
item.es-AR.1.title=Quux
item.es-AR.1.link=http://decafbad.com

[BookmarksFolder-bm-1283387623159-1]
item.de.1.type=bookmark
item.de.1.title=Zombies
item.de.1.link=http://decafbad.com

[BookmarksFolder-bm-1283444576175-1]
item.en-GB.1.type=bookmark
item.en-GB.1.title=Narf
item.en-GB.1.link=http://sdfsfsd.com

Comment 9

[Les Orchard [:lorchard]]

r74240 implements the UI for separate bookmark sets per locale, as well as producing a distribution.ini like the one above.  It won't actually work in builds yet, but it should work all the way up to that point.

Comment 10

[Carsten Book [:Tomcat]]

this is now realized in byob right?

Comment 11

[Chris Cooper [:coop] (he/him)]

http://kev.deadsquid.com/?p=1219