Translation for drupall 4.7.0
[project/i18n.git] / README.txt
CommitLineData
73fa9ab3
UH
1README.txt
2==========
6681618a 3
d469e0bb 4********************************************************************
f8f9839a 5This is i18n package, development version , and works with Drupal 4.7
d469e0bb 6********************************************************************
d469e0bb 7WARNING: DO READ THE INSTALL FILE
d469e0bb 8********************************************************************
f8f9839a
JR
9Updated documentation will be kept on-line at http://drupal.org/node/31631
10********************************************************************
11
f4c7262d
JR
12This 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********************************************************************
8dcb741b 17These modules provide support for multilingual Drupal sites:
d469e0bb 18 * Multilingual content, some basic translation interface, and links between translated versions
3128d317
JR
19 * Translation of the user interface for registered and anonymous users (with locale)
20 * Detection of the brower language
d469e0bb 21 * Keeps the language settings accross consecutive requests using URL rewriting.
8dcb741b 22 * Provides a block for language switching -i18n.module- and one for translations -translation.module-
2e7ab2c3 23Multilingual content:
6681618a 24=====================
d469e0bb
JR
25Multilingual 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.
26This module supports:
27 - Multilingual nodes
28 - Multilingual taxonomy vocabularies and terms
8dcb741b 29 - Translations for nodes and terms
d469e0bb 30
975aa337
JR
31When 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.
32When editing a node, you must click on 'Preview' after changing language for the right vocabularies and terms to be shown.
d469e0bb 33
8dcb741b 34The multi language support is expected to work for all node types, and node listings
d469e0bb 35
2e7ab2c3
JR
36Taxonomy translation:
37====================
38You 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
d469e0bb 43About URL aliasing with language codes -requires path module
8dcb741b 44============================================================
d469e0bb
JR
45Incoming URL's are now translated following these steps:
461. First, a translation is searched for path with language code: 'en/mypage'
3128d317 472. If not found, language code is removed, and path translation is searched again: 'mypage'
d469e0bb 48
8dcb741b
JR
49Thus, you can define aliases with or without language codes in them.
50
3128d317 51This language code will be taken from browser if enabled 'Browser language detection, or will be the default otherwise.
d469e0bb 52
975aa337
JR
53To 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
8dcb741b 57For outgoing URL's, the language code will be added automatically.
d469e0bb
JR
58
59About language dependent variables:
f4c7262d 60==================================
6681618a
JR
61Some site-wide variables, like 'site_name', 'site_slogan', user e-mail contents... have language dependent content.
62Since 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.
3128d317 63This part is an add-on, and you can use it or not.
6681618a 64
d469e0bb
JR
65About language dependent tables
66===============================
67Language dependent tables are not needed anymore for multilingual content.
3128d317
JR
68This 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...
d469e0bb 70
8dcb741b
JR
71Known problems, compatibility issues
72====================================
73These modules should be compatible with all Drupal core modules.
2e7ab2c3 74
975aa337 75Sample sites, using this module - e-mail me to be listed here
d469e0bb 76==========================================================
2e7ab2c3 77 http://www.reyero.net
f4c7262d
JR
78 http://www.para.ro
79 http://www.ctac.ca
8dcb741b
JR
80 http://grasshopperarts.com
81 http://funkycode.com
82 http://www.newoceans.nl
d469e0bb
JR
83
84Additional Support
3128d317 85=================
d469e0bb
JR
86For support, please create a support request for this module's project:
87 http://drupal.org/project/i18n
88
89If you need professional support, contact me by e-mail: freelance at reyero dot net
90
91====================================================================
975aa337 92Jose A. Reyero, drupal at reyero dot net, http://www.reyero.net
6681618a 93
d469e0bb 94Feedback is welcomed.