Changes between Version 34 and Version 35 of DevelopersGuide/StyleGuide

Timestamp:

2020-03-01T15:40:44+01:00 (4 years ago)

Author:

Hb---

Comment:

trn(), trc() and translator hints to Internationalization

DevelopersGuide/StyleGuide

@@ -1 +1 @@
 [[TranslatedPages]]
 = Development Guidelines =
+
+[[PageOutline(2-2,Table of content,inline)]]
 
 == How your code should look like ==
@@ -69 +71 @@
  * make sure you use {{{tr(...)}}} for all localized strings
    {{{
+   #!java
    import import static org.openstreetmap.josm.tools.I18n.tr;
 
@@ -82 +85 @@
    }}}
 
-
  * never assemble localized messages with {{{+}}}. Use format
    placeholders instead.
@@ -89 +91 @@
    {{{new JLabel(tr("My Label " + labelId));}}}
 
-
    '''DO'''
    {{{new JLabel(tr("My Label {0}",labelId));}}}
 
    Only exception: {{{+}}} can be used to break long lines of non-variable texts.
+   The placeholders are mandatory in simple translations.
 
- * When using apostrophe, the following rules apply:
+ * When using apostrophe in the source string, it needs to be escaped by another apostrophe (Like backslash in C):[[BR]]
+   {{{#!java
+   new JButton(tr("Don''t press me!"))
+   }}}
 
-   For all {{{tr}}} the apostrophe is special. (Like backslash in C)[[BR]]
-   It needs to be escaped by another apostrophe:
+ * A translation context can be set with trc(...). Additional hints to translators are given by java comments at the function:
+   {{{#!java
+   /* I18n: house number, street as parameter; place number first for visibility */
+   msg = tr("House number {0} at {1}", s, t);
+   }}}
 
-   {{{new JButton(tr("Don''t press me more than {0} times!", n))}}}
+ * Use {{{trn(...)}}} to let translators choose the language specific plural:
+   {{{#!java
+   new JButton(trn(/* I18n: times needed, some name as parameter */ 
+                       "Press {1} {0} times!", n, n, someName))
+   }}}
+
+ In plural segments the placeholders are not mandatory to translators.
+
+ The English singular source string must be given even when a its logically invalid (identification and consistency) :
+   {{{#!java
+   trn("Combine {0} way", "Combine {0} ways", n, n)
+   }}}
 
 ----
-Back to [wiki:/DevelopersGuide Developers Guide]
+Back to [wikitr:/DevelopersGuide Developers Guide]