Project

General

Profile

HowTo translate Redmine in your own language » History » Revision 26

Revision 25 (Mischa The Evil, 2017-02-10 06:05) → Revision 26/27 (Go MAEDA, 2021-04-13 09:35)

h1. HowTo translate Redmine to your own language 

 Redmine can easily be translated to any language. 

 There are a few things to translate: 

 * The main lang file, located at source:/trunk/config/locales in current trunk 
 * The wiki toolbar lang file, located in source:trunk/public/javascripts/jstoolbar/lang 
 * The four bundled help files, located in source:trunk/public/help/ under a subdir named after the language subtag 

 Say you want to translate Redmine to Finnish (@fi@ as defined in the "IANA Language Subtag Registry":http://www.iana.org/assignments/language-subtag-registry): 

 # Copy @/config/locales/en.yml@ to @/config/locales/fi.yml@. 
 # Copy @/public/javascripts/jstoolbar/lang/jstoolbar-en.js@ to @/public/javascripts/jstoolbar/lang/jstoolbar-fi.js@. 
 # Copy @/public/help/en/*@ to @/public/help/fi/*@. 
 # Change the @general_lang_name@ key with the full name of the new language in @fi.yml@ (eg. @general_lang_name: Finnish@). 
 # Clear the application cache to make the new language available in Redmine (eg. @rake tmp:cache:clear@). 

 Then: 

 # Translate every string in _fi.yml_ and _jstoolbar-fi.js_ files and translate the content of the four help files (_wiki_syntax_textile.html_, _wiki_syntax_markdown.html_, _wiki_syntax_detailed_textile.html_ & _wiki_syntax_detailed_markdown.html_). 
 # Test your translation with the rake tasks listed [[HowTo_translate_Redmine_in_your_own_language#Test-rake-tasks|below]]. If you get errors related to locales, you must fix them. 
 # Submit your translation "here":http://www.redmine.org/projects/redmine/issues/new?tracker_id=3 (as plain file or patch, login required). Select "Translation" in Category listbox. 
 # Wait until your Issue will be fixed. 
 # Enjoy your work :) 
 # GOTO 4 if needed. 

 h3. Test rake tasks 

 Test if translation files can be parsed without errors and there are no missing keys On Ruby 1.9 or higher: 
 <pre> 
 rake locales:check_parsing_by_psych 
 </pre> 

 On all Ruby versions: 

 <pre> 
 rake locales:check_interpolation 
 </pre> 

 Whole test (Optional) 

 <pre> 
 rake test 
 </pre> 

 "rake test" takes a very long time and it runs automatically on CI server. 
 See [[Continuous integration]]. 

 h2. Restrictions 

 *All these files must be UTF-8 encoded.* Do not use HTML entities in translated strings. 

 Check that your files do not have a BOM (Byte-order mark). A BOM can be removed with the following command: 

 <pre> 
 awk '{if(NR==1)sub(/^\xef\xbb\xbf/, "");print}' < oldfile > newfile 
 </pre> 

 As of 2009-02-21, *only updates based on the new translation files* (found in @/config/locales@) *should be submitted.* 

 h2. Updates to the language files 

 The file: "@en.yml@" acts as the main language file. You can check if it has new strings by running: 
 <pre>rake locales:update</pre> 

 This copies any new strings to other translation files (with the English translation as default value).