You are here

INSTALL.txt in Internationalization 5

Same filename and directory in other branches
  1. 5.3 INSTALL.txt
  2. 5.2 INSTALL.txt
  3. 6 INSTALL.txt
  4. 7 INSTALL.txt
********************************************************************
                     D R U P A L    M O D U L E                         
********************************************************************
Name: i18n module and translation module
Author: Jose A. Reyero
Email: drupal at reyero dot net

********************************************************************
  This is the 5.x version of i18n module, and works with Drupal 5.x
********************************************************************

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

INSTALLATION:
============

1. Create folder 'sites/all/modules/i18n' and copy all the modules files, keeping directory structure, to this folder.
2. If updating, run the update.php script following the standard procedure for Drupal updates.

POST-INSTALLATION/CONFIGURATION:
============
- Enable the module/s in: Administer > Site building > modules
  These modules are grouped under 'Multilanguage - i18n' package
  Recommeded default is to enable: Internationalization, Translation
  * Other modules are for very specific features.
  
- Configure the modules in 
	Administer > Site Configuration > Multilingual system

  You might get an error message about languages not being enabled yet.
  Visit the suggested page (Manage Languages) and enable the languages you need.
  In case you find out they're already enabled, just press the button "save configuration".

- Enable multilingual support for each content type you want to translate
    administer > content management > content types > edit (for each type separately)

  A new field 'language' and a new tab 'translations' will be available when editing these node types

- There are now two language blocks
	- A simple language switcher provided by i18n.module
	- A translation block provided by translation.module

- Set up language for existing nodes, editing them manually.
- Set up language for existing taxonomy terms
  Only terms in the node's language or terms without language will show up when editing a node

Language Definition [NEW for Drupal 5]
===================
RECOMMENDED: You can use the languages defined -and enabled- in 'locale' module

ADVANCED, EXPERTS ONLY: 
Modify the Drupal configuration file '../settings.php' to define the languages you want to use.  
  For instance, for English, Spanish:
    
   $conf['i18n_languages'] = array(
   		'site_default' => 'en', // Default language
   		'name' => array('es' => "Spanish", 'en' => 'English'),  // English names for languages
   		'native' => array('es' => "Español", 'en' => 'English'), // Native names
   		'enabled' => array('es' => TRUE, 'en' => TRUE), // Languages enabled
   		// 'rtl' => array('es' => TRUE), // This only if Spanish were an RTL language, which is not
   );

* This will override languages defined by locale module

Language dependent variables
============================
  The list of variables to be made language dependent must be defined in the config file:

  I.e.
  
    $conf['i18n_variables'] = array(
        // Site configuration
        'site_name',
        'site_slogan',
        'site_mission',
        'site_footer',
        'anonymous',
        // Node help
        'blog_help',
        'story_help',
        // User configuration
        'user_registration_help',
        'user_mail_welcome_subject',
        'user_mail_welcome_body',
        'user_mail_approval_subject',
        'user_mail_approval_body',
        'user_mail_pass_subject',
        'user_mail_pass_body',
        // Primary and secondary links
        'menu_primary_menu',
        'menu_secondary_menu';
        // Theme settings. This is an 'all or nothing' for each theme
        // This is for 'garland' theme, for other theme it would be 'theme_[themename]_settings'
		    'theme_garland_settings',
    
    );
    
  These are only some suggested ones, but you can add as many Drupal variables as you want to the array.
    
  You need to redefine these variables for the first time for every language, as previous values are lost and they return to defaults -they will be back if you disable i18n-. 
    
Language dependent tables 
=========================
  [ADVANCED, NOT REQUIRED, HANDLE WITH CARE, MAY BREAK YOUR SITE, just for experimentation and *really advanced* use]
  This module can manage language dependent tables, which means you can have different specific tables for each language, and the one for the current language will be selected at run time. 
  
  You need to modify $db_prefix and add a new global variable $db_prefix_i18n in .conf file. This is a sample:
    
    $db_prefix=array (

        'default' => 'prefix_', // The default prefix

    );

   [IMPORTANT UPDATE: The way to add a new global variable, since Drupal 4.7 is through the $GLOBALS array]
   
    $GLOBALS['db_prefix_i18n'] = array (
        // '**' will be replaced by language code at runtime.
        'table1'    => 'prefix_**_'  
        'table2'    => 'prefix_**_',
    );
    

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, freelance at reyero dot net, http://www.reyero.net

Feedback is welcomed.

File

INSTALL.txt
View source
  1. ********************************************************************
  2. D R U P A L M O D U L E
  3. ********************************************************************
  4. Name: i18n module and translation module
  5. Author: Jose A. Reyero
  6. Email: drupal at reyero dot net
  7. ********************************************************************
  8. This is the 5.x version of i18n module, and works with Drupal 5.x
  9. ********************************************************************
  10. ********************************************************************
  11. Updated documentation will be kept on-line at http://drupal.org/node/67817
  12. ********************************************************************
  13. INSTALLATION:
  14. ============
  15. 1. Create folder 'sites/all/modules/i18n' and copy all the modules files, keeping directory structure, to this folder.
  16. 2. If updating, run the update.php script following the standard procedure for Drupal updates.
  17. POST-INSTALLATION/CONFIGURATION:
  18. ============
  19. - Enable the module/s in: Administer > Site building > modules
  20. These modules are grouped under 'Multilanguage - i18n' package
  21. Recommeded default is to enable: Internationalization, Translation
  22. * Other modules are for very specific features.
  23. - Configure the modules in
  24. Administer > Site Configuration > Multilingual system
  25. You might get an error message about languages not being enabled yet.
  26. Visit the suggested page (Manage Languages) and enable the languages you need.
  27. In case you find out they're already enabled, just press the button "save configuration".
  28. - Enable multilingual support for each content type you want to translate
  29. administer > content management > content types > edit (for each type separately)
  30. A new field 'language' and a new tab 'translations' will be available when editing these node types
  31. - There are now two language blocks
  32. - A simple language switcher provided by i18n.module
  33. - A translation block provided by translation.module
  34. - Set up language for existing nodes, editing them manually.
  35. - Set up language for existing taxonomy terms
  36. Only terms in the node's language or terms without language will show up when editing a node
  37. Language Definition [NEW for Drupal 5]
  38. ===================
  39. RECOMMENDED: You can use the languages defined -and enabled- in 'locale' module
  40. ADVANCED, EXPERTS ONLY:
  41. Modify the Drupal configuration file '../settings.php' to define the languages you want to use.
  42. For instance, for English, Spanish:
  43. $conf['i18n_languages'] = array(
  44. 'site_default' => 'en', // Default language
  45. 'name' => array('es' => "Spanish", 'en' => 'English'), // English names for languages
  46. 'native' => array('es' => "Español", 'en' => 'English'), // Native names
  47. 'enabled' => array('es' => TRUE, 'en' => TRUE), // Languages enabled
  48. // 'rtl' => array('es' => TRUE), // This only if Spanish were an RTL language, which is not
  49. );
  50. * This will override languages defined by locale module
  51. Language dependent variables
  52. ============================
  53. The list of variables to be made language dependent must be defined in the config file:
  54. I.e.
  55. $conf['i18n_variables'] = array(
  56. // Site configuration
  57. 'site_name',
  58. 'site_slogan',
  59. 'site_mission',
  60. 'site_footer',
  61. 'anonymous',
  62. // Node help
  63. 'blog_help',
  64. 'story_help',
  65. // User configuration
  66. 'user_registration_help',
  67. 'user_mail_welcome_subject',
  68. 'user_mail_welcome_body',
  69. 'user_mail_approval_subject',
  70. 'user_mail_approval_body',
  71. 'user_mail_pass_subject',
  72. 'user_mail_pass_body',
  73. // Primary and secondary links
  74. 'menu_primary_menu',
  75. 'menu_secondary_menu';
  76. // Theme settings. This is an 'all or nothing' for each theme
  77. // This is for 'garland' theme, for other theme it would be 'theme_[themename]_settings'
  78. 'theme_garland_settings',
  79. );
  80. These are only some suggested ones, but you can add as many Drupal variables as you want to the array.
  81. You need to redefine these variables for the first time for every language, as previous values are lost and they return to defaults -they will be back if you disable i18n-.
  82. Language dependent tables
  83. =========================
  84. [ADVANCED, NOT REQUIRED, HANDLE WITH CARE, MAY BREAK YOUR SITE, just for experimentation and *really advanced* use]
  85. This module can manage language dependent tables, which means you can have different specific tables for each language, and the one for the current language will be selected at run time.
  86. You need to modify $db_prefix and add a new global variable $db_prefix_i18n in .conf file. This is a sample:
  87. $db_prefix=array (
  88. 'default' => 'prefix_', // The default prefix
  89. );
  90. [IMPORTANT UPDATE: The way to add a new global variable, since Drupal 4.7 is through the $GLOBALS array]
  91. $GLOBALS['db_prefix_i18n'] = array (
  92. // '**' will be replaced by language code at runtime.
  93. 'table1' => 'prefix_**_'
  94. 'table2' => 'prefix_**_',
  95. );
  96. Additional Support
  97. ==================
  98. For support, please create a support request for this module's project: http://drupal.org/project/i18n
  99. If you need professional support, contact me by e-mail: freelance at reyero dot net
  100. ====================================================================
  101. Jose A. Reyero, freelance at reyero dot net, http://www.reyero.net
  102. Feedback is welcomed.