You are here

Home » API reference » Internationalization 5

README.txt in Internationalization 5

Same filename in this branch
  1. 5 README.txt
  2. 5 contrib/README.txt
  3. 5 experimental/README.txt
Same filename and directory in other branches
  1. 5.3 README.txt
  2. 5.2 README.txt
  3. 6 README.txt
  4. 7 README.txt
README.txt
==========

********************************************************************
This is i18n package, development version , and works with Drupal 5.x
********************************************************************
WARNING: DO READ THE INSTALL FILE
********************************************************************
Updated documentation will be kept on-line at http://drupal.org/node/67817
********************************************************************

This is not a single module anymore but a collection of modules providing complementary features
  i18n --> basic module which will add language to nodes, vocabularies and terms
  translation --> module to add translation relationships
  
********************************************************************
These modules provide support for multilingual Drupal sites:
    * Multilingual content, some basic translation interface, and links between translated versions
    * Translation of the user interface for registered and anonymous users (with locale)
    * Detection of the brower language
    * Keeps the language settings accross consecutive requests using URL rewriting.
    * Provides a block for language switching -i18n.module- and one for translations -translation.module-
Multilingual content:
=====================
Multilingual content means providing content translated to different languages or language specific content, which is not the same as interface translation. Interface translation is done through Drupal's localization system. 
This module supports:
  - Multilingual nodes
  - Multilingual taxonomy vocabularies and terms
  - Translations for nodes and terms

When you navigate the site using multiple languages, the pages will just show terms and nodes for the chosen language plus the ones that haven't a definde language. 
When editing a node, you must click on 'Preview' after changing language for the right vocabularies and terms to be shown.

The multi language support is expected to work for all node types, and node listings

Taxonomy translation:
====================
You can create vocabularies and terms with or without language. 
- If you set language for a vocabulary/term, that term will just show up for pages in that language
- If you set language for a vocabulary, all the terms in that vocabulary will be assigned that language.
- When editing nodes, if you change the language for a node, you have to click on 'Preview' to have the right vocabularies/terms for that language. Otherwise, the language/taxonomy data for that node could be inconsistent.
  
About URL aliasing with language codes -requires path module
============================================================
Incoming URL's are now translated following these steps:
1. First, a translation is searched for path with language code: 'en/mypage'
2. If not found, language code is removed, and path translation is searched again: 'mypage'

Thus, you can define aliases with or without language codes in them.

This language code will be taken from browser if enabled 'Browser language detection, or will be the default otherwise.

To have aliases for a translated node/page, you have to define each of them. I.e.:
  en/mycustompath -> node/34 (which is suppossed to be the english version)
  es/mycustompath -> node/35 (which should be the spanish version)

For outgoing URL's, the language code will be added automatically.

About language dependent variables:
==================================
Some site-wide variables, like 'site_name', 'site_slogan', user e-mail contents... have language dependent content.
Since I don't like the solution of runing them through the localization system, because this means when you change the 'master' text, you have to re-translate it for every language, I've added this new feature which makes possible to have a list of variables -defined in the config file- which will be kept separated for each language.
This part is an add-on, and you can use it or not.

About language dependent tables 
===============================
Language dependent tables are not needed anymore for multilingual content.
This is kept for backwards compatibility, experimentation and may be some use in the future.
* This can be used to have per-language data for modules not language-aware, like language statistics... you can experiment...

Known problems, compatibility issues
====================================
These modules should be compatible with all Drupal core modules.

Sample sites, using this module - e-mail me to be listed here
==========================================================
  http://www.reyero.net
  http://www.para.ro
  http://www.ctac.ca
  http://grasshopperarts.com
  http://funkycode.com
  http://www.newoceans.nl

Additional Support
=================
For support, please create a support request for this module's project: 
  http://drupal.org/project/i18n

If you need professional support, contact me by e-mail: freelance at reyero dot net

====================================================================
Jose A. Reyero, drupal at reyero dot net, http://www.reyero.net

Feedback is welcomed.

File

README.txt
View source 
  1. README.txt

  2. ==========

  3. 

  4. ********************************************************************

  5. This is i18n package, development version , and works with Drupal 5.x

  6. ********************************************************************

  7. WARNING: DO READ THE INSTALL FILE

  8. ********************************************************************

  9. Updated documentation will be kept on-line at http://drupal.org/node/67817

  10. ********************************************************************

  11. 

  12. This is not a single module anymore but a collection of modules providing complementary features

  13.   i18n --> basic module which will add language to nodes, vocabularies and terms

  14.   translation --> module to add translation relationships

  15.   

  16. ********************************************************************

  17. These modules provide support for multilingual Drupal sites:

  18.     * Multilingual content, some basic translation interface, and links between translated versions

  19.     * Translation of the user interface for registered and anonymous users (with locale)

  20.     * Detection of the brower language

  21.     * Keeps the language settings accross consecutive requests using URL rewriting.

  22.     * Provides a block for language switching -i18n.module- and one for translations -translation.module-

  23. Multilingual content:

  24. =====================

  25. Multilingual content means providing content translated to different languages or language specific content, which is not the same as interface translation. Interface translation is done through Drupal's localization system. 

  26. This module supports:

  27.   - Multilingual nodes

  28.   - Multilingual taxonomy vocabularies and terms

  29.   - Translations for nodes and terms

  30. 

  31. When you navigate the site using multiple languages, the pages will just show terms and nodes for the chosen language plus the ones that haven't a definde language. 

  32. When editing a node, you must click on 'Preview' after changing language for the right vocabularies and terms to be shown.

  33. 

  34. The multi language support is expected to work for all node types, and node listings

  35. 

  36. Taxonomy translation:

  37. ====================

  38. You can create vocabularies and terms with or without language. 

  39. - If you set language for a vocabulary/term, that term will just show up for pages in that language

  40. - If you set language for a vocabulary, all the terms in that vocabulary will be assigned that language.

  41. - When editing nodes, if you change the language for a node, you have to click on 'Preview' to have the right vocabularies/terms for that language. Otherwise, the language/taxonomy data for that node could be inconsistent.

  42.   

  43. About URL aliasing with language codes -requires path module

  44. ============================================================

  45. Incoming URL's are now translated following these steps:

  46. 1. First, a translation is searched for path with language code: 'en/mypage'

  47. 2. If not found, language code is removed, and path translation is searched again: 'mypage'

  48. 

  49. Thus, you can define aliases with or without language codes in them.

  50. 

  51. This language code will be taken from browser if enabled 'Browser language detection, or will be the default otherwise.

  52. 

  53. To have aliases for a translated node/page, you have to define each of them. I.e.:

  54.   en/mycustompath -> node/34 (which is suppossed to be the english version)

  55.   es/mycustompath -> node/35 (which should be the spanish version)

  56. 

  57. For outgoing URL's, the language code will be added automatically.

  58. 

  59. About language dependent variables:

  60. ==================================

  61. Some site-wide variables, like 'site_name', 'site_slogan', user e-mail contents... have language dependent content.

  62. Since I don't like the solution of runing them through the localization system, because this means when you change the 'master' text, you have to re-translate it for every language, I've added this new feature which makes possible to have a list of variables -defined in the config file- which will be kept separated for each language.

  63. This part is an add-on, and you can use it or not.

  64. 

  65. About language dependent tables 

  66. ===============================

  67. Language dependent tables are not needed anymore for multilingual content.

  68. This is kept for backwards compatibility, experimentation and may be some use in the future.

  69. * This can be used to have per-language data for modules not language-aware, like language statistics... you can experiment...

  70. 

  71. Known problems, compatibility issues

  72. ====================================

  73. These modules should be compatible with all Drupal core modules.

  74. 

  75. Sample sites, using this module - e-mail me to be listed here

  76. ==========================================================

  77.   http://www.reyero.net

  78.   http://www.para.ro

  79.   http://www.ctac.ca

  80.   http://grasshopperarts.com

  81.   http://funkycode.com

  82.   http://www.newoceans.nl

  83. 

  84. Additional Support

  85. =================

  86. For support, please create a support request for this module's project: 

  87.   http://drupal.org/project/i18n

  88. 

  89. If you need professional support, contact me by e-mail: freelance at reyero dot net

  90. 

  91. ====================================================================

  92. Jose A. Reyero, drupal at reyero dot net, http://www.reyero.net

  93. 

  94. Feedback is welcomed.