/[drupal]/contributions/modules/translatable/README.txt
ViewVC logotype

Contents of /contributions/modules/translatable/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph

Revision 1.3 - (show annotations) (download)
Wed Feb 20 01:56:08 2008 UTC (21 months ago) by sun
Branch: MAIN
CVS Tags: HEAD
Changes since 1.2: +13 -1 lines
File MIME type: text/plain 
Fixed untranslatable items are not synchronized.
Fixed source content of selects, checkboxes, and radios is not displayed.
Fixed _translatable_is_hideable_field() returns FALSE for fieldsets and markup.
Fixed PHP warnings in translatable_get_form_values() and translatable_set_form_values().
Fixed node edit redirects to wrong source node.
Fixed incomplete access check for node translation callback.
Fixed wrong translatable_find() conditions to find an existing translation.
Fixed translation language not properly set when editing a source node.
Added hook_translatable_form_alter() to allow modules to alter the final node form.
Fixed menu items for nodes are created in the wrong language.
Changed theme_translatable_languages() to return structured arrays instead of rendered links.
Added implementation of hook_admin_menu().
Updated README.txt.
1 /* $Id: README.txt,v 1.2 2008/02/18 14:45:36 sun Exp $ */
2
3 -- SUMMARY --
4
5 Translatable module is a different approach on Internationalization and
6 Localization. It is based on the fact that any translatable content in Drupal
7 is input via forms that have been built with the Forms API.
8
9 Any form item can have the property #translatable. If that property is set to
10 FALSE, the contents of the form item cannot be translated. If it is not set,
11 Translatable module assumes that it can be translated. If it is set to TRUE,
12 Translatable module automatically retrieves and displays the source contents
13 to translate the form item's content.
14
15 For this purpose, it adds a layer between Forms API and database storage.
16 Translatable uses two methods for data abstraction. These are:
17
18 - Generic translation objects, like blocks, menu items or taxonomy terms.
19 - Synchronized translations, like nodes.
20
21 Translation objects are stored as simple strings in the database. Source
22 strings are currently replaced with localized strings using separate
23 translation queries upon view. Any contributed module can make use of this
24 translation method. Retrieving translated strings using db_rewrite_sql() is
25 basically possible, however, not really supported by Drupal core - thus, still
26 CNW.
27
28 Synchronized translations are relations between two objects that are in a
29 translation set. For example, node/18 might be the German translation of
30 an English source content in node/16. Synchronized translations are suitable
31 for all contents that need to attach a language to build a "translation set".
32 Because of that, nodes are the only contents that are synchronized currently.
33 Translatable already implements the same node properties that can be found in
34 Drupal 6.
35
36 Translatable provides support for most used Drupal core objects, i.e. nodes,
37 blocks, menu items, and taxonomy vocabularies and terms. Due to its design,
38 support for CCK-based nodes is built-in.
39
40 By speaking of Drupal 6: Though this module should work as claimed, do not
41 expect any support for Drupal 5. If you want to give it a try, install it on
42 a test site first. Top priority is to port Translatable to Drupal 6 and to
43 create patches for Drupal 7 core as soon as possible.
44
45 By speaking of patches: Like Localizer, this module requires you to apply a
46 patch against Drupal core to allow translation of blocks and taxonomies.
47 Patches for all available official releases of Drupal core are included.
48
49 Translatable is partially based on the following modules:
50 - Localizer (Roberto Gerola)
51 - Internationalization (Jose A. Reyero, <http://drupal.org/project/i18n>)
52 - Translation (Axel)
53 - Switchlang (Heine Deelstra)
54 - Translate (Rob Ellis)
55
56
57 -- REQUIREMENTS --
58
59 * Locale (Drupal core).
60
61
62 -- INSTALLATION --
63
64 * Check your default locale in admin/settings/locale in front of installing this
65 module. Existing nodes will be flagged with this language and there is no way
66 to alter the language of existing nodes currently.
67
68 * Install as usual, see http://drupal.org/node/70151 for further information.
69
70 * Enable the module in administer >> Modules.
71
72 * Enable the blocks by visiting administer >> Site building >> Blocks.
73
74 * Apply the included patch for Taxonomy and Block module in Drupal core from
75 the patches/ directory. For further information, see README.txt in that
76 directory.
77
78
79 -- CONFIGURATION --
80
81 * Configure language negotiation options and supported content types in
82 administer >> Settings >> Translatable
83
84
85 -- USAGE --
86
87 * On edit forms, click on your desired translation language in the "Translation
88 language" block. After the page reloaded, you can submit your translation.
89 Please bear in mind, that this block is only displayed if you configured it
90 correctly on administer >> Site building >> Blocks.
91
92 * When viewing a node, click on the "Translations" tab to manage assigned
93 translations of a node. You can add existing nodes to a translation set and
94 remove a node from a translation set there.
95
96
97 -- CUSTOMIZATION --
98
99 * To enable further forms (form ids) or form items for translation, have a look
100 at
101
102 - translatable_alter_core_forms in translatable.object.inc
103 - translatable_alter_node_form() in translatable.node.inc
104
105 * Hooks for doing this are in the planning stage. Wanna help out?
106
107
108 -- TROUBLESHOOTING --
109
110 * If your translations do not show up, ensure that you have properly applied
111 the included patches for Drupal core.
112
113
114 -- FAQ --
115
116 Q: Creating or editing menu items in a node form is not possible, why?
117
118 A: Drupal assigns custom menu items to the configured default locale
119 (see admin/settings/locale). If you would create or edit such an object in
120 a different language, Drupal would still assign it to the default locale.
121 Because of that, those objects can only created and edited in the configured
122 default locale of Drupal.
123
124 Q: I posted a bug report, feature request, or support request in the module's
125 issue queue. Why has it been closed?
126
127 A: As long as there is no volunteer who maintains and contributes to the issue
128 queue, there is no user support for Translatable. Developers only. If you
129 like this project, consider applying as a volunteer.
130
131
132 -- CONTACT --
133
134 Current maintainers:
135 * Daniel F. Kudwien (sun) - dev@unleashedmind.com
136 * Stefan M. Kudwien (smk-ka) - dev@unleashedmind.com
137
138 Credits:
139 * Roberto Gerola - roberto.gerola@speedtech.it
140 * Jose A Reyero
141 * Anton Sidashin (Troy)
142
143 This project has been sponsored by:
144 * UNLEASHED MIND
145 Specialized in consulting and planning of Drupal powered sites, UNLEASHED
146 MIND offers installation, development, theming, customization, and hosting
147 to get you started. Visit http://www.unleashedmind.com for more information.
148
149
  ViewVC Help
Powered by ViewVC 1.1.2