am 477897ad: Merge "Fix incorrect setting of TaskRecord.frontOfTask. DO NOT MERGE...

[android-x86/frameworks-base.git] / docs / html / guide / topics / resources / localization.jd

page.title=Localizing with Resources\r
parent.title=Application Resources\r
page.tags="localizing","localization","resources", "formats", "l10n"\r
parent.link=index.html\r
@jd:body\r
\r
<div id="qv-wrapper">\r
    <div id="qv">\r
\r
<h2>Quickview</h2>\r
\r
<ul>\r
  <li>Use resource sets to create a localized app.</li>\r
  <li>Android loads the correct resource set for the user's language and locale.</li>\r
  <li>If localized resources are not available, Android loads your default resources.</li>\r
</ul>\r
\r
<h2>In this document</h2>\r
<ol>\r
  <li><a href="#resource-switching">Overview: Resource-Switching in Android</a></li>\r
<li><a href="#using-framework">Using Resources for Localization</a></li>\r
<li><a href="#strategies">Localization Tips</a></li>\r
<li><a href="#testing">Testing Localized Applications</a></li>\r
</ol>\r
\r
<h2>See also</h2>\r
  <ol>\r
    <li><a href="{@docRoot}distribute/googleplay/publish/localizing.html">Localization Checklist</a></li>\r
    <li><a href="{@docRoot}guide/topics/resources/providing-resources.html">Providing Resources</a></li>\r
    <li><a href="{@docRoot}guide/topics/ui/declaring-layout.html">Layouts</a></li>\r
    <li><a href="{@docRoot}reference/android/app/Activity.html#ActivityLifecycle">Activity Lifecycle</a></li>\r
</ol>\r
</div>\r
</div>\r
\r
<p>Android will run on many  devices in many  regions. To reach the most users,\r
your application should handle text, audio files, numbers, currency, and\r
graphics in ways appropriate to the locales where your application will be used.\r
</p>\r
\r
<p>This document describes best practices for localizing Android\r
applications. The principles apply whether you are developing your application  \r
using ADT with Eclipse, Ant-based tools, or any other IDE. </p>\r
\r
<p>You should already have a working knowledge of Java and be  familiar with\r
Android resource loading, the declaration of user interface elements in XML,\r
development considerations such as Activity lifecycle, and general principles of\r
internationalization and localization. </p>\r
\r
<p>It is good practice to use the Android resource framework to separate the\r
localized aspects of your application as much as possible from the core Java\r
functionality:</p>\r
\r
<ul>\r
  <li>You can put most or all of the <em>contents</em> of your application's\r
user interface into resource files, as described in this document and in <a\r
href="{@docRoot}guide/topics/resources/providing-resources.html">Providing Resources</a>.</li>\r
  <li>The <em>behavior</em> of the user interface, on the other hand, is driven\r
by your Java code. \r
    For example, if users input data that needs to be formatted or sorted\r
differently depending on locale, then you would use Java to handle the data\r
programmatically. This document does not cover how to  localize your Java code.\r
</li>\r
</ul>\r
\r
<p>For a short guide to localizing strings in your app, see the training lesson, <a\r
href="{@docRoot}training/basics/supporting-devices/languages.html">Supporting Different Languages</a>. </p>\r
\r
\r
<h2 id="resource-switching">Overview: Resource-Switching in Android</h2>\r
\r
<p>Resources are text strings, layouts, sounds, graphics, and any other static\r
data that your  Android application  needs. An application can include multiple\r
sets of resources, each customized for a different device configuration. When a\r
user runs the application,  Android    automatically selects and loads the \r
resources that best match the device.</p>\r
\r
<p>(This document focuses on localization and locale. For a complete description\r
of resource-switching and all the types of configurations that you can\r
specify &#8212; screen orientation, touchscreen type, and so on &#8212; see <a\r
href="{@docRoot}guide/topics/resources/providing-resources.html#AlternativeResources">Providing\r
Alternative Resources</a>.)</p>\r
\r
<table border="0" cellspacing="0" cellpadding="0">\r
  <tr border="0">\r
    <td width="180" style="border: 0pt none ;"><p class="special-note">\r
    <strong>When you write your application:</strong>\r
    <br><br>\r
    You create a set of default resources, plus alternatives to be used in\r
    different locales.</p></td>\r
    <td style="border: 0pt none; padding:0">\r
    <p style="border:0; padding:0"><img src="../../../images/resources/right-arrow.png" alt="right-arrow" \r
    width="51" height="17"></p></td>\r
    <td width="180" style="border: 0pt none ;"><p class="special-note">\r
    <strong>When a user runs your application:</strong>\r
    <br><br>The Android system selects which resources to load, based on the\r
    device's locale.</p></td>\r
  </tr>\r
</table>\r
\r
<p>When you write your application, you create default and alternative resources\r
for your application to use. To create  resources, you place files within\r
specially named subdirectories of the project's <code>res/</code> directory.\r
</p>\r
\r
\r
\r
<h3 id="defaults-r-important">Why Default Resources Are Important</h3>\r
\r
<p>Whenever the application runs in a locale for which you have not provided\r
locale-specific text,  Android will load the default strings from\r
<code>res/values/strings.xml</code>. If this default  file is absent, or if it \r
is missing a string that your application needs, then your application will not run \r
and will show an error. \r
The example below illustrates what can happen when the default text file is incomplete. </p>\r
\r
<p><em>Example:</em>\r
<p>An application's Java code refers to just two strings, <code>text_a</code> and \r
        <code>text_b</code>. This application includes a localized resource file \r
        (<code>res/values-en/strings.xml</code>) that defines <code>text_a</code> and \r
        <code>text_b</code> in English. This application also includes a default \r
        resource file (<code>res/values/strings.xml</code>) that includes a\r
definition for <code>text_a</code>, but not for <code>text_b</code>:\r
<ul>\r
  <li>This application might compile without a problem. An IDE such as Eclipse \r
        will not highlight any errors if a resource is missing.</li>\r
  <li>When this application is launched on a device with locale set to English, \r
        the application  might run without a problem, because \r
        <code>res/values-en/strings.xml</code> contains both of the needed text \r
        strings.</li>\r
  <li>However, <strong>the user  will see an error message and a Force Close \r
        button</strong> when this application is launched on a device set to a \r
        language other than English. The application will not load.</li>\r
</ul>\r
\r
\r
<p>To prevent this situation, make sure that a <code>res/values/strings.xml</code> \r
        file exists and that it defines every needed string. The situation applies to \r
        all types of resources, not just strings: You \r
        need to create a  set of default resource files containing all \r
        the resources that your application calls upon &#8212; layouts, drawables, \r
        animations, etc. For information about testing, see <a href="#test-for-default">\r
        Testing for Default Resources</a>.</p>\r
\r
<h2 id="using-framework">Using Resources for Localization</h2>\r
\r
<h3 id="creating-defaults">How to Create Default Resources</h3>\r
\r
<p>Put the application's default text in\r
a file with the following location and name:</p>\r
<p><code>&nbsp;&nbsp;&nbsp;&nbsp;res/values/strings.xml</code> (required directory)</p>\r
\r
<p>The text strings in <code>res/values/strings.xml</code> should  use the\r
default language, which is the language that you expect most of your application's users to\r
speak.  </p>\r
\r
<p>The default resource set must also include any default drawables and layouts, \r
        and can include other types of resources such as animations. \r
<br>\r
  <code>&nbsp;&nbsp;&nbsp;&nbsp;res/drawable/</code>(required directory holding at least\r
  one graphic file, for the application's icon on Google Play)<br>\r
  <code>&nbsp;&nbsp;&nbsp;&nbsp;res/layout/</code> (required directory holding an XML\r
  file that defines the default layout)<br>\r
  <code>&nbsp;&nbsp;&nbsp;&nbsp;res/anim/</code> (required if you have any \r
  <code>res/anim-<em>&lt;qualifiers&gt;</em></code> folders)<br>\r
  <code>&nbsp;&nbsp;&nbsp;&nbsp;res/xml/</code> (required if you have any \r
  <code>res/xml-<em>&lt;qualifiers&gt;</em></code> folders)<br>\r
  <code>&nbsp;&nbsp;&nbsp;&nbsp;res/raw/</code> (required if you have any \r
  <code>res/raw-<em>&lt;qualifiers&gt;</em></code> folders)\r
</p>\r
\r
<p class="note"><strong>Tip:</strong> In your code, examine each reference to \r
        an Android resource. Make sure that a default resource is defined for each\r
        one. Also make sure that the default string file is complete: A <em>\r
        localized</em> string file can contain a subset of the strings, but the \r
        <em>default</em> string file must contain them all. \r
</p>\r
\r
<h3 id="creating-alternatives">How to Create Alternative Resources</h3>\r
\r
<p>A large part of localizing an application is providing alternative text for\r
different languages. In some cases you will also provide alternative graphics,\r
sounds, layouts, and other locale-specific resources. </p>\r
\r
<p>An application can specify many <code>res/<em>&lt;qualifiers&gt;</em>/</code>\r
directories, each with different qualifiers. To create an alternative resource for\r
a different locale, you use a qualifier that specifies a language or a \r
language-region combination. (The name of a resource directory must conform \r
to the naming scheme described in \r
<a href="{@docRoot}guide/topics/resources/providing-resources.html#AlternativeResources">Providing\r
Alternative Resources</a>,\r
or else it will not compile.)</p>\r
\r
<p><em>Example:</em></p>\r
\r
<p>Suppose that your application's default language is English. Suppose also\r
that you want to localize all the text in your application to French, and most\r
of the text in your application (everything except the application's title) to\r
Japanese. In this case, you could create three alternative <code>strings.xml</code>\r
files, each stored in a locale-specific resource directory:</p>\r
\r
<ol>\r
  <li><code>res/values/strings.xml</code><br>\r
    Contains  English text for all  the strings that the application uses,\r
including text for a string named <code>title</code>.</li>\r
  <li><code>res/values-fr/strings.xml</code><br>\r
    Contain French text for all  the strings, including <code>title</code>.</li>\r
  <li><code>res/values-ja/strings.xml</code><br>\r
    Contain Japanese text for all  the strings <em>except</em>\r
<code>title</code>.<br>\r
  <code></code></li>\r
</ol>\r
\r
<p>If your Java code refers to <code>R.string.title</code>,  here is what will\r
happen at runtime:</p>\r
\r
<ul>\r
  <li>If the device is set to any language other than French, Android will load\r
<code>title</code> from the <code>res/values/strings.xml</code> file.</li>\r
  <li>If the device is set to French, Android will load <code>title</code> from\r
the <code>res/values-fr/strings.xml</code> file.</li>\r
</ul>\r
\r
<p>Notice that if the device is set to Japanese, Android will look for\r
<code>title</code> in the <code>res/values-ja/strings.xml</code> file. But\r
because no such string is included in that file, Android will fall back to the\r
default, and will load  <code>title</code> in English from the\r
<code>res/values/strings.xml</code> file.  </p>\r
\r
<h3 id="resource-precedence">Which Resources Take Precedence?</h3>\r
\r
<p> If multiple resource files match a device's configuration, Android follows a\r
set of rules in deciding which file to use. Among the qualifiers that can be\r
specified in a resource directory name, <strong>locale almost always takes\r
precedence</strong>. </p>\r
<p><em>Example:</em></p>\r
\r
<p>Assume that an application  includes a default set of graphics and two other\r
sets of graphics, each optimized for a different device setup:</p>\r
\r
<ul>\r
  <li><code>res/drawable/</code><br>\r
    Contains\r
  default graphics.</li>\r
  <li><code>res/drawable-small-land-stylus/</code><br>\r
  Contains  graphics optimized for use with a device that expects input from a \r
  stylus and has a QVGA low-density screen in landscape orientation.</li>\r
  <li><code>res/drawable-ja/</code> <br>\r
  Contains  graphics optimized for use with Japanese.</li>\r
</ul>\r
\r
<p>If the application runs on a device that is configured to use Japanese,\r
Android will load graphics from  <code>res/drawable-ja/</code>, even if the\r
device happens to be one that expects input from a stylus and has a QVGA \r
low-density screen in landscape orientation.</p>\r
\r
<p class="note"><strong>Exception:</strong> The only qualifiers that take\r
precedence over locale in the selection process are MCC and MNC (mobile country\r
code and mobile network code). </p>\r
\r
<p><em>Example:</em></p>\r
\r
<p>Assume that you have the following situation:</p>\r
\r
<ul>\r
  <li>The application code calls for <code>R.string.text_a</code></li>\r
  <li>Two relevant resource files are available:\r
    <ul>\r
      <li><code>res/values-mcc404/strings.xml</code>, which includes\r
<code>text_a</code> in the application's default language, in this case\r
English.</li>\r
      <li><code>res/values-hi/strings.xml</code>, which includes\r
<code>text_a</code> in Hindi.</li>\r
    </ul>\r
  </li>\r
  <li>The application is running on a device that has the following\r
configuration:\r
    <ul>\r
      <li>The SIM card is connected to a mobile network in India (MCC 404).</li>\r
      <li>The language is set to Hindi (<code>hi</code>).</li>\r
    </ul>\r
  </li>\r
</ul>\r
\r
<p>Android will load <code>text_a</code> from\r
<code>res/values-mcc404/strings.xml</code> (in English), even if the device is\r
configured for Hindi. That is because in the resource-selection process, Android\r
will prefer an MCC match over a language match. </p>\r
\r
<p>The selection process is not always as straightforward as these examples\r
suggest. Please read  <a\r
href="{@docRoot}guide/topics/resources/providing-resources.html#BestMatch">How Android Finds\r
the Best-matching Resource</a> for a more nuanced description of the\r
process. All the qualifiers are described and listed in order of\r
precedence in <a\r
href="{@docRoot}guide/topics/resources/providing-resources.html#table2">Table 2 of Providing\r
Alternative Resources</a>.</p>\r
\r
<h3 id="referring-to-resources">Referring to Resources in Java</h3>\r
\r
<p>In your application's Java code, you refer to  resources using the syntax\r
<code>R.<em>resource_type</em>.<em>resource_name</em></code> or\r
<code>android.R.<em>resource_type</em>.<em>resource_name</em></code><em>.</em>\r
For more about this, see <a\r
href="{@docRoot}guide/topics/resources/accessing-resources.html">Accessing Resources</a>.</p>\r
\r
<h2 id="checklist">Localization Checklist</h2>\r
\r
<p>For a complete overview of the process of localizing and distributing an Android application,\r
see the <a href="{@docRoot}distribute/googleplay/publish/localizing.html">Localization\r
Checklist</a> document.</p>\r
\r
<h2 id="strategies">Localization Tips</h2>\r
\r
<h4 id="failing2">Design your application  to work in any locale</h4>\r
\r
<p>You cannot assume anything about the device on which a user will\r
run your application. The device might have hardware that you were not\r
anticipating, or it might be set to a locale that you did not plan for or that \r
you cannot test. Design your application so that it will function normally or fail gracefully no \r
matter what device it runs on.</p>\r
\r
<p class="note"><strong>Important:</strong> Make sure that your application\r
includes a full set of default resources.</p> <p>Make sure to include\r
<code>res/drawable/</code> and a <code>res/values/</code> folders (without any\r
additional modifiers in the folder names) that contain all the images and text\r
that your application will need. </p>\r
\r
<p>If an application is missing even one default resource, it will not run on a \r
        device that is set to an unsupported locale. For example, the \r
        <code>res/values/strings.xml</code> default file might lack one string that \r
        the application needs: When the application runs in an unsupported locale and \r
        attempts to load <code>res/values/strings.xml</code>, the user will see an \r
        error message and a Force Close button. An IDE such as Eclipse will not \r
        highlight this kind of error, and you will not see the problem when you \r
        test the application on a device or emulator that is set to a supported locale.</p>\r
\r
<p>For more information, see <a href="#test-for-default">Testing for Default Resources</a>.</p>\r
\r
<h4>Design a flexible layout</h4>\r
\r
<p> If you need to rearrange your layout to fit a certain language (for example\r
German with its long words), you can create an alternative layout for that\r
language (for example <code>res/layout-de/main.xml</code>). However, doing this\r
can make your application harder to maintain.  It is better to create a single\r
layout that is more flexible.</p>\r
\r
<p>Another typical situation is a language that requires something different in\r
its layout. For example, you might have a contact form that should include  two\r
name fields when the application runs in Japanese, but three name fields when\r
the application  runs in some other language. You could handle this in either of\r
two ways:</p>\r
\r
<ul>\r
  <li>Create  one  layout with a field that you can programmatically enable or\r
disable, based on the language, or</li>\r
  <li>Have the main layout include another layout that  includes the changeable\r
field. The second layout can have different configurations for different\r
languages.</li>\r
</ul>\r
\r
<h4>Avoid creating more resource files and text strings than you need</h4>\r
\r
<p>You probably do not need to create a locale-specific\r
alternative for every resource in your application. For example, the layout\r
defined in the <code>res/layout/main.xml</code> file might work in any locale,\r
in which case there would be no need to create any alternative layout files.\r
</p>\r
\r
<p>Also, you might not need to create alternative text for every\r
string. For example, assume the following:</p>\r
\r
<ul>\r
  <li>Your application's default language is American\r
English. Every string that the application uses is defined, using American\r
English spellings, in <code>res/values/strings.xml</code>. </li>\r
\r
  <li>For  a few important phrases, you want to provide\r
British English spelling. You want these alternative strings to be used when your\r
application runs on a device in the United Kingdom. </li>\r
</ul>\r
\r
<p>To do this, you could create a small file called\r
<code>res/values-en-rGB/strings.xml</code> that includes only the strings that\r
should be different when the application  runs in the U.K. For all the rest of\r
the strings, the application will fall back to the defaults and use what is\r
defined in <code>res/values/strings.xml</code>.</p>\r
\r
<h4>Use the Android Context object for manual locale lookup</h4>\r
\r
<p>You can look up the locale using the {@link android.content.Context} object\r
that Android makes available:</p>\r
\r
<pre>String locale = context.getResources().getConfiguration().locale.getDisplayName();</pre>\r
\r
<h2 id="testing">Testing Localized Applications</h2>\r
\r
<h3 id="device">Testing on a Device</h3>\r
<p>Keep in mind that the device you are testing may be significantly different from \r
        the devices available to consumers in other geographies. The locales available \r
        on your device may differ from those available on other devices. Also, the \r
        resolution and density of the device screen may differ, which could affect \r
        the display of strings and drawables in your UI.</p>\r
\r
<p>To change the locale on a device, use  the Settings application  (Home &gt;\r
Menu &gt; Settings &gt; Locale &amp; text &gt; Select locale). </p>\r
\r
<h3 id="emulator">Testing on an Emulator</h3>\r
\r
<p>For details about using the emulator, see See <a\r
href="{@docRoot}tools/help/emulator.html">Android Emulator</a>.</p>\r
<h4>Creating and using a custom locale</h4>\r
\r
<p>A &quot;custom&quot; locale is a language/region combination that the Android\r
system image does not explicitly support. (For a list of supported locales in\r
Android platforms see the Version Notes in the <a\r
href="{@docRoot}sdk/index.html">SDK</a> tab). You can test\r
how your application will run in a custom locale by creating a custom locale in\r
the emulator. There are two ways to do this:</p>\r
\r
<ul>\r
  <li>Use the Custom Locale application, which is accessible from the\r
Application tab. (After you create a custom locale, switch to it by \r
pressing and holding the locale name.)</li>\r
  <li>Change to a custom locale from the adb shell, as described below.</li>\r
</ul>\r
\r
<p>When you set the emulator to a locale that is not available in the Android\r
system image, the system itself will display in its default language. Your\r
application, however, should localize properly.</p>\r
\r
<h4>Changing the emulator locale from the adb shell</h4>\r
\r
<p>To change the locale in the emulator by using the adb shell. </p>\r
\r
<ol>\r
  <li>Pick the locale you want to test and determine its language and region codes, for\r
example <code>fr</code> for French and <code>CA</code> for Canada.<br>\r
  </li>\r
  <li>Launch an emulator.</li>\r
  <li>From a command-line shell on the host computer, run the following\r
command:<br>\r
    <code>adb shell</code><br>\r
  or if you have a device attached, specify that you want the emulator by adding\r
the <code>-e</code> option:<br>\r
  <code>adb -e shell</code></li>\r
  <li>At  the  adb shell prompt (<code>#</code>), run this command: <br>\r
    <code>setprop persist.sys.language  [<em>language code</em>];setprop\r
persist.sys.country [<em>country  code</em>];stop;sleep 5;start <br>\r
    </code>Replace bracketed sections with the  appropriate codes from Step\r
1.</li>\r
</ol>\r
\r
<p>For instance, to test in Canadian French:</p>\r
\r
<p><code>setprop persist.sys.language  fr;setprop persist.sys.country\r
CA;stop;sleep 5;start </code></p>\r
\r
<p>This will cause the emulator  to restart. (It will look like a full reboot,\r
but it is not.) Once the Home screen appears again, re-launch your application (for\r
example, click the Run icon in Eclipse), and the application will launch with\r
the new locale. </p>\r
\r
<h3 id="test-for-default">Testing for Default Resources</h3>\r
<p>Here's how to test whether an application includes every string resource that it needs:  </p>\r
<ol><li>Set the emulator or device to a language that your application does not \r
        support. For example, if the application has French strings in \r
        <code>res/values-fr/</code> but does not have any Spanish strings in \r
        <code>res/values-es/</code>, then set the emulator's locale to Spanish. \r
        (You can use the Custom Locale application to set the emulator to an \r
        unsupported locale.)</li>\r
        <li>Run the application.</li>  \r
<li>If the application shows an error message and a Force Close button, it might \r
        be looking for a string that is not available. Make sure that your \r
        <code>res/values/strings.xml</code> file includes a definition for \r
        every string that the application uses.</li>\r
</ol> \r
</p> \r
\r
<p>If the test is successful, repeat it for other types of \r
        configurations. For example, if the application has a layout file called \r
        <code>res/layout-land/main.xml</code> but does not contain a file called \r
        <code>res/layout-port/main.xml</code>, then set the emulator or device to \r
        portrait orientation and see if the application will run. \r
\r
\r
\r