Changes between Version 14 and Version 15 of Internationalization

Timestamp:

Apr 19, 2014, 12:06:06 PM (10 years ago)

Author:

sanderd17

Comment:

Improve info about translateObjectKeys

Internationalization

@@ -180 +180 @@
 translateObjectKeys(settings.ais, ["name", "description"]);
 }}}
+
+Note that the keys don't have to be top-level keys (the method searches the entire object depth first), and that the object may not have circular references (which is usual when it's only about data objects).
+
+The keys you provide should either be strings in the object that can be translated, or a special object, like shown in the next example.
+{{{
+{
+  translatedString1: "my first message",
+  unTranslatedString1: "some string",
+  ignoredObject: {
+    translatedString2: "my second message",
+    unTranslatedString2: "some string"
+  },
+  translatedObject1: {
+    message: "my third message",
+    context: "message context",
+  },
+  translatedObject2: {
+    list: ["list", "of", "strings"],
+    context: "message context",
+} 
+}}}
+
+It will translate "translatedObject1" using a certain context, and every string in the list of "translatedObject2" also with the same context, after which the list will also be joined with a localised connector (", " in English). So the result could be
+
+{{{
+{
+  translatedString1: "mijn eeste bericht",
+  unTranslatedString1: "some string",
+  ignoredObject: {
+    translatedString2: "mijn tweede bericht",
+    unTranslatedString2: "some string"
+  },
+  translatedObject1: "mijn derde bericht",
+  translatedObject2: "lijst, van, strings",
+} 
+}}}
+