PlatformUI translation doc

ezsystems · Mar 6, 2017 · 7cf8855 · 7cf8855
1 parent 55e53ba
commit 7cf8855
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -157,3 +157,22 @@ Then, you can run the unit tests with:
 ```
 $ php vendor/bin/phpunit
 ```
+
+* Translation
+
+To use translations in PlatformUI you have to use :
+  In the javascript files: 
+    
+```javascript
+  Y.eZ.trans('the.string.identifier', {}, 'domainname')
+  ```
+
+  In templates :
+
+```template
+  {{ translate 'the.string.identifier' 'domainname' }}
+  ```
+
+To generate the .xlf translation file (in PlatformUIBundle/Ressources/translations) 
+you need to use the script defined in PlatformUIBundle/bin/extract-translations.sh 
+(https://github.com/ezsystems/PlatformUIBundle/blob/master/bin/extract-translations.sh)