Projet

Général

Profil

Paste
Télécharger (6,29 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / l10n_update / README.txt @ 503b3f7b

1

    
2
Localization Update
3
-------------------
4
  Automatically download and update your translations by fetching them from
5
  http://localize.drupal.org or any other Localization server.
6

    
7
  The l10n update module helps to keep the translation of your drupal core and
8
  contributed modules up to date with the central Drupal translation repository
9
  at http://localize.drupal.org. Alternatively locally stored translation files
10
  can be used as translation source too.
11

    
12
  By choice updates are performed automatically or manually. Locally altered
13
  translations can either be respected or ignored.
14

    
15
  The l10n update module is developed for:
16
   * Distributions which include their own translations in .po files.
17
   * Site admins who want to update the translation with each new module revision.
18
   * Site builders who want an easy tool to download translations for a site.
19
   * Multi-sites that share one translation source.
20

    
21
  Project page:  http://drupal.org/project/l10n_update
22
  Support queue: http://drupal.org/project/issues/l10n_update
23

    
24
Installation
25
------------
26
  Download, unpack the module the usual way.
27
  Enable this module and the Locale module (core).
28

    
29
  You need at least one language (besides the default English).
30
  On Administration > Configuration > Regional and language > Languages:
31
    Click "Add language".
32
    Select a language from the select list "Language name".
33
    Then click the "Add language" button.
34

    
35
  Drupal is now importing interface translations. This can take a few minutes.
36
  When it's finished, you'll get a confirmation with a summary of the
37
  translations that have been imported.
38

    
39
  If required, enable the new language as default language.
40
  Administration > Configuration > Regional and language > Languages:
41
    Select your new default language.
42

    
43
Update interface translations
44
-----------------------------
45
  You want to import translations regularly using cron. You can enable this
46
  on Administration > Configuration > Regional and language > Languages:
47
    Choose the "Translation updates" tab.
48
    Change "Check for updates" to "Daily" or "Weekly" instead of the default "Never".
49
  From now on cron will check for updated translations, and import them is required.
50

    
51
  The status of the translations is reported on the "Status report" page at 
52
  Administration > Reports.
53

    
54
  To check the translation status and execute updates manually, go to
55
    Administration > Configuration > Regional and language > Translate inteface
56
    Choose the "Update" tab.
57
  You see a list of all modules and their translation status.
58
  On the bottom of the page, you can manually update using "Update translations".
59

    
60
Use Drush
61
---------
62
  You can also use drush to update your translations:
63
    drush l10n-update           # Update translations.
64
    drush l10n-update-refresh   # Refresh available information.
65
    drush l10n-update-status    # Show translation status of available project
66

    
67

    
68
Summary of administrative pages
69
-------------------------------
70
  Translations status overview can be found at
71
    Administration > Configuration > Regional and language > Languages > Translation updates
72

    
73
  Update configuration settings can be found at
74
    Administration > Configuration > Regional and language > Translate interface > Update
75

    
76
Translating Drupal core, modules and themes
77
-------------------------------------------
78
  When Drupal core or contributed modules or themes get installed, Drupal core
79
  checks if .po translation files are present and updates the translations with
80
  the strings found in these files. After this, the localization update module
81
  checks the localization server for more recent translations, and updates
82
  the site translations if a more recent version was found.
83
  Note that the translations contained in the project packages may become
84
  obsolete in future releases.
85

    
86
  Changes to translations made locally using the site's build in translation
87
  interface (Administer > Site building > Translate interface > Search) and
88
  changes made using the localization client module are marked. Using the
89
  'Update mode' setting 'Edited translations are kept...', locally edited
90
  strings will not be overwritten by translation updates.
91
  NOTE: Only manual changes made AFTER installing Localization Update module
92
  are preserved. To preserve manual changes made prior to installation of
93
  Localization Update module, use the option 'All existing translations are kept...'.
94

    
95
po files, multi site and distributions
96
--------------------------------------
97
  Multi sites and other installations that share the file system can share
98
  downloaded translation files. The Localization Update module can save these
99
  translations to disk. Other installations can use these saved translations
100
  as their translation source.
101

    
102
  All installations that share the same translation files must be configured
103
  with the same 'Store downloaded files' file path e.g. 'sites/all/translations'.
104
  Set the 'Update source' of one installation to 'Local files and remote server'
105
  or 'Remote server only', all other installations are set to
106
  'Local files only' or 'Local files and remote server'.
107

    
108
  Translation files are saved with the following file name syntax:
109

    
110
    <module name>-<release>.<language code>.po
111

    
112
  For example:
113
    masquerade-6.x-1.5.de.po
114
    tac_lite-7.x-1.0-beta1.nl.po
115

    
116
  Po files included in distributions should match this syntax too.
117

    
118
Alternative sources of translation
119
----------------------------------
120

    
121
  Each project i.e. modules, themes, etc. can define alternative translation
122
  servers to retrieve the translation updates from.
123
  Include the following definition in the projects .info file:
124

    
125
    l10n server = example.com
126
    l10n url = http://example.com/files/translations/l10n_server.xml
127

    
128
  The download path pattern is normally defined in the above defined xml file.
129
  You may override this path by adding a third definition in the .info file:
130

    
131
    l10n path = http://example.com/files/translations/%core/%project/%project-%release.%language.po
132

    
133
API
134
---
135
  Using hook_l10n_servers the l10n update module can be extended to use other
136
  translation repositories. Which is usefull for organisations who maintain
137
  their own translation.
138

    
139
  Using hook_l10n_update_projects_alter modules can alter or specify the
140
  translation repositories on a per module basis.
141

    
142
  See l10n_update.api.php for more information.
143

    
144
Maintainers
145
-----------
146
  Jose Reyero
147
  Gábor Hojtsy
148
  Erik Stielstra