Development/Tutorials/Localization/i18n Mistakes - Revision history

AnneW at 12:48, 13 July 2012

2012-07-13T12:48:10Z

Icwiener: Fix syntax hightlighting.

2011-06-27T16:47:20Z

Fix syntax hightlighting.

Centerlink: Adding more specific instructions for developers.

2009-10-28T18:25:58Z

Adding more specific instructions for developers.

Tampakrap: I see four pitfalls, not three

2008-12-14T12:42:00Z

I see four pitfalls, not three

Chris: + pitfall #4, see the bug filed against Amarok for the Chinese example

2008-07-24T20:07:56Z

+ pitfall #4, see the bug filed against Amarok for the Chinese example

Tampakrap: /* Pitfall #1: Pixel Based Layouts */

2007-12-27T20:05:38Z

‎Pitfall #1: Pixel Based Layouts

Dhaumann: /* Pitfall #1: Pixel Based Layouts */

2007-12-21T14:05:08Z

‎Pitfall #1: Pixel Based Layouts

DrSlowDecay: Added language navigation

2007-12-21T13:53:10Z

Added language navigation

Pippin: /* Pitfall #3: Lack of Unicode Support */ make the sentence actually make sense

2007-07-03T17:36:55Z

‎Pitfall #3: Lack of Unicode Support: make the sentence actually make sense

Aseigo: new bit on markup, remove some scrollbars

2007-02-14T22:37:33Z

new bit on markup, remove some scrollbars

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

	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 30: / Line 30: @@
 Another thing to be aware of is to not concatenate pieces of sentences together like this:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 QString msg=i18n("Do you want to replace ") +
                   oldFile+i18n(" with ") +
-                  newFile + "?"</code>
+                  newFile + "?"
 Such "word puzzles" are very hard or even impossible to translate. This is because the structure of the sentence will often be completely different in another language and thus must be controlled by the translator. When the order of words and phrases is hard-coded as in the above example, the translator can not create a proper translation.
@@ Line 43: / Line 44: @@
 The above example written properly would then look like this:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 QString msg = i18n("Do you want to replace %1 with %2?",
-                    oldFile, newFile)</code>
+                    oldFile, newFile)
 It would be even better, if you wrote it more explictly:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 QString msg = i18n("Do you want to replace file %1 with file %2?",
-                    oldFile, newFile)</code>
+                    oldFile, newFile)
 Or another way is to write a comment prior to sentence like this:
-<code cppqt>
+<syntaxhighlight lang="cpp-qt">
 /* TRANSLATORS: Replacing an old file (%1) with a new one (%2). */
 QString msg = i18n("Do you want to replace %1 with %2?",
-                    oldFile, newFile)</code>
+                    oldFile, newFile)
 {{note|Avoid inserting anything other than numbers or nouns with this method, since in some languages the translation depends on the inserted words. It is therefore best to create strings that are as complete sentences as possible.}}
@@ Line 72: / Line 76: @@
 Whenever there is source code that handles strings using a datatype (such as <tt>char</tt>) or class (such as <tt>std::string</tt>) that can not handle Unicode, translations will break.
-To avoid this, never call QString::latin1() or QString::ascii() on translated strings. This also applies to information resulting from user input such as passwords, URLs and filenames. If you really need a plain <tt>char*</tt> representation of a string, it is better to use QString::utf8().
+To avoid this, never call <tt>QString::latin1()</tt> or <tt>QString::ascii()</tt> on translated strings. This also applies to information resulting from user input such as passwords, URLs and filenames. If you really need a plain <tt>char*</tt> representation of a string, it is better to use <tt>QString::utf8()</tt>.
 {{note|For more information on character sets and Unicode, see the [[Development/Tutorials/Localization/Unicode|Unicode tutorial]].}}
-KIO slaves may also provide paths and file names encoded using UTF-8. It is up to the programmer, however, to take care of passing properly encoded filenames to any KIO method in question. The correct way to do this is not to guess at user's filesystem encoding but to use QFile::encodeName() and QFile::decodeName() instead.
+KIO slaves may also provide paths and file names encoded using UTF-8. It is up to the programmer, however, to take care of passing properly encoded filenames to any KIO method in question. The correct way to do this is not to guess at user's filesystem encoding but to use <tt>QFile::encodeName()</tt> and <tt>QFile::decodeName()</tt> instead.
-{{tip|You can turn KIO's UTF-8 file name support on for testing by exporting the KDE_UTF8_FILENAMES environment variable in your shell's startup file (e.g. ~/.bashrc).}}
+{{tip|You can turn KIO's UTF-8 file name support on for testing by exporting the KDE_UTF8_FILENAMES environment variable in your shell's startup file (e.g. <tt>~/.bashrc</tt>).}}
 == Pitfall #4: Complex Text Flow ==

@@ Line 44: / Line 44: @@
 <code cppqt>
 QString msg = i18n("Do you want to replace %1 with %2?",
                     oldFile, newFile)</code>

@@ Line 73: / Line 73: @@
 == Success! ==
-If you avoid the three common categories of pitfalls detailed in this tutorial, your application should be fully localizable by the various KDE translation teams around the world and open up your application to the majority of people on the planet.
+If you avoid the four common categories of pitfalls detailed in this tutorial, your application should be fully localizable by the various KDE translation teams around the world and open up your application to the majority of people on the planet.
 [[Category:Programming]]

← Older revision		Revision as of 20:07, 24 July 2008
Line 66:		Line 66:

	{{tip\|You can turn KIO's UTF-8 file name support on for testing by exporting the KDE_UTF8_FILENAMES environment variable in your shell's startup file (e.g. ~/.bashrc).}}		{{tip\|You can turn KIO's UTF-8 file name support on for testing by exporting the KDE_UTF8_FILENAMES environment variable in your shell's startup file (e.g. ~/.bashrc).}}
		+
		+	== Pitfall #4: Complex Text Flow ==
		+
		+	When designing an application that needs non-standard text flow, don't assume that the same rules apply for all languages. Given vertical writing as an example East-Asian languages using Chinese characters have a long history of vertical writing, even longer then horizontal. Strings are not rotated by 90 degrees but instead single characters are placed under one another. There might be just a different behaviour with different scripts. Expect the need to implement specialised versions.

	== Success! ==		== Success! ==

@@ Line 20: / Line 20: @@
 == Pitfall #1: Pixel Based Layouts ==
-English text is often very compact compared to other languages where the translated text is often substantially longer. Therefore the interface much be able to adjust size to accommodate the length of translations provided at runtime. If it can't do this, then messages will end up misaligned and truncated.
+English text is often very compact compared to other languages where the translated text is often substantially longer. Therefore the interface must be able to adjust size to accommodate the length of translations provided at runtime. If it can't do this, then messages will end up misaligned and truncated.
 The answer is to use layout managers. Qt provides a number of such layout managers pre-made for you. They include <tt>QHBoxLayout</tt>, <tt>QVBoxLayout</tt>, <tt>QGridLayout</tt> and <tt>QStackedLayout</tt>, all of which are subclasses of <tt>QLayout</tt>. You may also create your own <tt>QLayout</tt> based classes, but this is generally not needed.

@@ Line 24: / Line 24: @@
 The answer is to use layout managers. Qt provides a number of such layout managers pre-made for you. They include <tt>QHBoxLayout</tt>, <tt>QVBoxLayout</tt>, <tt>QGridLayout</tt> and <tt>QStackedLayout</tt>, all of which are subclasses of <tt>QLayout</tt>. You may also create your own <tt>QLayout</tt> based classes, but this is generally not needed.
-These layout classes manage the pixel positioning of widgets for you at runtime, so no matter what the size of the translated strings your interface will adjust properly. For more information look at the documentation for [[http://doc.trolltech.com/qlayout.html QLayout]].
+These layout classes manage the pixel positioning of widgets for you at runtime, so no matter what the size of the translated strings your interface will adjust properly. For more information look at the documentation for {{qt|QLayout}}.
 == Pitfall #2: Word Puzzles ==

← Older revision		Revision as of 13:53, 21 December 2007
Line 1:		Line 1:
		+	{{Template:I18n/Language Navigation Bar\|Development/Tutorials/Localization/i18n Mistakes}}
		+
	{{TutorialBrowser\|		{{TutorialBrowser\|

@@ Line 55: / Line 55: @@
 == Pitfall #3: Lack of Unicode Support ==
-Whenever there is source code that handles strings which does not use a datatype (such as <tt>char</tt>) or class (such as <tt>std::string</tt>) that can not handle Unicode, translations will break.
+Whenever there is source code that handles strings using a datatype (such as <tt>char</tt>) or class (such as <tt>std::string</tt>) that can not handle Unicode, translations will break.
 To avoid this, never call QString::latin1() or QString::ascii() on translated strings. This also applies to information resulting from user input such as passwords, URLs and filenames. If you really need a plain <tt>char*</tt> representation of a string, it is better to use QString::utf8().