--- README.txt.orig 2007-03-05 18:43:40.000000000 +0100 +++ README.txt 2007-03-28 05:04:45.929652200 +0200 @@ -1,79 +1,58 @@ -INTRODUCTION -============ -Drupal module : localizer -Drupal version : 4.7.x -Current version : 2.0 -Date of release : 2006-12-13 -Author : Roberto Gerola, roberto.gerola@speedtech.it , http://www.speedtech.it -This module depends on Drupal locale module. - -This module offers the following features : -- supports 3 different types of url for language switching : --- through hostname : it.example.com, en.example.com --- appending the locale parameter followed by the language : ?locale=en, ?locale=it, ?locale=fr ... --- creating url alias with the prefix of the country code : it/home, en/ home, fr/home -- provides a language switch block - You can put everywhere the language switching block calling the PHP function : localizer_changelanguageblock(); - In your HTML code, simply add : - -- translates the node's content -- translates the user's menus -- localized latest posts listing support -- provides a news block with a new break tag : -- taxonomy support : both for terms and dictionaries names through its localization engine -- implements its localization engine with API that can be used form other modules +# $Id$ # + +Drupal module: localizer +Author: Roberto Gerola, roberto.gerola@speedtech.it , http://www.speedtech.it + +This module offers the following features: + +* 3 different ways for language switching: + * through hostname: it.example.com, en.example.com + * appending the language: ?locale=en, ?locale=it, ?locale=fr + * creating url aliases with language prefixes: it/home, en/ home, fr/home + +* Language switching block + The language switching block can be called from everywhere by invoking: + + +* Translation of node contents +* Translation of user menus +* Translation of taxonomy terms and vocabularies +* Localization API engine that can be used from other modules This module has been inspired from internationalization module (i18n). -It uses very large portions of code from i18n module and translate module of Rob Ellis. +It uses very large portions of code from i18n.module and translate.module (by Rob Ellis). UPGRADE ======= -Upgrade from a previous version. -If you are using a previous version of localizer, you should replace -all files under localizer directory. -Rename you 'localizer' table to 'localizernode'. -To use you previous translated strings for menu and taxonomy, proper SQL -instructions should be created. -Proceed then to the INSTALL section. +Follow these steps to upgrade from a previous version: +* Replace all files under localizer directory. +* Rename the database table 'localizer' to 'localizernode'. +* To migrate previously translated strings for menu and taxonomy, you need to + create and execute proper SQL statements. +* Proceed to the INSTALL section. INSTALL ======= +* Create folder 'modules/localizer'. +* Copy all files of localizer to this folder (keeping the directory structure). +* Enable the following modules in administration > modules: + * Locale + * Localizer + * Localizer Node + * Localizer Menu + +* If you want to enable translation of taxonomy terms and vocabularies, you + need to + * enable the Localizer Taxonomy module + * apply the taxonomy.module.patch in the subfolder /patches against + taxonomy.module in core. -- Installation -Create folder 'modules/localizer', copy all the modules files to this folder (keeping the directory structure). - -localizernode and localizermenu submodules must be activated together with -the core modules node and menu. The localzier versions simply extend the core modules. -localziertaxonomy replaces taxonomy module, so you should disable taxonomy module. - - -- Configuration -1. Enable the following modules in administration > modules - locale - localizer -2. Configure the module in - administer > settings > localizer - administer > settings > localizernode - -- Technical informations -This module uses the table : localizernode, to store the informations regarding the locale of -a node and its translations, with the following fields : -nid : reference to the node id -locale : the locale of the node nid -pid : the node id of the parent node - -The nodes that represent a group of translations have the same pid. -So, to find a translation of a node you must query this table two times : -first time , given the nid, to read the associated pid and -the second time, using the locale and the pid, to read the corresponding nid. +* Configure Localizer in + * administer > settings > localizer -When you save a node for the first time, and no corresponding entry is present in the table -localizer, pid and nid have the same value. -Localizer uses also the table localizertranslation to translate user defined strings. - -USE -=== +USAGE +===== When editing a node a new field 'locale' and a new tab 'translations' appear. On the interface under 'translations' you can create translations of a node or assign existing nodes as translations to the current node. @@ -82,3 +61,22 @@ to a node as translation will be present In menu and taxonomy admin interface wou will see a fieldset of every language you have activated where you can translate your strings. + + +TECHNICAL INFORMATION +===================== +This module uses the table 'localizernode' to store the locale of a node and its +translations. The table consists of the following fields: +* nid Reference to the node id. +* locale The locale of the node nid. +* pid The node id of the parent node. + +Nodes that represent a group of translations have the same pid. +So, to find a translation of a node you must query this table two times: +1. Given a nid to read the associated pid +2. Given a locale and using the pid to read the corresponding nid. + +When a node is saved for the first time and no corresponding entry is present +in the table, pid and nid have the same values. +Localizer also uses the table 'localizertranslation' to translate user defined strings. +