You are here

Home » API reference » Localization client 6

README.txt in Localization client 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6.2 README.txt
  4. 7 README.txt
Non-displayable characters.

File

README.txt
View source 
  1. 

  2. CONTENTS

  3. --------

  4. 

  5.  * About

  6.  * Installation

  7.  * On-page translation

  8.  * Sharing translations

  9.  * Re-importing translation packages

  10.  * Contributors & sponsors

  11. 

  12. ABOUT

  13. -----

  14. 

  15. The main goal of the Localization client module (l10n_client) is to provide you

  16. with an easy way to translate your website's interface. The module includes an

  17. AJAX on-page editor that allows you to translate right on the actual web page

  18. that you are viewing. The Localization client module also offers an overview

  19. of all interface strings of your website. This module only lets you translate

  20. the website's interface, for information on translating your site's content

  21. please check the Drupal handbook page about the Translation module

  22. (http://drupal.org/handbook/modules/translation).

  23. 

  24. The module can instantly share your translations by sending them to

  25. localization servers such as localize.drupal.org. See also the Localization

  26. server project  (http://drupal.org/project/l10n_server).

  27. 

  28. Finally the module includes a translation package re-import tool, which

  29. simplifies importing new and changed translations, especially when upgrading

  30. or developing modules. This functionality is similar to the Drupal 5.x

  31. Autolocale module (http://drupal.org/project/autolocale).

  32. 

  33. The translation sharing and re-import tools are only available in the 6.x

  34. version of the module because these functionalities are based on features only

  35. available in Drupal 6.x. Therefore it is impossible to backport these

  36. functionalities to the 5.x version without modifying Drupal itself.

  37. 

  38.  * Project page: http://drupal.org/project/l10n_client

  39.  * Support queue: http://drupal.org/project/issues/l10n_client

  40. 

  41. INSTALLATION

  42. ------------

  43. 

  44.  1. Enable the Localization client module at Administer > Site configuration >

  45.     Modules

  46.  2. Enable two or more languages at Administer > Site configuration > Languages

  47.     For help with building a multilingual website please check the Drupal

  48.     handbook page about the Locale module at

  49.     http://drupal.org/handbook/modules/locale

  50.  3. Assign the appropriate permissions to the user roles under the section

  51.     "l10n_client module" at Administer > User management > Permissions

  52. 

  53. ON-PAGE TRANSLATION

  54. -------------------

  55. 

  56. Users with the permission "use on-page translation" can translate interface

  57. strings right on the page that they are viewing.

  58. 

  59.  1. Switch the website's language to one that is not English.

  60.  2. Browse to the webpage that contains the interface string you want to translate

  61.  3. Click the  "TRANSLATE TEXT" button in the right bottom corner of the webpage

  62.     The on-page translation pane appears, showing all strings available on the

  63.     current webpage in the left column. Already translated strings are marked

  64.     green, yet untranslated strings are shown in white. You can filter the list

  65.     using the input field in the left bottom corner of the page.

  66.  4. Select a string in the left column to see the source text and the

  67.     translation (if available). You can add your own translation or edit the

  68.     existing translation in the column at the right. Your changes will be saved

  69.     to your local database. The translations can be shared (see below).

  70. 

  71. Open the list of all the website's interface strings by selecting Translate

  72. Strings from the menu (http://www.example.com/locale). Click "TRANSLATE TEXT"

  73. to start translating.

  74. 

  75. SHARING TRANSLATIONS

  76. --------------------

  77. 

  78. Localization client can instantly share your translations by sending them to a

  79. localization server. For this a user needs the "submit translations to

  80. localization server" permission. To be able to share translations a user needs

  81. an API key from the localization server.

  82. 

  83.  1. Enable translation sharing at Administer > Site configuration > Languages >

  84.     Configure > Localization sharing

  85.  2. Enter a localization server, e.g. "http://localize.drupal.org"

  86.  3. Enter your localization server API key at My account > Edit

  87.     (The form field has a link to obtain the key from the set localization server)

  88.  4. Start translating interface strings.

  89. 

  90. RE-IMPORTING TRANSLATION PACKAGES

  91. -----------------------------------------------------------------

  92. 

  93. To re-import translation all files should be already uncompressed to the

  94. Drupal directories.

  95. 

  96. Choose the languages for which you want to re-import translations at

  97. Administer > Site building > Translate interface > Import > Reimport packages.

  98. 

  99. See also http://drupal.org/project/l10n_update.

  100. 

  101. CONTRIBUTORS & SPONSORS

  102. --------------------------------------------------------------------------------

  103. 

  104.  * G‡bor Hojtsy http://drupal.org/user/4166 (original author)

  105.  * Young Hahn / Development Seed - http://developmentseed.org/ (friendly user interface)

  106. 

  107. Initial development was sponsored by Google Summer of Code 2007,

  108. user interface sponsored by Development Seed / Young Hahn.