More updates for Drupal 4.7
[project/i18n.git] / README.txt
CommitLineData
73fa9ab3
UH
1README.txt
2==========
6681618a 3
d469e0bb 4********************************************************************
d48b38b0 5 This is i18n module, version cvs, and works -kind of- with Drupal 4.7.x
d469e0bb 6********************************************************************
d48b38b0
JR
7WARNING: It is not 100% backwards compatible with the old i18n module [4.5.x]
8WARNING: Module is being updated for Drupal 4.7 so it is *unstable*
d469e0bb 9WARNING: DO READ THE INSTALL FILE
d469e0bb 10********************************************************************
6681618a 11
d469e0bb 12This module implements multilingual support as outlined in http://drupal.org/node/11051
975aa337 13Some more info about this module will be available here: http://reyero.net/en/drupal/i18n
6681618a 14
d469e0bb
JR
15It doesn't require anymore multiple language tables as previous versions
16
17This module provides support for internationalization of Drupal sites:
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
JR
21 * Keeps the language settings accross consecutive requests using URL rewriting.
22 * Provides a block for language selection and two theme functions: i18n_flags and i18n_links
6681618a
JR
23
24To have a language selector on your page, you can use the block provided or these theme functions:
25
26 theme("i18n_flags") -> Adds just a row with the flags
27 theme("i18n_links",$flags,$names,$delim1,$delim2) -> Check documentation in the code for different options
28
2e7ab2c3 29Multilingual content:
6681618a 30=====================
d469e0bb
JR
31Multilingual 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.
32This module supports:
33 - Multilingual nodes
34 - Multilingual taxonomy vocabularies and terms
35 - Basic translation management for nodes and terms
36
975aa337
JR
37When 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.
38When editing a node, you must click on 'Preview' after changing language for the right vocabularies and terms to be shown.
d469e0bb 39
975aa337 40The multi language support is expected to work for all node types, and node listings in Drupal 4.6!!
d469e0bb 41
975aa337 42So far, I have not found incompatibilities with any other module. Please, let me know if you find any.
d469e0bb
JR
43
44And yes, flexinode works with multiple languages :-)
45
2e7ab2c3
JR
46Taxonomy translation:
47====================
48You can create vocabularies and terms with or without language.
49- If you set language for a vocabulary/term, that term will just show up for pages in that language
50- If you set language for a vocabulary, all the terms in that vocabulary will be assigned that language.
51- 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.
52
d469e0bb
JR
53About URL aliasing with language codes -requires path module
54====================================
55Incoming URL's are now translated following these steps:
561. First, a translation is searched for path with language code: 'en/mypage'
3128d317 572. If not found, language code is removed, and path translation is searched again: 'mypage'
d469e0bb
JR
58Thus, you can define aliases with or without language codes in them
59
60The '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
3128d317 61This language code will be taken from browser if enabled 'Browser language detection, or will be the default otherwise.
d469e0bb 62
975aa337
JR
63To have aliases for a translated node/page, you have to define each of them. I.e.:
64 en/mycustompath -> node/34 (which is suppossed to be the english version)
65 es/mycustompath -> node/35 (which should be the spanish version)
66
67For outgoing URL's, the language code will be added authomatically.
d469e0bb
JR
68
69About language dependent variables:
6681618a
JR
70======================
71Some site-wide variables, like 'site_name', 'site_slogan', user e-mail contents... have language dependent content.
72Since 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 73This part is an add-on, and you can use it or not.
6681618a 74
d469e0bb
JR
75About language dependent tables
76===============================
77Language dependent tables are not needed anymore for multilingual content.
3128d317
JR
78This is kept for backwards compatibility, experimentation and may be some use in the future.
79* This can be used to have per-language data for modules not language-aware, like language statistics... you can experiment...
d469e0bb 80
2e7ab2c3
JR
81Known problems, compatibility
82=============================
83- Taxonomy patch not compatible with taxonomy_access patch. See http://drupal.org/node/22834
84
975aa337 85Sample sites, using this module - e-mail me to be listed here
d469e0bb 86==========================================================
d48b38b0
JR
87 http://ctac.ca
88 http://grasshopperarts.com
89 http://funkycode.com
90 http://www.newoceans.nl
91 http://www.arcolatino.org
2e7ab2c3 92 http://www.reyero.net
d469e0bb
JR
93
94Additional Support
3128d317 95=================
d469e0bb
JR
96For support, please create a support request for this module's project:
97 http://drupal.org/project/i18n
98
99If you need professional support, contact me by e-mail: freelance at reyero dot net
100
101====================================================================
975aa337 102Jose A. Reyero, drupal at reyero dot net, http://www.reyero.net
6681618a 103
d469e0bb 104Feedback is welcomed.