README.txt 6.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147
  1. Localization Update
  2. -------------------
  3. Automatically download and update your translations by fetching them from
  4. http://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 http://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 revision.
  14. * Site builders who want an easy tool to download translations for a site.
  15. * Multi-sites that share one translation source.
  16. Project page: http://drupal.org/project/l10n_update
  17. Support queue: http://drupal.org/project/issues/l10n_update
  18. Installation
  19. ------------
  20. Download, unpack the module the usual way.
  21. Enable this module and the Locale module (core).
  22. You need at least one language other than English.
  23. On Administration > Configuration > Regional and language:
  24. Click "Add language"
  25. Pull-down menu: Choose your new language
  26. Then click "Add language"
  27. Drupal is now importing interface translations. This can take a few minutes.
  28. When it's finished, you'll get a confirmation with a summary of all
  29. translation files that have been pulled in.
  30. If required, enable the new language as default language.
  31. Home > Administration > Configuration > Regional and language:
  32. Select your new language as default
  33. Update interface translations
  34. -----------------------------
  35. On Home > Administration > Configuration > Regional and language:
  36. Choose the "Translation updates" tab
  37. Change "Check for updates" to Daily or Weekly instead of the default "Never".
  38. Cron will from now on check for updated translations, and will report the
  39. update status on the status page (Home > Administration > Reports).
  40. To check the translation status and execute updates manually, go to
  41. Administration > Configuration > Regional and language > Translate inteface
  42. Here you see English and your new language.
  43. Choose the "Update" tab
  44. You see a list of all modules and their translation status.
  45. On the bottom of the page, you can manually update using "Update translations".
  46. Use Drush
  47. ---------
  48. You can also use drush to update your translations:
  49. drush l10n-update # Update translations.
  50. drush l10n-update-refresh # Refresh available information.
  51. drush l10n-update-status # Show translation status of available project
  52. Summary of administrative pages
  53. -------------------------------
  54. Translations status overview can be found at
  55. Administration > Configuration > Regional and language > Languages > Translation updates
  56. Update configuration settings can be found at
  57. Administration > Configuration > Regional and language > Translate interface > Update
  58. Translating Drupal core, modules and themes
  59. -------------------------------------------
  60. When Drupal core or contributed modules or themes get installed, Drupal core
  61. checks if .po translation files are present and updates the translations with
  62. the strings found in these files. After this, the localization update module
  63. checks the localization server for more recent translations, and updates
  64. the site translations if a more recent version was found.
  65. Note that the translations contained in the project packages may become
  66. obsolete in future releases.
  67. Changes to translations made locally using the site's build in translation
  68. interface (Administer > Site building > Translate interface > Search) and
  69. changes made using the localization client module are marked. Using the
  70. 'Update mode' setting 'Edited translations are kept...', locally edited
  71. strings will not be overwritten by translation updates.
  72. NOTE: Only manual changes made AFTER installing Localization Update module
  73. are preserved. To preserve manual changes made prior to installation of
  74. Localization Update module, use the option 'All existing translations are kept...'.
  75. po files, multi site and distributions
  76. --------------------------------------
  77. Multi sites and other installations that share the file system can share
  78. downloaded translation files. The Localization Update module can save these
  79. translations to disk. Other installations can use these saved translations
  80. as their translation source.
  81. All installations that share the same translation files must be configured
  82. with the same 'Store downloaded files' file path e.g. 'sites/all/translations'.
  83. Set the 'Update source' of one installation to 'Local files and remote server'
  84. or 'Remote server only', all other installations are set to
  85. 'Local files only' or 'Local files and remote server'.
  86. Translation files are saved with the following file name syntax:
  87. <module name>-<release>.<language code>.po
  88. For example:
  89. masquerade-6.x-1.5.de.po
  90. tac_lite-7.x-1.0-beta1.nl.po
  91. Po files included in distributions should match this syntax too.
  92. Alternative sources of translation
  93. ----------------------------------
  94. Each project i.e. modules, themes, etc. can define alternative translation
  95. servers to retrieve the translation updates from.
  96. Include the following definition in the projects .info file:
  97. l10n server = example.com
  98. l10n url = http://example.com/files/translations/l10n_server.xml
  99. The download path pattern is normally defined in the above defined xml file.
  100. You may override this path by adding a third definition in the .info file:
  101. l10n path = http://example.com/files/translations/%core/%project/%project-%release.%language.po
  102. API
  103. ---
  104. Using hook_l10n_servers the l10n update module can be extended to use other
  105. translation repositories. Which is usefull for organisations who maintain
  106. their own translation.
  107. Using hook_l10n_update_projects_alter modules can alter or specify the
  108. translation repositories on a per module basis.
  109. See l10n_update.api.php for more information.
  110. Maintainers
  111. -----------
  112. Jose Reyero
  113. Gábor Hojtsy
  114. Erik Stielstra