Difference between revisions of "Translation How-To"

From Freeplane - free mind mapping and knowledge management software
(Undo revision 652 by Olivia (Talk) spam)
Line 1: Line 1:
 
This page will give you all the information you need to translate Freeplane into your own language.
 
This page will give you all the information you need to translate Freeplane into your own language.
  
= GUI translation (GUI means Graphical User Interface) =
+
= Freeplane translation (ie translation of the Graphical User Interface -GUI- ) =
  
These are all the strings that show up in Freeplane, especially in menus and dialogs.
+
These are all the strings displayed in Freeplane, especially in menus and dialogs.
  
 
== Instructions ==
 
== Instructions ==
  
#Download the [https://sourceforge.net/projects/popeye/ Popeye translation tool]  
+
#Download [https://sourceforge.net/projects/popeye/ Popeye translation tool]  
#Get the latest translation file from [http://freeplane.sourceforge.net/cgi-bin/translist.cgi#Translations Freeplane translation table] both for the reference (EN recommended) and for your language
+
#Get the latest translation file from [http://freeplane.sourceforge.net/cgi-bin/translist.cgi#Translations Freeplane translation table] both for the reference language (EN recommended) and for your language
 
#In Popeye : create a project and do the translation, see this [http://freeplane.svn.sourceforge.net/viewvc/freeplane/freeplane_program/trunk/freeplane_test/src/main/resources/howtos/howto_use_popeye/rendered/howto_use_popeye.swf?revision=630&pathrev=630 Flash tutorial]
 
#In Popeye : create a project and do the translation, see this [http://freeplane.svn.sourceforge.net/viewvc/freeplane/freeplane_program/trunk/freeplane_test/src/main/resources/howtos/howto_use_popeye/rendered/howto_use_popeye.swf?revision=630&pathrev=630 Flash tutorial]
 
#Check the completeness of your translation file using [http://freeplane.sourceforge.net/transcheck TransCheck]  
 
#Check the completeness of your translation file using [http://freeplane.sourceforge.net/transcheck TransCheck]  
#You can now add the new translation on your current Freeplane installation : browse your Freeplane installation directory, create subfolders resources/translations and put your file there. Run Freeplane and check your translation
+
#You can now add the new translation on your current Freeplane installation for test : in your Freeplane installation directory, create subfolders resources/translations and put your translation file there. Run Freeplane and check your translation
#Go to the [http://sourceforge.net/apps/mantisbt/freeplane/search.php?project_id=12&hide_status_id=90 tracker] (requires Sourceforge log-in) and upload your file (the Project should be set to Translations).
+
#When translation is ok : go to the [http://sourceforge.net/apps/mantisbt/freeplane/search.php?project_id=12&hide_status_id=90 tracker] (requires Sourceforge log-in) and upload your file (the Project should be set to Translations). The development team will add your translation to the next release.
  
 
You're done!  
 
You're done!  
Line 23: Line 23:
 
; Why is there & character before some values (sometimes "in" the words) ? : the ampersand (&) is used to mark keys in the menu (i.e. open the menu, press the key/letter to activate the menu entry) - while translating, you need to make sure that each letter is only used once per menu.
 
; Why is there & character before some values (sometimes "in" the words) ? : the ampersand (&) is used to mark keys in the menu (i.e. open the menu, press the key/letter to activate the menu entry) - while translating, you need to make sure that each letter is only used once per menu.
 
; Some values begins by <html> with no </html> at the end ? : Java accepts unclosed tags - don't care.
 
; Some values begins by <html> with no </html> at the end ? : Java accepts unclosed tags - don't care.
; Some key are not used / displayed in the software : you should stay aligned with the English version to be on the safe side, but if keys are not used, it's a bug you can/should report.
+
; Some key are not used / displayed in the software : you should stay aligned with the English version to be on the safe side, but if keys are not used, it's a bug you can report.
; Some key are in double like icon_clock or icon_clock2 or icon_user_icon hence I removed them : removing one of the duplicate keys is the right decision.
 
  
 
== Tips for translators ==
 
== Tips for translators ==
  
 
; Your translation is truncated : If your translation is truncated when displayed, it may contains a ' character (e.g. Freeplane displays "Copier l" instead of "Copier l'identifiant"), you may simply enter the ' character twice (ie "Copier l"identifiant") as translation where " is twice the character '.
 
; Your translation is truncated : If your translation is truncated when displayed, it may contains a ' character (e.g. Freeplane displays "Copier l" instead of "Copier l'identifiant"), you may simply enter the ' character twice (ie "Copier l"identifiant") as translation where " is twice the character '.
 +
  
 
= Documentation map translation =
 
= Documentation map translation =
Line 36: Line 36:
 
== Instructions ==
 
== Instructions ==
  
# Download the latest version of <tt>freeplane.mm</tt> and <tt>FP_MenuReference.mm</tt> (and an already existing versions in your language) from the Bazaar repository.
+
# Download the latest version of <tt>freeplane.mm</tt> and <tt>FP_MenuReference.mm</tt> (or an already existing versions in your language) from the Bazaar repository.
 
#* The current link is http://freeplane.bzr.sourceforge.net/bzr/freeplane/freeplane_program/release_branches/1_0_x/files/head%3A/freeplane/resources/doc/ (but check if it's not an outdated link)
 
#* The current link is http://freeplane.bzr.sourceforge.net/bzr/freeplane/freeplane_program/release_branches/1_0_x/files/head%3A/freeplane/resources/doc/ (but check if it's not an outdated link)
# Visit pages http://freeplane.sourceforge.net/doc/freeplane_all_languages.html and http://freeplane.sourceforge.net/doc/FP_MenuReference_all_languages.html to see how the documentation is translated by Google Translate.
+
# Visit pages http://freeplane.sourceforge.net/doc/freeplane_all_languages.html and http://freeplane.sourceforge.net/doc/FP_MenuReference_all_languages.html to see how the documentation is automaticly translated by Google Translate.
 
# Using the latest development version of Freeplane, just create a map in your language (or complete the one already existing).
 
# Using the latest development version of Freeplane, just create a map in your language (or complete the one already existing).
 
#* As it's almost impossible to track differences between maps and ensure an exact one to one relationship between the languages, we don't expect this from translators.
 
#* As it's almost impossible to track differences between maps and ensure an exact one to one relationship between the languages, we don't expect this from translators.
Line 44: Line 44:
 
#* Just make sure that the map is consistent with the current version of Freeplane, as complete as possible and helpful to users.
 
#* Just make sure that the map is consistent with the current version of Freeplane, as complete as possible and helpful to users.
 
# Go to the [http://sourceforge.net/apps/mantisbt/freeplane/search.php?project_id=12&hide_status_id=90 tracker] (requires Sourceforge log-in) and upload your map (the Project should be set to Translations).
 
# Go to the [http://sourceforge.net/apps/mantisbt/freeplane/search.php?project_id=12&hide_status_id=90 tracker] (requires Sourceforge log-in) and upload your map (the Project should be set to Translations).
 +
  
 
= Keys Mapping translation =
 
= Keys Mapping translation =
  
 
TBD
 
TBD
 +
  
 
= Java Help translation =
 
= Java Help translation =
Line 53: Line 55:
 
TBD (the current version doesn't allow for localization). Hint for later: http://jhelpdev.sourceforge.net/
 
TBD (the current version doesn't allow for localization). Hint for later: http://jhelpdev.sourceforge.net/
  
= Wiki and other documentation translation =
 
 
TBD
 
  
 
[[Category:Advanced_Users]] [[Category:Developer_Documentation]] [[Category:Team_Freeplane]][[Category:Tutorials]]
 
[[Category:Advanced_Users]] [[Category:Developer_Documentation]] [[Category:Team_Freeplane]][[Category:Tutorials]]

Revision as of 21:58, 9 November 2010

This page will give you all the information you need to translate Freeplane into your own language.

Freeplane translation (ie translation of the Graphical User Interface -GUI- )

These are all the strings displayed in Freeplane, especially in menus and dialogs.

Instructions

  1. Download Popeye translation tool
  2. Get the latest translation file from Freeplane translation table both for the reference language (EN recommended) and for your language
  3. In Popeye : create a project and do the translation, see this Flash tutorial
  4. Check the completeness of your translation file using TransCheck
  5. You can now add the new translation on your current Freeplane installation for test : in your Freeplane installation directory, create subfolders resources/translations and put your translation file there. Run Freeplane and check your translation
  6. When translation is ok : go to the tracker (requires Sourceforge log-in) and upload your file (the Project should be set to Translations). The development team will add your translation to the next release.

You're done!

Frequently Asked Questions

Why are translation strings ending with "[translate me]" ? 
As long as a key is missing in a translation Freeplane automatically uses "<English text> [translate me]" as translation. Translators should search and translate these strings in priority and then remove "[translate me]".
Why are translation strings ending with "[auto]" ? 
We have an automatic translation tool that uses the Google translation engine to translate each remaining "[translate me]" strings for each language. Strings translated that way have an [auto] suffix. Translators should search and review these strings and then remove "[auto]".
Why is there sometimes space before values ? 
spaces before values are ignored, don't care.
Why is there & character before some values (sometimes "in" the words) ? 
the ampersand (&) is used to mark keys in the menu (i.e. open the menu, press the key/letter to activate the menu entry) - while translating, you need to make sure that each letter is only used once per menu.
Some values begins by <html> with no </html> at the end ? 
Java accepts unclosed tags - don't care.
Some key are not used / displayed in the software 
you should stay aligned with the English version to be on the safe side, but if keys are not used, it's a bug you can report.

Tips for translators

Your translation is truncated 
If your translation is truncated when displayed, it may contains a ' character (e.g. Freeplane displays "Copier l" instead of "Copier l'identifiant"), you may simply enter the ' character twice (ie "Copier l"identifiant") as translation where " is twice the character '.


Documentation map translation

This is the map mind you get when you press the <F1> key or use the menu point Help → Documentation.

Instructions

  1. Download the latest version of freeplane.mm and FP_MenuReference.mm (or an already existing versions in your language) from the Bazaar repository.
  2. Visit pages http://freeplane.sourceforge.net/doc/freeplane_all_languages.html and http://freeplane.sourceforge.net/doc/FP_MenuReference_all_languages.html to see how the documentation is automaticly translated by Google Translate.
  3. Using the latest development version of Freeplane, just create a map in your language (or complete the one already existing).
    • As it's almost impossible to track differences between maps and ensure an exact one to one relationship between the languages, we don't expect this from translators.
    • To track changes of freeplane.mm filters can be useful: Open the file in normal mindmap mode (not via F1) and apply a "Date filter" with the modification time set to the last time you have edited the translated map.
    • Just make sure that the map is consistent with the current version of Freeplane, as complete as possible and helpful to users.
  4. Go to the tracker (requires Sourceforge log-in) and upload your map (the Project should be set to Translations).


Keys Mapping translation

TBD


Java Help translation

TBD (the current version doesn't allow for localization). Hint for later: http://jhelpdev.sourceforge.net/