You are here

README.txt in Localization update 7.2

Same filename and directory in other branches
  1. 6 README.txt
  2. 7 README.txt
Localization Update
-------------------
  Automatically download and update your translations by fetching them from
  https://localize.drupal.org or any other Localization server.

  The l10n update module helps to keep the translation of your drupal core and
  contributed modules up to date with the central Drupal translation repository
  at https://localize.drupal.org. Alternatively locally stored translation files
  can be used as translation source too.

  By choice updates are performed automatically or manually. Locally altered
  translations can either be respected or ignored.

  The l10n update module is developed for:
   * Distributions which include their own translations in .po files.
   * Site admins who want to update the translation with each new module
     revision.
   * Site builders who want an easy tool to download translations for a site.
   * Multi-sites that share one translation source.

  Project page:  https://www.drupal.org/project/l10n_update
  Support queue: https://www.drupal.org/project/issues/l10n_update

Installation
------------
  Download, unpack the module the usual way.
  Enable this module and the Locale module (core).

  You need at least one language (besides the default English).
  On Administration > Configuration > Regional and language > Languages:
    Click "Add language".
    Select a language from the select list "Language name".
    Then click the "Add language" button.

  Drupal is now importing interface translations. This can take a few minutes.
  When it's finished, you'll get a confirmation with a summary of the
  translations that have been imported.

  If required, enable the new language as default language.
  Administration > Configuration > Regional and language > Languages:
    Select your new default language.

Update interface translations
-----------------------------
  You want to import translations regularly using cron. You can enable this
  on Administration > Configuration > Regional and language > Languages:
   * Choose the "Translation updates" tab.
   * Change "Check for updates" to "Daily" or "Weekly" instead of the default
     "Never".
  From now on cron will check for updated translations, and import them is
  required.

  The status of the translations is reported on the "Status report" page at
  Administration > Reports.

  To check the translation status and execute updates manually, go to
    Administration > Configuration > Regional and language > Translate inteface
    Choose the "Update" tab.
  You see a list of all modules and their translation status.
  On the bottom of the page, you can manually update using "Update
  translations".

Use Drush
---------
  You can also use drush to update your translations:
    drush l10n-update           # Update translations.
    drush l10n-update-refresh   # Refresh available information.
    drush l10n-update-status    # Show translation status of available project


Summary of administrative pages
-------------------------------
  Translations status overview can be found at
    Administration > Configuration > Regional and language > Languages
    > Translation updates

  Update configuration settings can be found at
    Administration > Configuration > Regional and language > Translate interface
    > Update

Translating Drupal core, modules and themes
-------------------------------------------
  When Drupal core or contributed modules or themes get installed, Drupal core
  checks if .po translation files are present and updates the translations with
  the strings found in these files. After this, the localization update module
  checks the localization server for more recent translations, and updates
  the site translations if a more recent version was found.
  Note that the translations contained in the project packages may become
  obsolete in future releases.

  Changes to translations made locally using the site's build in translation
  interface (Administer > Site building > Translate interface > Search) and
  changes made using the localization client module are marked. Using the
  'Update mode' setting 'Edited translations are kept...', locally edited
  strings will not be overwritten by translation updates.
  NOTE: Only manual changes made AFTER installing Localization Update module
  are preserved. To preserve manual changes made prior to installation of
  Localization Update module, use the option 'All existing translations are
  kept...'.

po files, multi site and distributions
--------------------------------------
  Multi sites and other installations that share the file system can share
  downloaded translation files. The Localization Update module can save these
  translations to disk. Other installations can use these saved translations
  as their translation source.

  All installations that share the same translation files must be configured
  with the same 'Store downloaded files' file path e.g.
  'sites/all/translations'.
  Set the 'Update source' of one installation to 'Local files and remote server'
  or 'Remote server only', all other installations are set to
  'Local files only' or 'Local files and remote server'.

  Translation files are saved with the following file name syntax:

    <module name>-<release>.<language code>.po

  For example:
    masquerade-6.x-1.5.de.po
    tac_lite-7.x-1.0-beta1.nl.po

  Po files included in distributions should match this syntax too.

Missing translations
--------------------

  If you see "Missing translations for ..." on the Translate interface update
  page this means that Localization Update module was not able to find a
  translation file for one or more of your modules or themes. This is usually
  the case with features, but can also occur with custom modules.

  In case of custom modules, remove the line "project = ..." from the .info
  file. Only use "project = ..." for modules that are available at drupal.org or
  custom modules for which an alternative source of translation is provided (see
  below). In case of a feature add the feature machine name to 'Project' at
  admin/config/regional/language/update > Disable update. This will prevent
  Localization Update module from checking for updates for this feature.

  If "missing translations" lists all your enabled modules the webserver has no
  access to ftp.drupal.org. Contact your hosting to allow access.

  If only a few of your contributed modules are in the list, first verify that
  the translation is actually missing by visiting the listed URL of the .po file
  (for example "https://ftp.drupal.org/files/translations/7.x/views/views.hu.po")
  When the file is not found, you either try again later or contact a
  translation administrator of your language at https://localize.drupal.org/.

Alternative source of translation
---------------------------------

  The download path pattern is normally defined in the above defined xml file.
  You may override the download path of the po file on a project by project
  basis by adding this definition in the .info file:

    l10n path = http://example.com/files/translations/%core/%project/%project-%release.%language.po

  Modules can force Locale to load the translation of an other project by
  defining 'interface translation project' in their .info file. This can be
  useful for custom modules to use for example a common translation file

    interface translation project = my_project

  This can be used in combination with an alternative path to the translation
  file. For example:

    l10n path = sites/all/modules/custom/%project/%project.%language.po

Exclude a project from translation checks and updates
-----------------------------------------------------

  Individual modules can be excluded from translation checks and updates. For
  example custom modules or features. Add the following line to the .info file
  to exclude a module from translation checks and updates:

  interface translation project = FALSE

API
---
  Using hook_l10n_update_projects_alter modules can alter or specify the
  translation repositories on a per module basis.

  See l10n_update.api.php for more information.

Using a Proxy
-------------

  Use the cURL HTTP Request module (https://www.drupal.org/project/chr) if your
  website is behind a proxy. If you want to use an alternative http request
  function, set the 'drupal_http_request_function', the same way as you would
  set it to override Drupal core's http_request function:

    $conf['drupal_http_request_function'] = 'my_custom_http_request';

Maintainers
-----------
  Erik Stielstra
  Gábor Hojtsy
  Jose Reyero

File

README.txt
View source
  1. Localization Update
  2. -------------------
  3. Automatically download and update your translations by fetching them from
  4. https://localize.drupal.org or any other Localization server.
  5. The l10n update module helps to keep the translation of your drupal core and
  6. contributed modules up to date with the central Drupal translation repository
  7. at https://localize.drupal.org. Alternatively locally stored translation files
  8. can be used as translation source too.
  9. By choice updates are performed automatically or manually. Locally altered
  10. translations can either be respected or ignored.
  11. The l10n update module is developed for:
  12. * Distributions which include their own translations in .po files.
  13. * Site admins who want to update the translation with each new module
  14. revision.
  15. * Site builders who want an easy tool to download translations for a site.
  16. * Multi-sites that share one translation source.
  17. Project page: https://www.drupal.org/project/l10n_update
  18. Support queue: https://www.drupal.org/project/issues/l10n_update
  19. Installation
  20. ------------
  21. Download, unpack the module the usual way.
  22. Enable this module and the Locale module (core).
  23. You need at least one language (besides the default English).
  24. On Administration > Configuration > Regional and language > Languages:
  25. Click "Add language".
  26. Select a language from the select list "Language name".
  27. Then click the "Add language" button.
  28. Drupal is now importing interface translations. This can take a few minutes.
  29. When it's finished, you'll get a confirmation with a summary of the
  30. translations that have been imported.
  31. If required, enable the new language as default language.
  32. Administration > Configuration > Regional and language > Languages:
  33. Select your new default language.
  34. Update interface translations
  35. -----------------------------
  36. You want to import translations regularly using cron. You can enable this
  37. on Administration > Configuration > Regional and language > Languages:
  38. * Choose the "Translation updates" tab.
  39. * Change "Check for updates" to "Daily" or "Weekly" instead of the default
  40. "Never".
  41. From now on cron will check for updated translations, and import them is
  42. required.
  43. The status of the translations is reported on the "Status report" page at
  44. Administration > Reports.
  45. To check the translation status and execute updates manually, go to
  46. Administration > Configuration > Regional and language > Translate inteface
  47. Choose the "Update" tab.
  48. You see a list of all modules and their translation status.
  49. On the bottom of the page, you can manually update using "Update
  50. translations".
  51. Use Drush
  52. ---------
  53. You can also use drush to update your translations:
  54. drush l10n-update # Update translations.
  55. drush l10n-update-refresh # Refresh available information.
  56. drush l10n-update-status # Show translation status of available project
  57. Summary of administrative pages
  58. -------------------------------
  59. Translations status overview can be found at
  60. Administration > Configuration > Regional and language > Languages
  61. > Translation updates
  62. Update configuration settings can be found at
  63. Administration > Configuration > Regional and language > Translate interface
  64. > Update
  65. Translating Drupal core, modules and themes
  66. -------------------------------------------
  67. When Drupal core or contributed modules or themes get installed, Drupal core
  68. checks if .po translation files are present and updates the translations with
  69. the strings found in these files. After this, the localization update module
  70. checks the localization server for more recent translations, and updates
  71. the site translations if a more recent version was found.
  72. Note that the translations contained in the project packages may become
  73. obsolete in future releases.
  74. Changes to translations made locally using the site's build in translation
  75. interface (Administer > Site building > Translate interface > Search) and
  76. changes made using the localization client module are marked. Using the
  77. 'Update mode' setting 'Edited translations are kept...', locally edited
  78. strings will not be overwritten by translation updates.
  79. NOTE: Only manual changes made AFTER installing Localization Update module
  80. are preserved. To preserve manual changes made prior to installation of
  81. Localization Update module, use the option 'All existing translations are
  82. kept...'.
  83. po files, multi site and distributions
  84. --------------------------------------
  85. Multi sites and other installations that share the file system can share
  86. downloaded translation files. The Localization Update module can save these
  87. translations to disk. Other installations can use these saved translations
  88. as their translation source.
  89. All installations that share the same translation files must be configured
  90. with the same 'Store downloaded files' file path e.g.
  91. 'sites/all/translations'.
  92. Set the 'Update source' of one installation to 'Local files and remote server'
  93. or 'Remote server only', all other installations are set to
  94. 'Local files only' or 'Local files and remote server'.
  95. Translation files are saved with the following file name syntax:
  96. -..po
  97. For example:
  98. masquerade-6.x-1.5.de.po
  99. tac_lite-7.x-1.0-beta1.nl.po
  100. Po files included in distributions should match this syntax too.
  101. Missing translations
  102. --------------------
  103. If you see "Missing translations for ..." on the Translate interface update
  104. page this means that Localization Update module was not able to find a
  105. translation file for one or more of your modules or themes. This is usually
  106. the case with features, but can also occur with custom modules.
  107. In case of custom modules, remove the line "project = ..." from the .info
  108. file. Only use "project = ..." for modules that are available at drupal.org or
  109. custom modules for which an alternative source of translation is provided (see
  110. below). In case of a feature add the feature machine name to 'Project' at
  111. admin/config/regional/language/update > Disable update. This will prevent
  112. Localization Update module from checking for updates for this feature.
  113. If "missing translations" lists all your enabled modules the webserver has no
  114. access to ftp.drupal.org. Contact your hosting to allow access.
  115. If only a few of your contributed modules are in the list, first verify that
  116. the translation is actually missing by visiting the listed URL of the .po file
  117. (for example "https://ftp.drupal.org/files/translations/7.x/views/views.hu.po")
  118. When the file is not found, you either try again later or contact a
  119. translation administrator of your language at https://localize.drupal.org/.
  120. Alternative source of translation
  121. ---------------------------------
  122. The download path pattern is normally defined in the above defined xml file.
  123. You may override the download path of the po file on a project by project
  124. basis by adding this definition in the .info file:
  125. l10n path = http://example.com/files/translations/%core/%project/%project-%release.%language.po
  126. Modules can force Locale to load the translation of an other project by
  127. defining 'interface translation project' in their .info file. This can be
  128. useful for custom modules to use for example a common translation file
  129. interface translation project = my_project
  130. This can be used in combination with an alternative path to the translation
  131. file. For example:
  132. l10n path = sites/all/modules/custom/%project/%project.%language.po
  133. Exclude a project from translation checks and updates
  134. -----------------------------------------------------
  135. Individual modules can be excluded from translation checks and updates. For
  136. example custom modules or features. Add the following line to the .info file
  137. to exclude a module from translation checks and updates:
  138. interface translation project = FALSE
  139. API
  140. ---
  141. Using hook_l10n_update_projects_alter modules can alter or specify the
  142. translation repositories on a per module basis.
  143. See l10n_update.api.php for more information.
  144. Using a Proxy
  145. -------------
  146. Use the cURL HTTP Request module (https://www.drupal.org/project/chr) if your
  147. website is behind a proxy. If you want to use an alternative http request
  148. function, set the 'drupal_http_request_function', the same way as you would
  149. set it to override Drupal core's http_request function:
  150. $conf['drupal_http_request_function'] = 'my_custom_http_request';
  151. Maintainers
  152. -----------
  153. Erik Stielstra
  154. Gábor Hojtsy
  155. Jose Reyero