Changes between Version 21 and Version 22 of Notifications

Timestamp:

Nov 3, 2009, 12:05:46 PM (14 years ago)

Author:

romw

Comment:

Add localizing server messages section

Notifications

@@ -104 +104 @@
     </item>
     <item>
-        <description>I need more memory</description>
+        <description>I need more memory ({1} MB)</description>
         <pubDate>Sun, 29 Sep 2002 19:59:01 GMT</pubDate>
         <guid>http://www.example.com/2</guid>
+        <parameter1>64</parameter1>
     </item>
 </channel>
@@ -117 +118 @@
 || pubDate || <scheduler reply time> || RFC 822 representation of the scheduler reply time ||
 || guid || <null> || Unique message ID prefixed with the master URL of the project ||
+|| param_1 || <null> || Optional parameter for the item description ||
+|| param_2 || <null> || Optional parameter for the item description ||
+|| param_3 || <null> || Optional parameter for the item description ||
+|| param_4 || <null> || Optional parameter for the item description ||
+|| param_5 || <null> || Optional parameter for the item description ||
 
 '''NOTE''': While on face value the inclusion of the GUID to the BOINC client stream might seem overkill, it serves two important purposes.
  * It can be used to prevent duplication messages from the same project from appearing in the project list across multiple scheduler requests.
  * Provides a mechanism to display localizable server messages within the client software.
+
+=== Localizing Server Messages ===
+Messages being passed to the client by way of the server will now be identified by a message identifier.  
+
+Message identifier rules:
+ * Message identifiers start at 1.
+ * Message identifiers should not be removed from the message list and cannot be removed if no longer used.
+ * Messages should be enclosed in the _(“Test Message”) macro syntax.
+ * Message parameters are enclosed in ‘{}‘ braces with an index to the position in which the parameter should replace the marker.
+
+When new messages are added poEdit or some other string extraction tool should be used to update the BOINC-Server-Messages.pot template file.  After the localization process has been completed the resulting BOINC-Server-Messages.mo file should be shipped with the client software.
+
+A string in need of localization would look like this:
+{{{
+_(“This client needs {1} of additional memory. {2} detected in total.”)
+}}}
+
+After translation it could look like this:
+{{{
+_(“Your computer has {2} of total detected memory, but the client needs an additional {1} in order to be assigned work.”)
+}}}
+
+The client software should replace the positional markers with the optional parameter values specified for the message.
 
 == Project Website ==