Changes between Version 55 and Version 56 of Notifications


Ignore:
Timestamp:
Dec 11, 2009, 11:17:30 AM (14 years ago)
Author:
romw
Comment:

Move the section on server message localization to feed localization

Legend:

Unmodified
Added
Removed
Modified
  • Notifications

    v55 v56  
    7070 * Provides a mechanism to display localizable server messages within the user interface.
    7171
     72=== Localization ===
     73Items being passed to the manager by way of the server scheduler or core client will now be identified by a item identifier.  The item identifier will be appended to the of the project's master url and we used as the item's GUID.
     74
     75Item identifier rules:
     76 * Item identifiers start at 1.
     77 * Item identifiers should not be removed from the item list and cannot be removed if no longer used.
     78 * Items should be enclosed in the _("Test Message") macro syntax.
     79 * Item parameters are enclosed in ‘{}’ braces with an index to the position in which the parameter should replace the marker.
     80
     81When new items 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.
     82
     83A string in need of localization would look like this:
     84{{{
     85_("This client needs {1} of additional memory. {2} detected in total.")
     86}}}
     87
     88After translation it could look like this:
     89{{{
     90_("Your computer has {2} of total detected memory, but the client needs an additional {1} in order to be assigned work.")
     91}}}
     92
     93The client software should replace the positional markers with the optional parameter values specified for the message.
     94
    7295== Feed List ==
    7396The feed list is published to the client software as part of the client parse-able project preferences.
     
    128151A better strategy, using the same schema, is to issue a feeler query that’ll return hints as to which batch queries to issue.  Each positive hint will cause a new query to be issued that uses a join to merge all notification records of a certain type with the details of that type.
    129152
    130 For instance if a volunteer has 50 private messages the current scheme would result in a minimum of 51 queries issued against the database, the proposed scheme should result in 2 queries against the database.
    131 
    132 Things get progressively worse the more engaged the volunteer is, 50 private messages and 10 threads being watched would result in 61 queries issued in the current scheme, while only 3 queries would be issued in the proposed scheme.
     153For instance if a volunteer has 50 private messages the current scheme would result in a minimum of 51 queries issued against the database, the proposed scheme should result in 2 queries against the database. Things get progressively worse the more engaged the volunteer is, 50 private messages and 10 threads being watched would result in 61 queries issued in the current scheme, while only 3 queries would be issued in the proposed scheme.
    133154
    134155It is also important to note that the effect of the numbers increase in proportion to the number of machines attached to the project.
     
    178199}}}
    179200
    180 === Localizing Server Messages ===
    181 Messages being passed to the client by way of the server will now be identified by a message identifier. 
    182 
    183 Message identifier rules:
    184  * Message identifiers start at 1.
    185  * Message identifiers should not be removed from the message list and cannot be removed if no longer used.
    186  * Messages should be enclosed in the _("Test Message") macro syntax.
    187  * Message parameters are enclosed in ‘{}’ braces with an index to the position in which the parameter should replace the marker.
    188 
    189 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.
    190 
    191 A string in need of localization would look like this:
    192 {{{
    193 _("This client needs {1} of additional memory. {2} detected in total.")
    194 }}}
    195 
    196 After translation it could look like this:
    197 {{{
    198 _("Your computer has {2} of total detected memory, but the client needs an additional {1} in order to be assigned work.")
    199 }}}
    200 
    201 The client software should replace the positional markers with the optional parameter values specified for the message.
    202 
    203201== BOINC Project Website ==
    204202A project’s website is the main focal point for adding and removing notification feeds.