diff --git a/CHANGELOG.txt b/CHANGELOG.txt index 7b15b14d069feda9bd3ec590d98d24e69d105656..ad641b934cf5cc8eb2679041cb1f88e3a9765471 100644 --- a/CHANGELOG.txt +++ b/CHANGELOG.txt @@ -7,10 +7,11 @@ - Changed 'flags' to 'language icons', and the images to 16x12px png - Fixed http://drupal.org/node/13319 (some issues with cached pages) - Reworked initialization system. New patches for bootstrap.inc, module.inc +- Updated to DRUPAL-4-5-1 maintenance release 30/11/2004 -- Updated to current DRUPAL-4-5 branch, won't work with 4.5.0 anymore +- Updated to current DRUPAL-4-5 branch - Cleaned the code as suggested by Dries - Renamed some database fields: 'lang' to 'language' in 'node' and 'taxonomy_term' diff --git a/INSTALL.txt b/INSTALL.txt index 78d89920cff58075d1e8115226f5b933e30c7622..229b8cea6219218c57564bad4e6a3cc6345eb8ff 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -9,18 +9,23 @@ Email: drupal at reyero dot net Current version of this module works with Drupal 4.5.1. May work also with 4.5.0, waiting for some feedback about this. ************************************************************** +This is an 'advanced module', requires core and database patching and has some low level configuration options. +Thus, it is only intended for Drupal advanced users and administrators. +**************************************************************** INSTALLATION: ============ 1. Create folder 'modules/i18n', and copy all the modules files, keeping directory structure, to this folder. -2. Apply the patches to the Drupal core that are provided. - Required patches are for 'node.module', 'taxonomy.module', 'bootstrap.inc', and 'common.inc'. - ** Patches for other modules will be available soon but they will be required only if you want that specific module to be 'language aware' - - Also, apply the database modifications from the SQL file 'i18n.mysql.' - All of these modifications are located in the "patches" folder. +2. Apply the patches to the Drupal core that are provided. + + Required patches are for 'bootstrap.inc', 'module.inc', 'common.inc', 'node.module' and 'taxonomy.module'. + ** Patches for other modules will be available soon but they will be required only if you want that specific module to be 'language aware' + ** All patches are against Drupal 4.5.1 + + Also, apply the database modifications from the SQL file 'i18n.mysql.' + All of these modifications are located in the "patches" folder. After applying the patches, you can safely remove this folder. Language Definition =================== @@ -29,13 +34,13 @@ You can use the languages defined -and enabled- in 'locale' module or modify the $i18n_languages = array("es" => "spanish", "en" => "english"); -Add any flag icons beyond the four provided by placing them in 'modules/i18n/flags'. +Add any flag icons beyond the ones provided by placing them in 'modules/i18n/flags'. You can get more flag icons from: http://www.clickfire.com/content/graphics/favicons/flags_icons.php * Yes, I know I could add a lot more to the module's tar file, but I want to keep the download as small as possible, so the current policy is including with the module only the ones I think will be more use, and the ones asked for by other module contributors. Language dependent variables ============================ - The list of variables to be made language dependent must be defined in the config file: + The list of variables to be made language dependent must be defined in the configuration file (includes/conf.php): I.e. @@ -91,13 +96,27 @@ If you want to experiment with different tables, you may find this useful [Drupa http://lists.drupal.org/pipermail/drupal-support/attachments/20030530/7a6fd04a/cdm1-0001.png +POST-INSTALLATION/CONFIGURATION: +============ +- Enable the module in administration > modules +- Configure the module in administrations > settings > i18n +- Check the node types to be made multilingual + A new field 'language' and a new tab 'translations' will be available when editing these node types +- Enable the language selector block in administration > blocks + +- Set up language for existing nodes, editing them manually or directly updating in the database. + I.e. provided that all your existing nodes are in english: + UPDATE node SET language='en' + +- 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 + 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://freelance.reyero.net diff --git a/README.txt b/README.txt index 3fed1434cc3c7a44c449e6c42d38a0b5a2d6f208..5c7e0eb89b3e73e9989e1b526e17e57bb34ef11e 100644 --- a/README.txt +++ b/README.txt @@ -2,7 +2,10 @@ README.txt ========== ******************************************************************** - This is the new i18n module. + This is the new i18n module. Beta 1 +******************************************************************** +This is an 'advanced module', requires core and database patching and has some low level configuration options. +Thus, it is only intended for Drupal advanced users and administrators. ******************************************************************** Current version of this module works with Drupal 4.5.1. May work also with 4.5.0, waiting for some feedback about this. @@ -10,8 +13,7 @@ May work also with 4.5.0, waiting for some feedback about this. ******************************************************************** WARNING: It is not backwards compatible with the old i18n module [4.5.0] WARNING: DO READ THE INSTALL FILE -******************************************************************** -NOTE: If you have been playing with the 'preview', database fields have been renamed: from 'lang' to 'language' in 'node' and 'term_data' tables +WARNING: If updating from previous versions, see CHANGELOG.txt ******************************************************************** This module implements multilingual support as outlined in http://drupal.org/node/11051 @@ -20,10 +22,15 @@ It doesn't require anymore multiple language tables as previous versions This module provides support for internationalization of 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) + ** You can choose which node types to translate and a new 'language' field will show up when editing them + ** Language can also be set for taxonomy terms + * Translation of the user interface for registered and anonymous users (with locale module and the languages block enabled) * Detection of the brower language * Keeps the language settings accross consecutive requests using URL rewriting. * Provides a block for language selection and two theme functions: i18n_flags and i18n_links + * Independent interface and content languages. + ** This means you can have the interface -menus, etc..- in english while viewing a node in spanish + ** While some people doesn't like this, I consider it as an important feature which will be kept for future releases To have a language selector on your page, you can use the block provided or these theme functions: @@ -52,35 +59,39 @@ 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' +2. If not found, language code is removed, and a path translation is searched again: 'mypage' Thus, you can define aliases with or without language codes in them The 'Front page: Language dependent' option means that when the request is for the front page '/', a language prefix will be added before doing the path translation, and then -> step 1 above -This language code will be taken from browser if enabled 'Browser language detection, or will be the default otherwise. +This language code will be taken from browser if enabled 'Browser language detection', or will be the default otherwise. -About Synchronization [old i18n module style] : -====================== -This is not required anymore, and probably the 'basic translation interface' will be enough -However, I plan to implement some related options in the future, just to keep translations in sync +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) 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. +This part is an add-on, and you can use it or not. To setup which variables will be multilingual, see INSTALL.txt 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... +This feature 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...let me know + +About Synchronization [old i18n module style] : +====================== +This is not required anymore, and probably the 'basic translation interface' will be enough +However, I plan to implement some related options in the future, just to keep translations in sync Samples: Sites using this module - e-mail me to be listed here ========================================================== http://freelance.reyero.net, well, its mine, no merit :-) Additional Support -================= +================== For support, please create a support request for this module's project: http://drupal.org/project/i18n