From 57c9a13e1f0ed4e8492467bda817b3385be33225 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?G=C3=A1bor=20Hojtsy?= Date: Fri, 8 Jun 2007 12:51:59 +0000 Subject: #118026 by kkaefer with fixes from myself: JavaScript translation support and script.js as a default theme JS file to use, if found --- misc/autocomplete.js | 2 +- misc/drupal.js | 158 ++++++++++++++++++++++++++++++++++++++++++++++++++- misc/progress.js | 2 +- misc/tableselect.js | 9 +-- misc/teaser.js | 8 +-- misc/upload.js | 4 +- 6 files changed, 169 insertions(+), 14 deletions(-) (limited to 'misc') diff --git a/misc/autocomplete.js b/misc/autocomplete.js index fc0e96b2c..2431d37e4 100644 --- a/misc/autocomplete.js +++ b/misc/autocomplete.js @@ -282,7 +282,7 @@ Drupal.ACDB.prototype.search = function (searchString) { } }, error: function (xmlhttp) { - alert('An HTTP error '+ xmlhttp.status +' occured.\n'+ db.uri); + alert(Drupal.t("An HTTP error @status occured. \n@uri", { '@status': xmlhttp.status, '@uri': db.uri })); } }); }, this.delay); diff --git a/misc/drupal.js b/misc/drupal.js index dc527240d..98441c7ec 100644 --- a/misc/drupal.js +++ b/misc/drupal.js @@ -1,6 +1,6 @@ // $Id$ -var Drupal = Drupal || {}; +var Drupal = Drupal || { 'settings': {}, 'themes': {}, 'locale': {} }; /** * Set the variable that indicates if JavaScript behaviors should be applied @@ -21,6 +21,142 @@ Drupal.extend = function(obj) { } }; +/** + * Encode special characters in a plain-text string for display as HTML. + */ +Drupal.checkPlain = function(str) { + str = String(str); + var replace = { '&': '&', '"': '"', '<': '<', '>': '>' }; + for (var character in replace) { + str = str.replace(character, replace[character]); + } + return str; +}; + +/** + * Translate strings to the page language or a given language. + * + * See the documentation of the server-side t() function for further details. + * + * @param str + * A string containing the English string to translate. + * @param args + * An object of replacements pairs to make after translation. Incidences + * of any key in this array are replaced with the corresponding value. + * Based on the first character of the key, the value is escaped and/or themed: + * - !variable: inserted as is + * - @variable: escape plain text to HTML (Drupal.checkPlain) + * - %variable: escape text and theme as a placeholder for user-submitted + * content (checkPlain + Drupal.theme('placeholder')) + * @return + * The translated string. + */ +Drupal.t = function(str, args) { + // Fetch the localized version of the string. + if (Drupal.locale.strings && Drupal.locale.strings[str]) { + str = Drupal.locale.strings[str]; + } + + if (args) { + // Transform arguments before inserting them + for (var key in args) { + switch (key.charAt(0)) { + // Escaped only + case '@': + args[key] = Drupal.checkPlain(args[key]); + break; + // Pass-through + case '!': + break; + // Escaped and placeholder + case '%': + default: + args[key] = Drupal.theme('placeholder', args[key]); + break; + } + str = str.replace(key, args[key]); + } + } + return str; +}; + +/** + * Format a string containing a count of items. + * + * This function ensures that the string is pluralized correctly. Since Drupal.t() is + * called by this function, make sure not to pass already-localized strings to it. + * + * See the documentation of the server-side format_plural() function for further details. + * + * @param count + * The item count to display. + * @param singular + * The string for the singular case. Please make sure it is clear this is + * singular, to ease translation (e.g. use "1 new comment" instead of "1 new"). + * Do not use @count in the singular string. + * @param plural + * The string for the plural case. Please make sure it is clear this is plural, + * to ease translation. Use @count in place of the item count, as in "@count + * new comments". + * @param args + * An object of replacements pairs to make after translation. Incidences + * of any key in this array are replaced with the corresponding value. + * Based on the first character of the key, the value is escaped and/or themed: + * - !variable: inserted as is + * - @variable: escape plain text to HTML (Drupal.checkPlain) + * - %variable: escape text and theme as a placeholder for user-submitted + * content (checkPlain + Drupal.theme('placeholder')) + * Note that you do not need to include @count in this array. + * This replacement is done automatically for the plural case. + * @return + * A translated string. + */ +Drupal.formatPlural = function(count, singular, plural, args) { + var args = ars || {}; + args['@count'] = count; + // Determine the index of the plural form. + var index = Drupal.locale.pluralFormula ? Drupal.locale.pluralFormula(args['@count']) : ((args['@count'] == 1) ? 0 : 1); + + if (index == 0) { + return Drupal.t(singular, args); + } + else if (index == 1) { + return Drupal.t(plural, args); + } + else { + args['@count['+ index +']'] = args['@count']; + delete args['@count']; + return Drupal.t(plural.replace('@count', '@count['+ index +']')); + } +}; + +/** + * Generate the themed representation of a Drupal object. + * + * All requests for themed output must go through this function. It examines + * the request and routes it to the appropriate theme function. If the current + * theme does not provide an override function, the generic theme function is + * called. + * + * For example, to retrieve the HTML that is output by theme_placeholder(text), + * call Drupal.theme('placeholder', text). + * + * @param func + * The name of the theme function to call. + * @param ... + * Additional arguments to pass along to the theme function. + * @return + * Any data the theme function returns. This could be a plain HTML string, + * but also a complex object. + */ +Drupal.theme = function(func) { + for (var i = 1, args = []; i < arguments.length; i++) { + args.push(arguments[i]); + } + + return (Drupal.theme[func] || Drupal.theme.prototype[func]).apply(this, args); +}; + /** * Redirects a button's form submission to a hidden iframe and displays the result * in a given wrapper. The iframe should contain a call to @@ -126,7 +262,7 @@ Drupal.mousePosition = function(e) { */ Drupal.parseJson = function (data) { if ((data.substring(0, 1) != '{') && (data.substring(0, 1) != '[')) { - return { status: 0, data: data.length ? data : 'Unspecified error' }; + return { status: 0, data: data.length ? data : Drupal.t('Unspecified error') }; } return eval('(' + data + ');'); }; @@ -227,3 +363,21 @@ if (Drupal.jsEnabled) { // 'js enabled' cookie document.cookie = 'has_js=1'; } + +/** + * The default themes. + */ +Drupal.theme.prototype = { + + /** + * Formats text for emphasized display in a placeholder inside a sentence. + * + * @param str + * The text to format (plain-text). + * @return + * The formatted text (html). + */ + placeholder: function(str) { + return '' + Drupal.checkPlain(str) + ''; + } +}; diff --git a/misc/progress.js b/misc/progress.js index e9e07ee48..c693fafad 100644 --- a/misc/progress.js +++ b/misc/progress.js @@ -86,7 +86,7 @@ Drupal.progressBar.prototype.sendPing = function () { pb.timer = setTimeout(function() { pb.sendPing(); }, pb.delay); }, error: function (xmlhttp) { - pb.displayError('An HTTP error '+ xmlhttp.status +' occured.\n'+ pb.uri); + pb.displayError(Drupal.t("An HTTP error @status occured. \n@uri", { '@status': xmlhttp.status, '@uri': pb.uri })); } }); } diff --git a/misc/tableselect.js b/misc/tableselect.js index 5020f7931..5c0cfbb32 100644 --- a/misc/tableselect.js +++ b/misc/tableselect.js @@ -2,10 +2,11 @@ Drupal.tableSelect = function() { // Keep track of the table, which checkbox is checked and alias the settings. - var table = this, selectAll, checkboxes, lastChecked, settings = Drupal.settings.tableSelect; + var table = this, selectAll, checkboxes, lastChecked; + var strings = { 'selectAll': Drupal.t('Select all rows in this table'), 'selectNone': Drupal.t('Deselect all rows in this table') }; // Store the select all checkbox in a variable as we need it quite often. - selectAll = $('').attr('title', settings.selectAll).click(function() { + selectAll = $('').attr('title', strings.selectAll).click(function() { // Loop through all checkboxes and set their state to the select all checkbox' state. checkboxes.each(function() { this.checked = selectAll[0].checked; @@ -13,7 +14,7 @@ Drupal.tableSelect = function() { $(this).parents('tr:first')[ this.checked ? 'addClass' : 'removeClass' ]('selected'); }); // Update the title and the state of the check all box. - selectAll.attr('title', selectAll[0].checked ? settings.selectNone : settings.selectAll); + selectAll.attr('title', selectAll[0].checked ? strings.selectNone : strings.selectAll); }); // Find all with class select-all, and insert the check all checkbox. @@ -35,7 +36,7 @@ Drupal.tableSelect = function() { // If all checkboxes are checked, make sure the select-all one is checked too, otherwise keep unchecked. selectAll[0].checked = (checkboxes.length == $(checkboxes).filter(':checked').length); // Set the title to the current action. - selectAll.attr('title', selectAll[0].checked ? settings.selectNone : settings.selectAll); + selectAll.attr('title', selectAll[0].checked ? strings.selectNone : strings.selectAll); // Keep track of the last checked checkbox. lastChecked = e.target; diff --git a/misc/teaser.js b/misc/teaser.js index eeb847305..d515d1f71 100644 --- a/misc/teaser.js +++ b/misc/teaser.js @@ -29,7 +29,7 @@ Drupal.teaserAttach = function() { $(teaser).attr('disabled', 'disabled'); $(teaser).parent().slideUp('fast'); // Change label - $(this).val(Drupal.settings.teaserButton[1]); + $(this).val(Drupal.t('Split summary at cursor')); // Show separate teaser checkbox $(checkbox).hide(); } @@ -48,7 +48,7 @@ Drupal.teaserAttach = function() { $(teaser).attr('disabled', ''); $(teaser).parent().slideDown('fast'); // Change label - $(this).val(Drupal.settings.teaserButton[0]); + $(this).val(Drupal.t('Join summary')); // Show separate teaser checkbox $(checkbox).show(); } @@ -64,11 +64,11 @@ Drupal.teaserAttach = function() { teaser[0].value = trim(text[0]); body[0].value = trim(text[1]); $(teaser).attr('disabled', ''); - $('input', button).val(Drupal.settings.teaserButton[0]).toggle(join_teaser, split_teaser); + $('input', button).val(Drupal.t('Join summary')).toggle(join_teaser, split_teaser); } else { $(teaser).hide(); - $('input', button).val(Drupal.settings.teaserButton[1]).toggle(split_teaser, join_teaser); + $('input', button).val(Drupal.t('Split summary at cursor')).toggle(split_teaser, join_teaser); $(checkbox).hide(); } diff --git a/misc/upload.js b/misc/upload.js index bcc1e6acc..900d979ec 100644 --- a/misc/upload.js +++ b/misc/upload.js @@ -33,7 +33,7 @@ Drupal.jsUpload = function(uri, button, wrapper, hide) { Drupal.jsUpload.prototype.onsubmit = function () { // Insert progressbar and stretch to take the same space. this.progress = new Drupal.progressBar('uploadprogress'); - this.progress.setProgress(-1, 'Uploading file'); + this.progress.setProgress(-1, Drupal.t('Uploading file')); var hide = this.hide; var el = this.progress.element; @@ -98,7 +98,7 @@ Drupal.jsUpload.prototype.oncomplete = function (data) { * Handler for the form redirection error. */ Drupal.jsUpload.prototype.onerror = function (error) { - alert('An error occurred:\n\n'+ error); + alert(Drupal.t('An error occurred:\n\n@error', { '@error': error })); // Remove progressbar $(this.progress.element).remove(); this.progress = null; -- cgit v1.2.3