Development/Tutorials/Localization/i18n Challenges - Revision history

AnneW at 12:49, 13 July 2012

2012-07-13T12:49:58Z

Neverendingo: Text replace - "" to ""

2011-06-29T21:15:55Z

Text replace - "</ code>" to "</syntaxhighlight>"

Neverendingo: Text replace - "`" to ""`


2011-06-29T20:44:56Z
Text replace - "<code>" to "<syntaxhighlight lang="text">"

				
				
				
				
			
			← Older revision
			Revision as of 20:44, 29 June 2011
			
Line 159:
Line 159:
  <voices>   <voices>
  <voice>   <voice>
−    <code>kal_diphone</ code> +    <syntaxhighlight lang="text">kal_diphone</ code>
     <language>en_US</language>      <language>en_US</language>
     <codec>ISO 8859-1</codec>      <codec>ISO 8859-1</codec>



Icwiener: Fix syntax highlighting.
2011-06-27T17:09:28Z
Fix syntax highlighting.

				
				
				
				
			
			← Older revision
			Revision as of 17:09, 27 June 2011
			
Line 37:
Line 37:
  It is considered a violation of the message freeze to add a brand new translated string to your code where the string did not exist untranslated before. So changing this:   It is considered a violation of the message freeze to add a brand new translated string to your code where the string did not exist untranslated before. So changing this:
    
− <code cppqt>QMessageBox::warning(0, "Starting KTTSD Failed", error );</code> + <syntaxhighlight lang="cpp-qt">
  + QMessageBox::warning(0, "Starting KTTSD Failed", error );
  + </syntaxhighlight>
    
  to this:   to this:
    
− <code cppqt>QMessageBox::warning(0, i18n( "Starting KTTSD Failed"), error );</code> + <syntaxhighlight lang="cpp-qt">
  + QMessageBox::warning(0, i18n( "Starting KTTSD Failed"), error );
  + </syntaxhighlight>
    
  is OK, but adding the call to QMessageBox where it didn't exist before will raise objections from the translators.     is OK, but adding the call to QMessageBox where it didn't exist before will raise objections from the translators.  
Line 111:
Line 115:
    
  If your application uses data that you want the translators to translate for you, there are a couple of solutions. If the data is a single string, and you want to use a translation of the string that is different from the user's desktop language setting, you can create a .desktop file and extract the translated string from it. For example, the KDE text-to-speech daemon (KTTSD) has the following {{path|kcmkttsd_testmessage.desktop}} file:     If your application uses data that you want the translators to translate for you, there are a couple of solutions. If the data is a single string, and you want to use a translation of the string that is different from the user's desktop language setting, you can create a .desktop file and extract the translated string from it. For example, the KDE text-to-speech daemon (KTTSD) has the following {{path|kcmkttsd_testmessage.desktop}} file:  
− <code ini> + <syntaxhighlight lang="ini">
  [Desktop Entry]   [Desktop Entry]
  Encoding=UTF-8   Encoding=UTF-8
  NoDisplay=true   NoDisplay=true
  Name=The text-to-speech system seems to be functioning properly.   Name=The text-to-speech system seems to be functioning properly.
− </code> + </syntaxhighlight>
  Notice the <tt>NoDisplay=true</tt> line. The translators will translate the Name line and scripty will insert the translations back into the .desktop file. At runtime, KTTSD uses the following code to get a test message to speak in the language of the synthesizer's voice, not the user's desktop language:     Notice the <tt>NoDisplay=true</tt> line. The translators will translate the Name line and scripty will insert the translations back into the .desktop file. At runtime, KTTSD uses the following code to get a test message to speak in the language of the synthesizer's voice, not the user's desktop language:  
    
− <code cppqt n>QString key = "Name[" + languageCode + "]"; + <syntaxhighlight lang="cpp-qt">
  + QString key = "Name[" + languageCode + "]";
  QString result;   QString result;
  QString def;   QString def;
Line 146:
Line 151:
     result = def;      result = def;
  }   }
− return result;</code> + return result;
  + </syntaxhighlight>
    
  If your program has larger amounts of data, an XML file is a good way to go. For example, KTTSD maintains a list of Festival synthesizer voices in an XML file called voices. Here's a sample portion from that file:     If your program has larger amounts of data, an XML file is a good way to go. For example, KTTSD maintains a list of Festival synthesizer voices in an XML file called voices. Here's a sample portion from that file:  
− <code xml> + <syntaxhighlight lang="xml">
  <?xml version="1.0" encoding="UTF-8"?>   <?xml version="1.0" encoding="UTF-8"?>
  <voices>   <voices>
Line 159:
Line 165:
     <name>American Male</name>      <name>American Male</name>
  </voice>   </voice>
− </code> + </syntaxhighlight>
  {{improve}}   {{improve}}
    
Line 172:
Line 178:
  Notice that the translators are given a context to help them to translate the voice names. At runtime, KTTSD parses the voices file and displays the translated name of each voice (in the user's desktop language) using code like this:     Notice that the translators are given a context to help them to translate the voice names. At runtime, KTTSD parses the voices file and displays the translated name of each voice (in the user's desktop language) using code like this:  
    
− <code cppqt n>QDomNode childNode = node.namedItem("name"); + <syntaxhighlight lang="cpp-qt">
  + QDomNode childNode = node.namedItem("name");
  if (!childNode.isNull())   if (!childNode.isNull())
−    QString name = i18n("FestivalVoiceName", +    QString name = i18n("FestivalVoiceName", childNode.toElement().text().utf8());
−     childNode.toElement().text().utf8());</code> + </syntaxhighlight>
    
  == Examining .po Files ==   == Examining .po Files ==



SommerLuk: /* Coding in a Foreign Language */ Review english strings for foreign language developers
2010-09-26T06:49:23Z
‎Coding in a Foreign Language:  Review english strings for foreign language developers

				
				
				
				
			
			← Older revision
			Revision as of 06:49, 26 September 2010
			
Line 193:
Line 193:
  If you are not comfortable with the English language, you may have coded your application using strings in your native language. You must convert all your code to English before it can be translated by the translation teams.   If you are not comfortable with the English language, you may have coded your application using strings in your native language. You must convert all your code to English before it can be translated by the translation teams.
    
− One solution is to get someone who understands both English and your language to help you with this. You can also ask for a volunteer on the kde-i18n-doc mailing list. You will create your .pot file (see Distributing message catalogs [*]) and send it to them. They will translate it to English and send you back a .po file. Using cut and paste, put the English strings into your code. If you do this, it is still a good idea to have an English speaker review your code for any mistakes.   + One solution is to get someone who understands both English and your language to help you with this. You can also ask for a volunteer on the kde-i18n-doc mailing list. You will create your .pot file (see Distributing message catalogs [*]) and send it to them. They will translate it to English and send you back a .po file. Using cut and paste, put the English strings into your code.
−   +  
  + If you do this, it is still a good idea to have an English speaker review your code for any mistakes. You can use [http://cli-apps.org/content/show.php/poreviewtool?content=132789 poreviewtool], a tool which makes the review of the English strings easier (relays also on .po files, but makes the handling much easier if you want to review continuously.)
  +  
  == Merging .po Files ==   == Merging .po Files ==
    



Ilic: Change of context property name in Designer in Qt 4.5.
2009-04-21T18:14:54Z
Change of context property name in Designer in Qt 4.5.

				
				
				
				
			
			← Older revision
			Revision as of 18:14, 21 April 2009
			
Line 98:
Line 98:
    <whatsthis context="A concoction">Not entirely unlike tea</whatsthis>     <whatsthis context="A concoction">Not entirely unlike tea</whatsthis>
    
− and in QtDesigner as the comment property to text labels (which become <tt>comment</tt> attributes in the UI file itself). + and in QtDesigner as the "disambiguation" property to text labels (or "comment" prior to Qt 4.5), which become <tt>comment</tt> attributes in the UI file itself.
    
  Also, if that is more suitable, a parameter can be added to the call to extractrc by which the same context is provided to all strings extracted from the file. Example:   Also, if that is more suitable, a parameter can be added to the call to extractrc by which the same context is provided to all strings extracted from the file. Example:





Hualiang.miao: internationalization
2009-04-05T13:37:11Z
internationalization

				
				
				
				
			
			← Older revision
			Revision as of 13:37, 5 April 2009
			
Line 1:
Line 1:
  + {{Template:I18n/Language Navigation Bar|Development/Tutorials/Localization/i18n Challenges}}
  + 
  {{TutorialBrowser|   {{TutorialBrowser|
    



Ezak: Corrected some typos.
2008-08-17T06:46:50Z
Corrected some typos.

				
				
				
				
			
			← Older revision
			Revision as of 06:46, 17 August 2008
			
Line 11:
Line 11:
  == Abstract ==   == Abstract ==
    
− The localization process can at times be tricky. This tutorial covers challenges that you may eventually run into such as translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, deeling with freezes, coding in languages other than English and creating independent releases of or moving applications between KDE modules. + The localization process can, at times, be tricky. This tutorial covers challenges that you may eventually run into such as: translating handbooks and other data that exists outside of the source code, merging and handling obsolete .po files, dealing with freezes, coding in languages other than English and creating independent releases, or moving applications between KDE modules.
    
  {{note|The references to Makefile.am's needs to be ported to CMake.}}   {{note|The references to Makefile.am's needs to be ported to CMake.}}
Line 17:
Line 17:
  == Message Freezes ==   == Message Freezes ==
    
− As a release date starts getting close, most software projects (including the KDE project) will freeze all changes to user visible strings. This allows translators a chance to do their work without it being constantly distrupted by changes to strings thereby wasting their efforts.  If you change i18n strings in your application during such freezes it creates more work (and confusion) for the teams and could prevent your application from being released with translations. + As a release date starts getting close, most software projects (including the KDE project) will freeze all changes to user visible strings. This allows translators a chance to do their work without it being constantly disrupted by changes to strings thereby wasting their efforts.  If you change i18n strings in your application during such freezes it creates more work (and confusion) for the teams and could prevent your application from being released with translations.
    
  {{note|If your application is part of KDE that is periodically announced and released, you must pay attention to announcements on the mailing lists for message freezes. When a message freeze is in place, you must not change any of the translatable strings in your application or its Handbook.}}   {{note|If your application is part of KDE that is periodically announced and released, you must pay attention to announcements on the mailing lists for message freezes. When a message freeze is in place, you must not change any of the translatable strings in your application or its Handbook.}}
Line 43:
Line 43:
  is OK, but adding the call to QMessageBox where it didn't exist before will raise objections from the translators.     is OK, but adding the call to QMessageBox where it didn't exist before will raise objections from the translators.  
    
− In the latter case, ask on the kde-i18n-doc mailing list first. In general, the criteria for modifying or adding strings is potentially severe misunderstanding of a message, especially if it means a risk of losing data.   + In the latter case, ask on the kde-i18n-doc mailing list first. In general, the criteria for modifying or adding strings is a potentially severe misunderstanding of a message, especially if it means a risk of losing data.  
    
  {{tip|You may see translators refer to "fuzzy" strings. Fuzzy strings come about when a string has already been translated and then is changed a little bit later. xgettext leaves the original translation in the .po file, but marks the string as fuzzy. The translator must look at the translation to determine if a change is needed and remove the fuzzy flag, otherwise the translation will not be used at runtime. In short, if you change strings in your app, they will generate fuzzies for the translators.}}   {{tip|You may see translators refer to "fuzzy" strings. Fuzzy strings come about when a string has already been translated and then is changed a little bit later. xgettext leaves the original translation in the .po file, but marks the string as fuzzy. The translator must look at the translation to determine if a change is needed and remove the fuzzy flag, otherwise the translation will not be used at runtime. In short, if you change strings in your app, they will generate fuzzies for the translators.}}
Line 59:
Line 59:
  Questions about Handbook translation should be sent to the kde-doc-english mailing list.   Questions about Handbook translation should be sent to the kde-doc-english mailing list.
    
− == Independant Releases == + == Independent Releases ==
    
  If your application is not part of an official KDE release cycle (e.g. it is in KDE Extra Gear or in an outside repository altogether), it will be up to you to plan releases and coordinate with the translation teams. When you want to do a release, send an email to the kde-i18n-doc mailing list with the following information:   If your application is not part of an official KDE release cycle (e.g. it is in KDE Extra Gear or in an outside repository altogether), it will be up to you to plan releases and coordinate with the translation teams. When you want to do a release, send an email to the kde-i18n-doc mailing list with the following information:
Line 68:
Line 68:
  * Your planned release date.     * Your planned release date.  
    
− You should provide at least 3 weeks or more between the message freeze date and release date - more if your application is large and complex. If your application has a Handbook, you should provide even more time. + You should provide at least 3 weeks between the message freeze date and release date - more if your application is large and complex. If your application has a Handbook, you should provide even more time.
    
  It is a good idea to avoid time periods when KDE or KOffice are in message freeze, since the translators will be very busy at these times.     It is a good idea to avoid time periods when KDE or KOffice are in message freeze, since the translators will be very busy at these times.  



Ilic: Explain how contexts can be added per message in XML files.
2007-10-18T20:29:49Z
Explain how contexts can be added per message in XML files.

				
				
				
				
			
			← Older revision
			Revision as of 20:29, 18 October 2007
			
Line 78:
Line 78:
  Applications in the extragear module have a special procedure for handling translations. When an extragear application becomes stable (mostly at message freeze), the maintainer should copy the application to the appropriate extragear directory in branches/stable/extragear. In addition the whole set of translation template files (.pot) and translation files (.po), including eventual documentation, of the application must be copied to the appropriate places in branches/stable/l10n. This serves as a signal to translators that the application is ready for final translation work in preparation for release.   Applications in the extragear module have a special procedure for handling translations. When an extragear application becomes stable (mostly at message freeze), the maintainer should copy the application to the appropriate extragear directory in branches/stable/extragear. In addition the whole set of translation template files (.pot) and translation files (.po), including eventual documentation, of the application must be copied to the appropriate places in branches/stable/l10n. This serves as a signal to translators that the application is ready for final translation work in preparation for release.
    
− == Translating UI and KCFG files == + == Translating UI, RC, and KCFG files ==
    
− User visible strings usually origin not only from code files, but also from two other type of files, ui and kcfg files. UI files are the user interface descriptions, which are edited using QtDesigner. Here the text of labels and other ui elements are in need of localized versions. The KCFG files are the configuration data descriptions, which are used to automatically create configuration control code. While that is not related to the user interface, the same KCFG files are also used as the base for the generic runtime editing with [http://extragear.kde.org/apps/kconfigeditor/ KConfigEditor], so the parameter descriptions also need localized versions. + User visible strings usually origin not only from code files, but also from three other file types, ui, rc and kcfg files. UI files are the user interface descriptions, which are edited using QtDesigner. Here the text of labels and other ui elements are in need of localized versions. Likewise for the RC files, which are KXmlGui interface descriptions for embedded components. The KCFG files are the configuration data descriptions, which are used to automatically create configuration control code. While that is not related to the user interface, the same KCFG files are also used as the base for the generic runtime editing with [http://extragear.kde.org/apps/kconfigeditor/ KConfigEditor], so the parameter descriptions also need localized versions.
    
  The strings are handled by the translation system by having them extracted by a program called extractrc, which creates a temporary code file that is than simply included by gettext. So extend the messages target in Makefile.am this way:   The strings are handled by the translation system by having them extracted by a program called extractrc, which creates a temporary code file that is than simply included by gettext. So extend the messages target in Makefile.am this way:
Line 87:
Line 87:
        $(EXTRACTRC) */*.kcfg >> rc.cpp         $(EXTRACTRC) */*.kcfg >> rc.cpp
        $(EXTRACTRC) */*.ui >> rc.cpp         $(EXTRACTRC) */*.ui >> rc.cpp
  +      $(EXTRACTRC) */*.rc >> rc.cpp
        $(XGETTEXT) rc.cpp */*.cpp */*.h -o $(podir)/my_program.pot         $(XGETTEXT) rc.cpp */*.cpp */*.h -o $(podir)/my_program.pot
    
− If there are strings translators need context information for, the only option currently is to add a parameter to the call to extractrc, so the context info is added to all strings extracted from the file. Example: + If there are strings translators need context information for, they can be supplied via <tt>context</tt> attribute in RC and KCFG files:
  +  
  +  <text context="Create new cup of tea">&amp;New...</text>
  +  <label context="Fancy for mixture">Concoction</label>
  +  <whatsthis context="A concoction">Not entirely unlike tea</whatsthis>
  +  
  + and in QtDesigner as the comment property to text labels (which become <tt>comment</tt> attributes in the UI file itself).
  +  
  + Also, if that is more suitable, a parameter can be added to the call to extractrc by which the same context is provided to all strings extracted from the file. Example:
    
    messages: rc.cpp     messages: rc.cpp
        $(EXTRACTRC) --context=my_context my_config.kcfg >> rc.cpp         $(EXTRACTRC) --context=my_context my_config.kcfg >> rc.cpp
        $(EXTRACTRC) --context=other_context */*.ui >> rc.cpp         $(EXTRACTRC) --context=other_context */*.ui >> rc.cpp
  +      $(EXTRACTRC) --context=and_some_more */*.rc >> rc.cpp
        $(XGETTEXT) rc.cpp */*.cpp */*.h -o $(podir)/my_program.pot         $(XGETTEXT) rc.cpp */*.cpp */*.h -o $(podir)/my_program.pot
−  
− Adding context information directly in the files is not supported currently.  
− This includes the comment option for text in UI files. And KCFG files are not prepared at all for this.  
    
  == Translating Data ==   == Translating Data ==



Tampakrap: /* Independant Releases */ missing space
2007-09-09T09:40:13Z
‎Independant Releases:  missing space

				
				
				
				
			
			← Older revision
			Revision as of 09:40, 9 September 2007
			
Line 65:
Line 65:
  * The name of your application and its repository location.     * The name of your application and its repository location.  
  * Your planned message freeze date, the date after which you will not make any more changes that affect i18n strings.     * Your planned message freeze date, the date after which you will not make any more changes that affect i18n strings.  
− * Your planned code freeze date,the date after which no more changes except for severe bug fixes will be made.   + * Your planned code freeze date, the date after which no more changes except for severe bug fixes will be made.  
  * Your planned release date.     * Your planned release date.

← Older revision		Revision as of 12:49, 13 July 2012
Line 1:		Line 1:
−	~~{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Localization/i18n Challenges}}~~

	{{TutorialBrowser\|		{{TutorialBrowser\|

← Older revision		Revision as of 13:37, 5 April 2009
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Localization/i18n Challenges}}
		+
	{{TutorialBrowser\|		{{TutorialBrowser\|