Initial setup

  • Revision slug: Localization_Quick_Start_Guide/Initial_setup
  • Revision title: Initial setup
  • Revision id: 342675
  • Created:
  • Creator: ziyunfei
  • Is current revision? No
  • Comment

Revision Content

As a pre-requisite to contributing to the L10n program, you need to have access to code, tools, and a properly configured local environment (i.e., your personal computer). You also need to determine if a localization effort already exists for your locale. Here we'll go over the accounts you need as well as the tools and their configurations you need to set up before contributing.

New or existing

Before anything else, you need to know if you will be creating a new localization or joining an existing one. This will determine what information is most applicable to you throughout the rest of this guide.

Here's what you do:

Look through the existing localization community directory to see if one already exists for your locale.

  1. If a community already exists, reach out to them and ask how you can help.
  2. If a community doesn't exist, send an email to the new-locales newsgroup for additional guidance.

Accounts

There are a handful of accounts that you need to be aware as you begin. They're not required for you to begin contributing, but will be required when you are preparing to produce an official release. For now, simply be aware that these will become important as your efforts progress. These accounts will store your code, contributions, and help you produce an official localization.

hg (Mercurial)
Mercurial is the revision control environment that houses the main Mozilla source code as well as localized code for each official Mozilla localization. You will need this for localizing Mozilla applications. For anyone to gain access to hg repos, you must visit the Mozilla Commiter page and follow the process outlined there. Here is an example bug that illustrates the process well. Use this bug template when filing your hg account registration bug. Add a request about creating your locale's repository to the new locales newsgroup.
SVN
SVN is a revision control environment that Mozilla uses to house Mozilla source websites and their localizations for each official Mozilla localization. See this wiki page about how to gain access to SVN. Add a request about creating your locale's repository to the new locales newsgroup.
Web-based L10n tools
We'll talk about these in a little bit. For now, just be aware that should you choose to use them, you may need to create a personal account.
Mozilla LDAP
You will need a Mozilla LDAP account once you're ready to have your localization registered on the main Mozilla repositories. Add a request about creating your LDAP account to the new locales newsgroup.
Locale-specific Bugzilla component
Having a Bugzilla component specific to your locale will help us to track your localization's progress from first steps to official release. It will also notify us when you're having problems unique to your localization team's work. Add a request about creating your locale's Bugzilla component to the new locales newsgroup.

Local environment tools

Similar to accounts, there is a number of environment tools that you should install on your personal computer. These tools will help you to store your contributions, build Mozilla applications and language packs, and test your work.

Hg (Mercurial)
As noted above, we use Mercurial for maintaining Mozilla source code and localized code. Not only will you need a localization repository to store your localizations, but you need to have it installed and configured on your personal computer as well. You can find everything you need to know about installing and configuring Mercurial for your localization work here.
compare-locales
compare-locales is a Python script that helps you check your work without needing to run Firefox or another application. Install intructions are located here.
L10n checks
L10n checks is another Python script that helps you check your work without running an application. Install instructions are located here.
autoconf 2.13
autoconf is a utility that is vital to manually creating Mozilla application builds and language packs. We use version 2.13 and higher for these builds. You can find the source files and install instructions here.
wget
wget is a command-line utility that allows you to retrieve files using internet protocols. We use it for retrieving files from repositories. You can find the source files and install instructions here.
Perl
Perl is a programming language that will help you create Mozilla application builds and language packs. You can find the source files and install instructions here.
Python
Python is a programming language in which many of our L10n testing scripts are written. You can find the source files and install instructions here.
Locale Switcher or Quick Locale Switcher
Both Locale Switcher and Quick Locale Switcher are add-ons for Mozilla applications. Either one is necessary to enable you to see your work within a Mozilla application. You can install either by searching for them in Firefox's add-ons manager or following these links.
A solid, Unicode-based, text editor
Here are some suggestions:
GNU make
Make is a tool which controls the generation of executables. You can find version 3.79.1 or higher here. Unfortunately, other varieties of make won't do.

End of initial setup

Now that you've finished your initial setup, it's time for the best part: translating!

{{ PreviousNext("Localization_Quick_Start_Guide", "Localization_Quick_Start_Guide/Translation_phase") }}

Revision Source

<p>As a pre-requisite to contributing to the L10n program, you need to have access to code, tools, and a properly configured local environment (i.e., your personal computer). You also need to determine if a localization effort already exists for your locale. Here we'll go over the accounts you need as well as the tools and their configurations you need to set up before contributing.</p>
<h3 id="New_or_existing">New or existing</h3>
<p>Before anything else, you need to know if you will be creating a new localization or joining an existing one. This will determine what information is most applicable to you throughout the rest of this guide.</p>
<p>Here's what you do:</p>
<p>Look through the existing <a class="link-https" href="https://wiki.mozilla.org/L10n:Teams" title="https://wiki.mozilla.org/L10n:Teams">localization community directory</a> to see if one already exists for your locale.</p>
<ol start="1" style="list-style-type: lower-alpha;">
  <li><span style="color:#0000cd;">If a community already exists, reach out to them and ask how you can help.</span></li>
  <li><span style="color:#ff8c00;">If a community doesn't exist, send an <a class="link-https" href="https://groups.google.com/forum/?fromgroups#!forum/mozilla.dev.l10n.new-locales" title="https://groups.google.com/forum/?fromgroups#!forum/mozilla.dev.l10n.new-locales">email to the new-locales newsgroup</a> for additional guidance</span><span style="color:#ff8c00;">.</span></li>
</ol>
<h3 id="Accounts">Accounts</h3>
<p>There are a handful of accounts that you need to be aware as you begin. They're not required for you to begin contributing, but will be required when you are preparing to produce an official release. For now, simply be aware that these will become important as your efforts progress. These accounts will store your code, contributions, and help you produce an official localization.</p>
<dl>
  <dt style="margin-left: 40px;">
    hg (Mercurial)</dt>
  <dd style=" margin-left:=">
    Mercurial is the revision control environment that houses the main Mozilla source code as well as localized code for each official Mozilla localization. You will need this for localizing Mozilla applications. For anyone to gain access to hg repos, you must visit the <a class="external" href="http://www.mozilla.org/hacking/committer/" title="http://www.mozilla.org/hacking/committer/">Mozilla Commiter page</a> and follow the process outlined there. <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=741305" title="https://bugzilla.mozilla.org/show_bug.cgi?id=741305">Here is an example bug</a> that illustrates the process well. Use <a class="link-https" href="https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&amp;component=Repository%20Account%20Requests&amp;rep_platform=All&amp;op_sys=All&amp;cc=l10n%40mozilla.com&amp;short_desc=l10n%20hg%20account%20for%20John%20Doe%20(ab-CD)" title="https://bugzilla.mozilla.org/enter_bug.cgi?product=mozilla.org&amp;component=Repository%20Account%20Requests&amp;rep_platform=All&amp;op_sys=All&amp;cc=l10n%40mozilla.com&amp;short_desc=l10n%20hg%20account%20for%20John%20Doe%20(ab-CD)">this bug template</a> when filing your hg account registration bug. <span style="">Add a request about creating your locale's repository to the <a class="external" href="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics" title="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics">new locales newsgroup</a>.</span></dd>
  <dt style="margin-left: 40px;">
    SVN</dt>
  <dd style="margin-left: 40px;">
    SVN is a revision control environment that Mozilla uses to house Mozilla source websites and their localizations for each official Mozilla localization. See <a class="link-https" href="https://wiki.mozilla.org/SVN#SVN_account_for_localizers" title="https://wiki.mozilla.org/SVN#SVN_account_for_localizers">this wiki page</a> about how to gain access to SVN. <span style="">Add a request about creating your locale's repository to the <a class="external" href="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics" title="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics">new locales newsgroup</a>.</span></dd>
</dl>
<dl>
  <dt style="margin-left: 40px;">
    Web-based L10n tools</dt>
  <dd style="margin-left: 40px;">
    We'll talk about these in a little bit. For now, just be aware that should you choose to use them, you may need to create a personal account.</dd>
  <dt style="margin-left: 40px;">
    Mozilla LDAP</dt>
  <dd style="margin-left: 40px;">
    You will need a Mozilla LDAP account once you're ready to have your localization registered on the main Mozilla repositories. Add a request about creating your LDAP account to the<a class="external" href="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics" title="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics"> new locales newsgroup</a>.</dd>
  <dt style="margin-left: 40px;">
    <span style="">Locale-specific Bugzilla component</span></dt>
  <dd style="margin-left: 40px;">
    <span style="">Having a Bugzilla component specific to your locale will help us to track your localization's progress from first steps to official release. It will also notify us when you're having problems unique to your localization team's work. Add a request about creating your locale's Bugzilla component to the </span><a class="external" href="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics" title="http://groups.google.com/group/mozilla.dev.l10n.new-locales/topics"><span style="">new locales newsgroup</span></a><span style="">.</span></dd>
</dl>
<h3 id="Local_environment_tools">Local environment tools</h3>
<p>Similar to accounts, there is a number of environment tools that you should install on your personal computer. These tools will help you to store your contributions, build Mozilla applications and language packs, and test your work.</p>
<dl>
  <dt style="margin-left: 40px;">
    Hg (Mercurial)</dt>
  <dd style="margin-left: 40px;">
    As noted above, we use Mercurial for maintaining Mozilla source code and localized code. Not only will you need a localization repository to store your localizations, but you need to have it installed and configured on your personal computer as well. You can find everything you need to know about installing and configuring Mercurial for your localization work <a href="/en/Localizing_with_Mercurial#Install_Mercurial" title="https://developer.mozilla.org/en/L10n_on_Mercurial#Install_Mercurial">here</a>.</dd>
</dl>
<dl>
  <dt style="margin-left: 40px;">
    compare-locales</dt>
  <dd style="margin-left: 40px;">
    compare-locales is a Python script that helps you check your work without needing to run Firefox or another application. Install intructions are located <a href="/en/Compare-locales" title="https://developer.mozilla.org/en/Compare-locales">here</a>.</dd>
  <dt style="margin-left: 40px;">
    L10n checks</dt>
  <dd style="margin-left: 40px;">
    L10n checks is another Python script that helps you check your work without running an application. Install instructions are located <a href="/en/L10n_Checks" title="https://developer.mozilla.org/en/L10n_Checks">here</a>.</dd>
  <dt style="margin-left: 40px;">
    autoconf 2.13</dt>
  <dd style="margin-left: 40px;">
    autoconf is a utility that is vital to manually creating Mozilla application builds and language packs. We use version 2.13 and higher for these builds. You can find the source files and install instructions <a class="external" href="http://www.gnu.org/software/autoconf/" title="http://www.gnu.org/software/autoconf/">here</a>.</dd>
  <dt style="margin-left: 40px;">
    wget</dt>
  <dd style="margin-left: 40px;">
    wget is a command-line utility that allows you to retrieve files using internet protocols. We use it for retrieving files from repositories. You can find the source files and install instructions <a class="external" href="http://www.gnu.org/s/wget/" title="http://www.gnu.org/s/wget/">here</a>.</dd>
  <dt style="margin-left: 40px;">
    Perl</dt>
  <dd style="margin-left: 40px;">
    Perl is a programming language that will help you create Mozilla application builds and language packs. You can find the source files and install instructions <a class="external" href="http://www.perl.org/" title="http://www.perl.org/">here</a>.</dd>
  <dt style="margin-left: 40px;">
    Python</dt>
  <dd style="margin-left: 40px;">
    Python is a programming language in which many of our L10n testing scripts are written. You can find the source files and install instructions <a class="external" href="http://python.org/" title="http://python.org/">here</a>.</dd>
  <dt style="margin-left: 40px;">
    Locale Switcher or Quick Locale Switcher</dt>
  <dd style="margin-left: 40px;">
    Both Locale Switcher and Quick Locale Switcher are add-ons for Mozilla applications. Either one is necessary to enable you to see your work within a Mozilla application. You can install either by searching for them in Firefox's add-ons manager or following <a class="link-https" href="https://addons.mozilla.org/en-US/firefox/addon/locale-switcher/" title="https://addons.mozilla.org/en-US/firefox/addon/locale-switcher/">these</a> <a class="link-https" href="https://addons.mozilla.org/en-US/firefox/addon/quick-locale-switcher/" title="https://addons.mozilla.org/en-US/firefox/addon/quick-locale-switcher/">links</a>.</dd>
  <dt style="margin-left: 40px;">
    A solid, Unicode-based, text editor</dt>
  <dd style="margin-left: 40px;">
    Here are some suggestions:
    <ul>
      <li style="margin-left: 40px;">Windows: <a class="external" href="http://notepad-plus.sourceforge.net/uk/site.htm" rel="external nofollow" target="_blank" title="http://notepad-plus.sourceforge.net/uk/site.htm">Notepad++</a> or <a class="external" href="http://www.flos-freeware.ch/notepad2.html" rel="external nofollow" target="_blank" title="http://www.flos-freeware.ch/notepad2.html">Notepad2</a></li>
      <li style="margin-left: 40px;">GNU/Linux: <a class="external" href="http://en.wikipedia.org/wiki/Vim_%28text_editor%29" rel="external nofollow" target="_blank" title="http://en.wikipedia.org/wiki/Vim_(text_editor)">vim</a>, <a class="external" href="http://projects.gnome.org/gedit/" rel="external nofollow" target="_blank" title="http://projects.gnome.org/gedit/">gedit</a> or <a class="external" href="http://www.kate-editor.org/kate" rel="external nofollow" target="_blank" title="http://www.kate-editor.org/kate">Kate</a></li>
      <li style="margin-left: 40px;">Mac OS X: <a class="external" href="http://www.barebones.com/products/TextWrangler/" rel="external nofollow" target="_blank" title="http://www.barebones.com/products/TextWrangler/">TextWrangler</a></li>
    </ul>
  </dd>
  <dt style="margin-left: 40px;">
    GNU make</dt>
  <dd style="margin-left: 40px;">
    <span class="external">Make is a tool which controls the generation of executables. You can find version</span> 3.79.1 or higher <a class="external" href="http://www.gnu.org/software/make/" title="http://www.gnu.org/software/make/">here</a>. Unfortunately, other varieties of <code>make</code> won't do.</dd>
</dl>
<h2 id="End_of_initial_setup">End of initial setup</h2>
<p>Now that you've finished your initial setup, it's time for the best part: translating!</p>
<p>{{ PreviousNext("Localization_Quick_Start_Guide", "Localization_Quick_Start_Guide/Translation_phase") }}</p>
Revert to this revision