Flock | the social web browser

L10n:Jailbird

L10n:Home Page | L10n:Localization Teams | L10n:Tutorial | L10n:Jailbird

Contents

[edit] Overview

In order to work on Flock Jailbird localization, you don't need anything beside of one of the supported OS (Windows, Mac OS X, Linux) and a text editor.


[edit] Getting started

First, check L10n:Localization_Teams and L10n:Teams_Currently_Forming in order to verify that there are no other people volunteered to work on your locale. If there are, contact them and cooperate, if there are none add your self. If you fail to get any response, mark their nicknames as "inactive" and step in. In case of any problem or lack of response from listed volunteers contact Israel Saeta.

Add yourself to Flock l10n maillist. All news about Localization will be posted there.

Second, check if there exists Localization Team for Firefox for your locale. It will be a lot easier if you'd decide to reuse Firefox localization. We also made it possible to reuse Firefox localization and overwrite files that you want translate on your own (for consistency or quality reasons), or you can localize everything from the scratch. Here you can view Fx l10n.

[edit] Localization methods

Currently, Flock provides two ways to localize it, first one, is to use a zip package delivered by Flock team, and send it back. It allows you to localize without any tool, but has a drawbacks like, it's harder to test your localization, or that if you'll find a bug, you need to send updated file to Flock team and wait for the update. Another method is to use SVN repository on your own. Since Flock stores all localizations in SVN (web view) you can simply get SVN account for yourself, and manage your localization on your own. Adventage of this method is that you don't have to wait for Flock team with any updates, and you can test your localization on your own.

[edit] Testing

If you will choose SVN method, you can pull SVN directory, and build Flock on your own with your localization in order to test its quality. Also, remember, that in order to test Flock, you need to build Flock. For instructions about how to build Flock - visit Fbuild.

Once you have your Flock build, just skip to the section about adding localization to already existing build.

[edit] Choosing method

Now you need to choose your method and skip to the section related to chosen one.

[edit] Localizating zip package

[edit] Localization using SVN account

You need to have SVN client for your platform.

If you have perl on your machine, you also should download compare-locales.pl script. It will allow you to cross check your localization with english version for missing entities.

[edit] Getting SVN access

In order to be able to write into repository, you need to get SVN account.

  1. Please File a bug here: Flocks Bugzilla
  2. For the product select "Flock"
  3. For the component select "Internationalization"
  4. In the bug summary please make sure you add this:
 "Localization account for ab-CD; email@domain.tld", indicating the nickname you'd want to use.

[edit] Without Flock environment

pull Flock l10n trunk: 

 svn co svn://svn.l10n.flock.com/l10n

pull en-US Flock from jailbird branch which is 100% localization ready. 

 svn co svn://svn-mirror.flock.com/master/flock/branches/jailbird/mozilla/flock/locales

Now you can start

  • If there will be any changes before Flock l10n release, there will be message sent to l10n maillist, and update of this wiki

[edit] With Flock environment

First, build Flock using FBuild. Then get SVN access, and using locale_set script choose your locale (locale_set ab_CD - if there is no locale directory in trunk, you need to add it first). Then, erase $o/dist/bin directory and rebuild fbuild.sh. Once it's ready, you have flock in your lanuage. Now, you can edit $m/../l10n/ directory, write updates to svn, and rebuild Flock with updated locales by fbuild.sh.

locale_set not only pulled Flock localization but also Firefox localization for your locale. It means, that beside of $m/../l10n/ab-CD/flock directory which you need to localize, there's also a lot of Firefox directories pulled from CVS. You can overwrite any of those files and add them to SVN to make Flock use your version of those files instead of original ones.


[edit] Localizing Flock 2.0.3 (Jailbird)

[edit] High Level Steps

  1. Make translation
  2. Put it in l10n svn
  3. Check if it is green on stats page (for jailbird branch)
    • if it is not - check errors simply by clicking on language code and correct them
  4. Change status to translated in the release chart below
  5. Test builds , ask people for qa
    • update the chart
  6. If you think your locale is ready for release, change release chart row color to green
    • there will be thread: Opting in to 2.0.3 (TBD)
  • There are some important changes in release process when compared to jailbird, please read about them. Announcement message in list archive (TBD) with files for translation in zip archive.
  • We will be happy to answer all questions, l10n list is probably best place.

[edit] Core Flock Browser:

http://lxr.flock.com/source/flock/mozilla/flock/locales/en-US/

[edit] 1. IF YOU HAVE ALREADY LOCALIZED “TRUNK”

  • Copy the trunk branch to the jailbird branch for your locale in the l10n SVN following these instructions. ab-CD is your locale code, # are comments.
  • cd <l10n-repo-working-copy>
  • svn copy trunk/ab-CD branches/jailbird/ab-CD # copy trunk to jailbird

[edit] 2. IF YOU HAVE NOT LOCALIZED “TRUNK”

  • Copy the grouse branch to the jailbird branch
  • Remove the branding directory then start translating.
  • There is a new “diff tool” available to help you figure out the strings that have changed between Flock 1.2 and 2.0. Please contact Bruno@flock.com for this patch file and further assistance.
  • cd <l10n-repo-working-copy>/branches
  • svn copy grouse/ab-CD jailbird/ab-CD # copy grouse to jailbird
  • cd jailbird/ab-CD/flock
  • svn rm other-licenses # remove the obsolete branding directory
  • If you need help with this process, please contact dukebody [at] flock [dot] com or bryan [at] flock [dot] com


[edit] Search Plugins (L10n) - http://lxr.flock.com/source/flock/mozilla/flock/locales/en-US/searchplugins/

  • Flock en-US includes 9 searchplugins for Yahoo!, Ask, Ebay, Amazon.com, Google, Wink People, Technorati, Digg and Wikipedia. Localizers are requested to translate the names of the search engines unless there is no locale version or specifically prohibited by the engine's terms of service. Localizers are also encouraged to offer suggestions for "relevant" searchplugins for their specific locale. If you have any questions, please contact bryan [at] flock [dot] com.
  • IMPORTANT - If we do not have the appropriate affiliate codes from our supported search services (Yahoo!, Ask, Amazon, Ebay) we will Always default to en-US for that given service.
  • NOTE: Flock has default settings for "Searchplugin Services" and "Searchplugin Order". Please do not modify this for any version of Flock.
  • Edit/add files into the folder: (trunk/es-ES/flock/searchplugins)
  • IMPORTANT: When you have completed the translation of the searchplugins xml files:
  1. Please email bruno [at] flock [dot] com and CC bryan [at] flock [dot] com and dukebody [at] flock [dot] with Subject: "Searchplugin ab-CD completed for review".
  2. Your searchplugin xml files will be reviewed and then added to the flock main repository.
  • If you need help with this please contact dukebody [at] flock [dot] com or bryan [at] flock [dot] com

[edit] Searchpluging Services and Order

Image:Search plugin list.png

  1. yahoo!
  2. ask
  3. ebay
  4. amazon
  5. google
  6. wink people
  7. technorati
  8. digg
  9. wikipedia

[edit] RSS Feeds (L10n) - http://lxr.flock.com/source/flock/mozilla/flock/locales/en-US/chrome/flock/feeds/opml/

  • Flock en-US includes the following default RSS Feeds
    • Flock Folder
      • Flock Blog
    • News
      • The New York Times
    • Entertainment
      • Digg Entertainment
    • Technology
      • Techcrunch.

Localizers are requested to use the local version of these RSS Feed services where applicable. Some locales may not have a localized version of what we ship by default (for example: The New York Times is not published in Germany. Bild.de is however, very popular in Germany and can replace The New York Times). Remember, If you do add new RSS feeds, it has to applicable and appropriate for the specific category(s) of your locale. If you have any questions, please contact bryan [at] flock [dot] com.


NOTE: Flock has default settings for "RSS Feeds Folders". Please do not add or remove the default folders for the RSS Feeds.

  • Edit/add files into the folder: ( trunk/flock/chrome/flock/feeds/opml/default.opml)
  • IMPORTANT:
  1. New categories cannot be added (only the rss feed can be changed).
  2. Please Localize the Category heading. (for example: News, Entertainment and Technology should be localized).
  3. You can only add one RSS feed per category.
  4. Flock Folder remains as default.
  5. Add your applicable RSS feed(s) to replace the flock default(s) and then export the .opml file.
  • When you have completed the translation of the default.opml file:
    • Please email your .opml file to bruno [at] flock [dot] com and CC bryan [at] flock [dot] com and dukebody [at] flock [dot] with Subject: "RSS Feeds ab-CD completed for review".
    • Your default.opml file will be reviewed and then added to the flock main repository.
  • If you need help with this please contact dukebody [at] flock [dot] com or bryan [at] flock [dot] com


Image:Feeds sidebar.png

[edit] Favorites (L10n) - http://lxr.flock.com/source/flock/mozilla/flock/locales/en-US/profile/bookmarks.html

  • We have changed the way we handle "Favorites' with Flock 2. We deal with the same as FireFox 3. (html source file).
  • Localizers are requested to use the locale version of these Favorites where applicable. Localizers are also welcome to offer suggestions for "relevant" Favorites for their specific locale. If you have any questions, please contact bryan [at] flock [dot] com.

NOTE: Flock has default settings for "Favorites Folders" and "Favorites Order". Please do not add or remove the default folders for Favorites.

  • Edit/add files into the folder: ( trunk/flock/chrome/flock/profile/bookmarks.html)
  • The easiest way to translate the Favorites is to make the changes live in the browser and then export the bookmarks.html file.

How to export your Flock "Favorites" html file:

  • Go to “Favorites” menu
  • Select “Organize Favorites”
  • Select “Import and Backup
  • Select “Export HTML..." and save as "bookmark.html"
  • IMPORTANT:
  1. Please email bruno [at] flock [dot] com and CC bryan [at] flock [dot] com and dukebody [at] flock [dot] with Subject: "Favorites ab-CD completed for review".
  2. Your bookmarks.html file will be reviewed and then added to the flock main repository.
  • If you need help with this please contact dukebody [at] flock [dot] com or bryan [at] flock [dot] com


  • Flock en-US includes default Favorites:
    • Favorites Toolbar Folder:
      • Share Flock
      • Flock Turtorial
    • Favorites Menu Folder:
      • Flock
      • Facebook
      • MySpace
      • Youtube
      • Digg
      • Flickr
      • Yahoo! Mail
      • Gmail
      • AOL Mail
      • Photobucket
      • Picasa Web Albums
      • Delicious
      • Ma.gnolia
      • Twitter
      • Pownce


Image:Favorites.png

[edit] OOBE (L10n) - http://lxr.flock.com/source//flock/mozilla/flock/locales/en-US/chrome/flock/oobe/

  • Localizers will localize OOBE (Out of Box Experience).
  • All strings have been verified. OOBE has string freeze (updated: sept 29, 2008).
  • If you need help with this please contact dukebody [at] flock [dot] com or bryan@flock.com

Image:Oobe2.png

[edit] Website Changes (L10n) - (Update Page, Release Notes, Tune Up Page)

Note: Flock.com is not localizable at this time. It is our goal to make flock.com fully localizable in the near future.

  • There are three main html pages that need to be translated with the release of 2.0.3:
    • 1. updates.
    • 2. release notes.
    • 3. online favorites
    • 4. 1.2.7 updates page (NEW)
  • We are using google docs for all html translations. This will allow localizers a more efficient and reliable way to track the ongoing localization process of our web translation content.


  • 1. Updates Page (when a user has successfully upgraded to Flock 2.0.3).
  • We will be tracking the translation of the "Updates Page" via Google Docs. This will allow each localizer to contribute and track the changes.
  • IMPORTANT - If you have not yet received an email for your translation of the "Updates Page", please send an email to bryan [at] flock [dot] com and I will add you as a contributor.


  • 2. Release Notes Page (the release notes contain known issues that users should be aware of )
  • We will be tracking the translation of the "Release Notes" pages via Google Docs. This will allow each localizer to contribute and track the changes.
  • IMPORTANT - If you have not yet received an email for your translation of the "Release Notes Page", please send an email to bryan [at] flock [dot] com and I will add you as a contributor.


  • 3. 2.0.3 Tune Up Page
  • IMPORTANT - If you have not yet received an email for your translation of the "Tune Up Page", please send an email to bryan [at] flock [dot] com and I will add you as a contributor.

[edit] Import Wizard (L10n) - (branding.properties):

  • The branding.properties will allow localizers to translate the "Import Wizard" Home Page Selection dialog.
  • Bryan will send the "brandig.properties" file to the L10n Mailing List for string translation. The branding.properties is not localizable at this time. We will translate this the same way we translate the website pages.
  • When you have completed your translation. Please send back your translated branding.properties file to bryan@flock.com with Subject: "branding.properties ab-CD completed for review".
  • If you need help with this please contact bryan [at] flock [dot] com

Image:Import wizard.png

[edit] Additional Notes:

  • More about practices at L10n:Tutorial.
  • Community Edition (mozilla/flock/locales “Sulfur”)
  • NOTE: mozilla/other-licenses/branding/Sulfur is going to be obsolete and the few files it contains will be merged in (which is mozilla/flock/locales)
  • Community Edition: Localizers will localize the community edition.
  • Content Review: Bruno (flock engineer) to review patches involving (core flock browser content, feeds, favorites and localized search engines / searchplugins). All changes in the “community edition” pending a review, then gets pushed to the Flock Branded version (“other-licensee”).

[edit] Contact Information:

[edit] Bryan Hudson - Project Manager for L10n

  • irc://irc.flock.com/#l10n
  • email: bryan [at] flock [dot] com
  • office: +1.250.995.0145
  • mobile: +1.250.514.9463
  • skype: phatbuddhaz
  • aim: phatbuddhaz


[edit] Bruno Calvignac - Lead Flock Engineer (L10n) Contact:

  • email: bruno [at] flock [dot] com
Retrieved from "http://wiki.flock.com/wiki/L10n:Jailbird"