Skip to content
This repository
Browse code

MINOR Translation process docs

  • Loading branch information...
commit 3e7bf77a70aab411e79046cbdcbb06fb4bbaa412 1 parent f17bb8f
Ingo Schommer authored June 22, 2012

Showing 1 changed file with 34 additions and 16 deletions. Show diff stats Hide diff stats

  1. 50  docs/en/misc/translation-process.md
50  docs/en/misc/translation-process.md
Source Rendered
@@ -14,21 +14,34 @@ This format is now deprecated, and we don't provide tools
14 14
 for editing the files. Please see below for information on
15 15
 how to convert these legacy files and existing translations to YML.
16 16
 
  17
+## Download Translations
  18
+
  19
+We are managing our translations through a tool called [getlocalization.com](http://getlocalization.com).
  20
+Most modules are managed under the "silverstripe" user there,
  21
+see [list of translatable modules](http://www.getlocalization.com/profile/?username=silverstripe).
  22
+
  23
+Translations are exported from there into YML files, generated every hour,
  24
+and committed to a special "translation-staging" branch on github.
  25
+You can download individual files by opening them on github.com (inside the `lang/` folder), and using the "Raw" view.
  26
+Place those files in the appropriate directories on a local silverstripe installation. 
  27
+
  28
+ * ["translation-staging" branch for framework module](https://github.com/silverstripe/sapphire/tree/translation-staging)
  29
+ * ["translation-staging" branch for cms module](https://github.com/silverstripe/silverstripe-cms/tree/translation-staging)
  30
+
17 31
 ## Help as a translator
18 32
 
19 33
 ### The online translation tool
20 34
 
21  
-We are managing our translations through a tool called
22  
-[getlocalization.com](http://getlocalization.com).
23  
-Most modules are managed under the "silverstripe" user there,
24  
-see [list of translatable modules](http://www.getlocalization.com/profile/?username=silverstripe).
  35
+We provide a GUI for translations through [getlocalization.com](http://getlocalization.com).
25 36
 If you don't have an account yet, please follow the links there to sign up.
  37
+Select a project from the [list of translatable modules](http://www.getlocalization.com/profile/?username=silverstripe)
  38
+and start translating online!
26 39
 
27 40
 For all modules listed there, we automatically import new master strings
28 41
 as they get committed to the various codebases, so you're always translating
29  
-on the latest and greatest version (through github service hooks).
  42
+on the latest and greatest version.
30 43
 
31  
-## Set up your module for localization
  44
+## Set up your own module for localization
32 45
 
33 46
 ### Collecting translatable text
34 47
 
@@ -61,9 +74,19 @@ change the first line in this file from "en_GB" to "en-GB".
61 74
 
62 75
 ### Export existing translations
63 76
 
64  
-You can simply download the whole language pack as a ZIP archive
  77
+As a project maintainer, you have the permission can simply download the whole language pack as a ZIP archive
65 78
 and add it to your project. But for composite locales (e.g. "en-GB"),
66  
-you have to change the keys in the first line of the file (see note above).
  79
+you have to change the keys in the first line of the file.
  80
+
  81
+We encourage you to use the SilverStripe build tools for this instead,
  82
+as they run some additional sanity checks. They require the "phing" tool.
  83
+Create a 'translation-staging' branch in your module before starting,
  84
+and merge it back manually to your 'master' as required.
  85
+
  86
+	pear install phing/phing
  87
+	cp build.properties.default
  88
+	cp build.properties # Add your own getlocalization config to 'build.properties'
  89
+	phing -Dmodule=<yourmodule> -propertyfile build.properties translations-sync
67 90
 
68 91
 ### Converting your language files from 2.4 PHP format
69 92
 
@@ -83,16 +106,10 @@ Special characters (such as german umlauts) need to be entered in their native f
83 106
 ### How can I check out my translation in the interface?
84 107
 
85 108
 Currently translated entities are not directly factored into code (for security reasons and release/review-control), so you can't see them straight away. 
86  
-You can download automatically generated files for your language for each module (e.g. cms, sapphire, forum, ...) - 
87  
-and place those files in the appropriate directories on a local silverstripe installation. 
88 109
 
89  
-Example for downloading french files:
90  
-downloaded fr.yml for cms => /cms/lang/fr.yml
91  
-downloaded fr.yml for sapphire => /sapphire/lang/fr.yml
92  
-(repeat for all modules) 
93 110
 
94 111
 It is strongly encouraged that you check your translation this way, as its a good way to doublecheck your translation works in the right context.
95  
-Please use our daily-builds for your local installation, to ensure you're looking at the most up to date interface.
  112
+Please use our [daily-builds](http://www.silverstripe.org/daily-builds/) for your local installation, to ensure you're looking at the most up to date interface.
96 113
 
97 114
 ### Can I change a translation just for one SilverStripe version?
98 115
 
@@ -131,7 +148,8 @@ We are currently investigating the available options, and are eager to get feedb
131 148
 
132 149
 ### Can I translate/edit the language files in my favourite text editor (on my local installation)
133 150
 
134  
-No, as it causes us a lot of work in merging these files back.
  151
+Not for modules managed by getlocalization.com, including "framework" and "cms.
  152
+It causes us a lot of work in merging these files back.
135 153
 Please use the online translation tool for all new and existing translations.
136 154
 
137 155
 ### How does my translation get into a SilverStripe release?

0 notes on commit 3e7bf77

Please sign in to comment.
Something went wrong with that request. Please try again.