mirrors/zotero
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

Localized plural form support for Zotero.getString()

Browse source 
Zotero.getString() now takes a third parameter, `num` (which should also
appear in `params`) to use when determining which plural form of the
string to use. Localized strings should include all forms in the order
specified in [1], separated by semicolons.

[1] https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_and_Plurals
This commit is contained in:
Dan Stillman 2016-12-10 17:07:37 -05:00
parent 9836f33d41
commit c61a9dc5f3
2 changed files with 45 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

29
chrome/content/zotero/xpcom/zotero.js
View file

@ -28,6 +28,7 @@ Components.utils.import("resource://zotero/config.js");
Components.utils.import("resource://gre/modules/XPCOMUtils.jsm"); Components.utils.import("resource://gre/modules/XPCOMUtils.jsm");
Components.utils.import("resource://gre/modules/Services.jsm"); Components.utils.import("resource://gre/modules/Services.jsm");
Components.utils.import("resource://gre/modules/osfile.jsm"); Components.utils.import("resource://gre/modules/osfile.jsm");
Components.utils.import("resource://gre/modules/PluralForm.jsm");
/* /*
* Core functions * Core functions
@ -39,7 +40,6 @@ Components.utils.import("resource://gre/modules/osfile.jsm");
this.log = log; this.log = log;
this.logError = logError; this.logError = logError;
this.getErrors = getErrors; this.getErrors = getErrors;
this.getString = getString;
this.localeJoin = localeJoin; this.localeJoin = localeJoin;
this.setFontSize = setFontSize; this.setFontSize = setFontSize;
this.flattenArguments = flattenArguments; this.flattenArguments = flattenArguments;
@ -245,6 +245,9 @@ Components.utils.import("resource://gre/modules/osfile.jsm");
_localizedStringBundle = Services.strings.createBundle( _localizedStringBundle = Services.strings.createBundle(
"chrome://zotero/locale/zotero.properties", appLocale); "chrome://zotero/locale/zotero.properties", appLocale);
// Fix logged error in PluralForm.jsm when numForms() is called before get(), as it is in
// getString() when a number is based
PluralForm.get(1, '1;2;3;4;5;6;7;8;9;10;11;12;13;14;15;16')
// Also load the brand as appName // Also load the brand as appName
var brandBundle = Services.strings.createBundle( var brandBundle = Services.strings.createBundle(
@ -1174,9 +1177,17 @@ Components.utils.import("resource://gre/modules/osfile.jsm");
return deferred.promise; return deferred.promise;
}); });
function getString(name, params){ /**
* @param {String} name
* @param {String[]} [params=[]] - Strings to substitute for placeholders
* @param {Number} [num] - Number (also appearing in `params`) to use when determining which plural
* form of the string to use; localized strings should include all forms in the order specified
* in https://developer.mozilla.org/en-US/docs/Mozilla/Localization/Localization_and_Plurals,
* separated by semicolons
*/
this.getString = function (name, params, num) {
try { try {
if (params != undefined){ if (params != undefined) {
if (typeof params != 'object'){ if (typeof params != 'object'){
params = [params]; params = [params];
} }
@ -1185,6 +1196,18 @@ Components.utils.import("resource://gre/modules/osfile.jsm");
else { else {
var l10n = _localizedStringBundle.GetStringFromName(name); var l10n = _localizedStringBundle.GetStringFromName(name);
} }
if (num !== undefined) {
let availableForms = l10n.split(/;/);
// If not enough available forms, use last one -- PluralForm.get() uses first by
// default, but it's more likely that a localizer will translate the two English
// strings with some plural form as the second one, so we might as well use that
if (availableForms.length < PluralForm.numForms()) {
l10n = availableForms[availableForms.length - 1];
}
else {
l10n = PluralForm.get(num, l10n);
}
}
} }
catch (e){ catch (e){
if (e.name == 'NS_ERROR_ILLEGAL_VALUE') { if (e.name == 'NS_ERROR_ILLEGAL_VALUE') {

19
test/tests/zoteroTest.js Normal file
View file

@ -0,0 +1,19 @@
"use strict";
describe("Zotero", function() {
describe("#getString()", function () {
it("should return the right plural form", function* () {
if (Zotero.locale != 'en-US') {
this.skip();
}
Components.utils.import("resource://gre/modules/PluralForm.jsm");
var str1 = Zotero.getString('fileInterface.importItemsWereImported')
.split(/;/)[1]
.replace('%1$S', 2);
var str2 = Zotero.getString('fileInterface.importItemsWereImported', 2, 2);
Zotero.debug(str1);
Zotero.debug(str2);
assert.equal(str1, str2);
});
});
});