Civicrm Localization
Total Page:16
File Type:pdf, Size:1020Kb
Blog FAQ Documentation Forums Issue Tracker IRC CiviCRM Localisation Added by Piotr Szotkowski , last edited by Piotr Szotkowski on Jun 04, 2009 Introduction User Language (Translations) Other Localisation Settings Date Formats Date Format Examples Countries and Provinces Postal Address Formatting Currency and Monetary Display Formats Helping with CiviCRM Localisations How it Works Translating CiviCRM's Drupal Menu Items Web -based Localisation Offline Translation Localisation forums and "crm -translators" Mailing List (see also http://wiki.civicrm.org/confluence/display/CRMDOC/Localization ) Introduction One of our goals is to make CiviCRM as usable as possible - which means get it fully localised into any languages that our users find useful and make CiviCRM configurable in all the places that are locale-dependent. To achieve this, CiviCRM uses gettext for text localisation and configuration options for date/money/address formats and the like. This approach assures that CiviCRM should be easily localisable into wide variety of languages (also the ones using non-Latin scripts/alphabets). This page explains how to set up CiviCRM to run in one of the other supported languages and how to contribute new and/or updated translations into new languages back to CiviCRM. Applies to Version 1.6 or Later This documentation is applicable to CiviCRM v1.6 or later. For prior versions, check this page . User Language (Translations) CiviCRM has been translated into a number of different languages. These translations are contributed by community members - so your first step is to determine if a complete translation exists for the current version by visiting the Translation Server home page . If you find a completed translation, note the locale code of the translation, and continue with the steps below to configure your installation. Otherwise, check the section on Helping with CiviCRM Localisations below. Locale Codes Locale codes consist of the language abbreviation followed by the country abbreviation. For example, en_US is the code for the United States English locale, while fr_CA is the Canadian French locale. To configure CiviCRM to use an existing translation: 1. Download the translations distribution - civicrm-<version>-l10n.tar.gz - from the CiviCRM Sourceforge downloads site . This tarball contains all files for the latest available translations. 2. Uncompress the tarball and you will see a directory called civicrm, containing two subdirectories called l10n and sql. The l10n directory containsa set of sub-directories named using their locale codes. (Example: the Canadian French translation files will located in /civicrm/l10n/fr_CA) 3. Copy this l10n directory, together with all its subdirectories into your civiCRM codebase root directory. (note if creating the l10n folder manually it should be ell-ten-n, not capital-I-ten-n) - For Joomla this would be site_root/administrator/components/com_civicrm/civicrm . So if you wanted the en_GB language it would look like this site_root/administrator/components/com_civicrm/civicrm/l10n/en_GB/ - For Drupal this would be site_root/modules/civicrm . So if you wanted the en_GB language it would look like this site_root/modules/civicrm/l10n/en_GB/ 4. Login to CiviCRM (as a user with "administer CiviCRM permissions"). 5. Go to Administer CiviCRM » Global Settings » Localisation 6. You should now be able to see and select all the localization options in the Default Language and Monetary Locale drop-down menus. If you don't, and instead can just see the default 'English (USA)' option, check the preceding steps as the drop-down options are set by the directories under your l10n directory. Also be sure to confirm that the l10n directory is correctly named as l10n (that is: el-ten-en and not eye-ten-en). 7. The other settings on this page are described below. You can review them and adjust as needed. Be sure to save your changes when you're done. Your CiviCRM screens should now appear in the selected language. If the underlying server has the proper locale generated, the full and abbreviated month and day names will also be localised properly. Any text that has NOT been translated in the translation files will appear in the default English language. If you see English text after setting a different language, you may need to add to the translation. Refer to the section on Helping with CiviCRM Localisations below. Other Localisation Settings Date Formats One of the aspects of localisation is the display and input format for dates. By default, CiviCRM displays the dates using the American formats, but this can be modified to match your preferred formats. You can define the formats for the following types of date display: Complete Date and Time (dates that contain year, month, day and time) Complete Date (dates that contain year, month and day) Month and Year Year Only Date Formats Use POSIX Sequence Codes Date formats are specified using the standard POSIX % -prepended sequences . You should review these formatting codes and the Date Formatting Examples below before attempting to modify the date formats. 1. Login to CiviCRM (as a user with "administer CiviCRM permissions"). 2. Go to Administer CiviCRM » Global Settings » Date Formatting 3. Update formatting patterns as needed and Save your changes. Date Format Examples The default American format for Complete Date and Time is: %B %E%f, %Y %l:%M %P ...which, for the date of 2005-07-13, gets expanded to 'July 13th, 2005 2:26 PM'. European users might want to redefine this to: %E %B %Y, %k:%M ...which would display '13 July 2005, 14:26' instead (note the switch from 12-hour to 24-hour clock and dropping of the AM/PM display). The default American format for Complete Date is %B %E%f, %Y ...which, for the date of 2005-07-13, gets expanded to 'July 13th, 2005'. Typical European settings would have this format changed; it could look like this: %E %B %Y ...which would get expanded to '13 July 2005' (or '13 lipiec 2005' if user language is set to Polish - pl_PL). The Date Input Field formatting options define the order of the date and date-time drop-downs in various CiviCRM forms (for example, contact's birth date or scheduled meetings' date-times): The default layouts are: Complete Date and Time: %b %d %Y, %I : %M %P Complete Date: %b %d %Y These defaults provide the user with six drop-downs: abbreviated month name (%b), day (%d), year (%Y), 12-hour-clock hour (%I), minute (%M) and an AM/PM selector (%P). European users might want to redefine these to: Complete Date and Time: %d %b %Y, %H : %M Complete Date: %d %b %Y Which would display the day before the abbreviated month, switch to 24-hour-based hour drop-down (%H) and drop the AM/PM selector. Countries and Provinces The installed CiviCRM database contains both an ISO 3166 -1-compliant list of countries, and a ful, ISO 3166 -2-compliant list of provinces (states, departments, voivodships, etc.). You can configure the selections provided in address input fields for your installation (based on the geographic distribution of the address records you plan on storing). You can: Set a Default Country . This country will be selected by default when entering new addresses. Limit the list of Available Countries offered in Country drop-down lists on address input forms. Limit the Countries whose States and Provinces are offered on address input forms. 1. Login to CiviCRM (as a user with "administer CiviCRM permissions"). 2. Go to Administer CiviCRM » Global Settings » Localisation 3. Update the fields in the Contact Address Fields - Selection Values section as needed and Save your changes. Postal Address Formatting In various countries, postal addresses are written differently. CiviCRM allows you to modify the default United States format to meet the requirements of your installation. This option is best explained by example. The American default looks like this: Default Address Format {street_address} {supplemental_address_1} {supplemental_address_2} {city}{, }{state_province}{ }{postal_code} {country} The general rules are as follows: Every { ...token... } will be replaced with the token 's value (keeping anything else inside the curly braces intact). If the value of a given token is missing, the whole { ... } construct will be dropped. Any { non-token } construct will be turned into non-token if, after tokens are replaced, it has content on both sides (i.e., it will be dropped if on the beginning or end of any line). If there's no city , { city}{, }{state_province}{ } {postal_code } will turn first into { , }California{ }12345 and then into California 12345 . If, after token replacements, there are any consecutive { non-token } constructs, the first one's contents will replace the whole series. For example, if there's no state_province , { city}{, }{state_province}{ }{postal_code } will first turn into San Francisco{, }{ }12345 and then into San Francisco, 12345 . For example, Polish users, who usually don't write the vovidoship names in the address, might want to change the Address Formatting to: Address Format without Province {street_address} {supplemental_address_1} {supplemental_address_2} {postal_code}{ }{city} {country} # Login to CiviCRM (as a user with "administer CiviCRM permissions"). 1. Go to Administer CiviCRM » Global Settings » Address Settings 2. Update formatting patterns as needed and Save your changes. Currency and Monetary Display Formats CiviCRM currently supports a single currency per site. The default currency is USD, but you can select the appropriate currency for your site under Global Settings. You can also control the way that monetary values are displayed - both the number format and the arrangement of currency symbols relative to the amount. The 'look' of the numeric value (amount) depends on the selected Monetary Locale setting. As with User Language, thiis setting takes a locale (like 'en_US', 'de_DE' or 'pl_PL') and asks the underlying operating system to format the amount accordingly: Monetary Locale Examples The amount of 1234567 dollars and 89 cents will be displayed as '1,234,567.89' with an 'en_US' locale, as '1.234.567,89' with a 'pl_PL' one and as '12,34,567.89' with an 'en_IN' one.