You are here

README.txt in Localization client 6.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7 README.txt
CONTENTS
--------

 * About
 * Installation
 * On-page translation
 * Sharing translations
 * Re-importing translation packages
 * Contributors & sponsors

ABOUT
-----

The main goal of the Localization client module (l10n_client) is to provide you
with an easy way to translate your website's interface. The module includes an
AJAX on-page editor that allows you to translate right on the actual web page
that you are viewing. The Localization client module also offers an overview
of all interface strings of your website. This module only lets you translate
the website's interface, for information on translating your site's content
please check the Drupal handbook page about the Translation module
(http://drupal.org/handbook/modules/translation).

The module can instantly share your translations by sending them to
localization servers such as localize.drupal.org. See also the Localization
server project  (http://drupal.org/project/l10n_server).

Finally the module includes a translation package re-import tool, which
simplifies importing new and changed translations, especially when upgrading
or developing modules. This functionality is similar to the Drupal 5.x
Autolocale module (http://drupal.org/project/autolocale).

The translation sharing and re-import tools are only available in the 6.x
version of the module because these functionalities are based on features only
available in Drupal 6.x. Therefore it is impossible to backport these
functionalities to the 5.x version without modifying Drupal itself.

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

INSTALLATION
------------

 1. Enable the Localization client module at Administer > Site building >
    Modules
 2. Enable two or more languages at Administer > Site configuration > Languages
    For help with building a multilingual website please check the Drupal
    handbook page about the Locale module at
    http://drupal.org/handbook/modules/locale
 3. Assign the appropriate permissions to the user roles under the section
    "l10n_client module" at Administer > User management > Permissions

ON-PAGE TRANSLATION
-------------------

Users with the permission "use on-page translation" can translate interface
strings right on the page that they are viewing.

 1. Switch the website's language to one that is not English.
 2. Browse to the webpage that contains the interface string you want to translate
 3. Click the  "TRANSLATE TEXT" button in the right bottom corner of the webpage
    The on-page translation pane appears, showing all strings available on the
    current webpage in the left column. Already translated strings are marked
    green, yet untranslated strings are shown in white. You can filter the list
    using the input field in the left bottom corner of the page.
 4. Select a string in the left column to see the source text and the
    translation (if available). You can add your own translation or edit the
    existing translation in the column at the right. Your changes will be saved
    to your local database. The translations can be shared (see below).

Open the list of all the website's interface strings by selecting Translate
Strings from the menu (http://www.example.com/locale). Click "TRANSLATE TEXT"
to start translating.

SHARING TRANSLATIONS
--------------------

Localization client can instantly share your translations by sending them to a
localization server. For this a user needs the "submit translations to
localization server" permission. To be able to share translations a user needs
an API key from the localization server.

 1. Enable translation sharing at Administer > Site configuration > Languages >
    Configure > Localization sharing
 2. Enter a localization server, e.g. "http://localize.drupal.org"
 3. Enter your localization server API key at My account > Edit
    (The form field has a link to obtain the key from the set localization server)
 4. Start translating interface strings.

RE-IMPORTING TRANSLATION PACKAGES
-----------------------------------------------------------------

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

Choose the languages for which you want to re-import translations at
Administer > Site building > Translate interface > Import > Reimport packages.

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

CONTRIBUTORS & SPONSORS
--------------------------------------------------------------------------------

 * Gábor Hojtsy http://drupal.org/user/4166 (original author)
 * Young Hahn / Development Seed - http://developmentseed.org/ (friendly user interface)

Initial development was sponsored by Google Summer of Code 2007,
user interface sponsored by Development Seed / Young Hahn.

File

README.txt
View source
  1. CONTENTS
  2. --------
  3. * About
  4. * Installation
  5. * On-page translation
  6. * Sharing translations
  7. * Re-importing translation packages
  8. * Contributors & sponsors
  9. ABOUT
  10. -----
  11. The main goal of the Localization client module (l10n_client) is to provide you
  12. with an easy way to translate your website's interface. The module includes an
  13. AJAX on-page editor that allows you to translate right on the actual web page
  14. that you are viewing. The Localization client module also offers an overview
  15. of all interface strings of your website. This module only lets you translate
  16. the website's interface, for information on translating your site's content
  17. please check the Drupal handbook page about the Translation module
  18. (http://drupal.org/handbook/modules/translation).
  19. The module can instantly share your translations by sending them to
  20. localization servers such as localize.drupal.org. See also the Localization
  21. server project (http://drupal.org/project/l10n_server).
  22. Finally the module includes a translation package re-import tool, which
  23. simplifies importing new and changed translations, especially when upgrading
  24. or developing modules. This functionality is similar to the Drupal 5.x
  25. Autolocale module (http://drupal.org/project/autolocale).
  26. The translation sharing and re-import tools are only available in the 6.x
  27. version of the module because these functionalities are based on features only
  28. available in Drupal 6.x. Therefore it is impossible to backport these
  29. functionalities to the 5.x version without modifying Drupal itself.
  30. * Project page: http://drupal.org/project/l10n_client
  31. * Support queue: http://drupal.org/project/issues/l10n_client
  32. INSTALLATION
  33. ------------
  34. 1. Enable the Localization client module at Administer > Site building >
  35. Modules
  36. 2. Enable two or more languages at Administer > Site configuration > Languages
  37. For help with building a multilingual website please check the Drupal
  38. handbook page about the Locale module at
  39. http://drupal.org/handbook/modules/locale
  40. 3. Assign the appropriate permissions to the user roles under the section
  41. "l10n_client module" at Administer > User management > Permissions
  42. ON-PAGE TRANSLATION
  43. -------------------
  44. Users with the permission "use on-page translation" can translate interface
  45. strings right on the page that they are viewing.
  46. 1. Switch the website's language to one that is not English.
  47. 2. Browse to the webpage that contains the interface string you want to translate
  48. 3. Click the "TRANSLATE TEXT" button in the right bottom corner of the webpage
  49. The on-page translation pane appears, showing all strings available on the
  50. current webpage in the left column. Already translated strings are marked
  51. green, yet untranslated strings are shown in white. You can filter the list
  52. using the input field in the left bottom corner of the page.
  53. 4. Select a string in the left column to see the source text and the
  54. translation (if available). You can add your own translation or edit the
  55. existing translation in the column at the right. Your changes will be saved
  56. to your local database. The translations can be shared (see below).
  57. Open the list of all the website's interface strings by selecting Translate
  58. Strings from the menu (http://www.example.com/locale). Click "TRANSLATE TEXT"
  59. to start translating.
  60. SHARING TRANSLATIONS
  61. --------------------
  62. Localization client can instantly share your translations by sending them to a
  63. localization server. For this a user needs the "submit translations to
  64. localization server" permission. To be able to share translations a user needs
  65. an API key from the localization server.
  66. 1. Enable translation sharing at Administer > Site configuration > Languages >
  67. Configure > Localization sharing
  68. 2. Enter a localization server, e.g. "http://localize.drupal.org"
  69. 3. Enter your localization server API key at My account > Edit
  70. (The form field has a link to obtain the key from the set localization server)
  71. 4. Start translating interface strings.
  72. RE-IMPORTING TRANSLATION PACKAGES
  73. -----------------------------------------------------------------
  74. To re-import translation all files should be already uncompressed to the
  75. Drupal directories.
  76. Choose the languages for which you want to re-import translations at
  77. Administer > Site building > Translate interface > Import > Reimport packages.
  78. See also http://drupal.org/project/l10n_update.
  79. CONTRIBUTORS & SPONSORS
  80. --------------------------------------------------------------------------------
  81. * Gábor Hojtsy http://drupal.org/user/4166 (original author)
  82. * Young Hahn / Development Seed - http://developmentseed.org/ (friendly user interface)
  83. Initial development was sponsored by Google Summer of Code 2007,
  84. user interface sponsored by Development Seed / Young Hahn.