Automatic extraction of translatable strings using xgettext possible.…

… It uses the new stellarium-remotecontrol domain. Strings that are already present in the stellarium domain are automatically excluded, if possible, to reduce duplication issues.

Translations now use PHP-style tags, i.e. <?= tr("Translation") ?>, this allows xgettext support.
Translations support optional placeholder arguments (  <?= tr("This %1 will be", "replaced") ?> )
Translation from JS code using the Main.tr method. This requires converting the xgettext-extracted strings to JS file which can then be used as a template to be filled with translated values by the server. The conversion is done by a python script through the RemoteControl-update-translationdata target.
Made JS code pass JSHint validation

data/webroot/actions.js

@@ -1,6 +1,8 @@
-"use strict";
 
-var Actions = (new function ($) {
+
+var Actions = (function ($) {
+    "use strict";
+
     //Private variables
     var $actionlist;
     var actionsInitialized = false;
@@ -63,7 +65,7 @@ var Actions = (new function ($) {
             var id = e.options[e.selectedIndex].value;
 
             Actions.execute(id);
-        }
+        };
 
         $actionlist.change(function () {
             $("#bt_doaction").prop("disabled", false);
@@ -170,9 +172,9 @@ var Actions = (new function ($) {
             },
             error: function (xhr, status, errorThrown) {
                 console.log("Error updating action list");
-                console.log("Error: " + errorThrown);
+                console.log("Error: " + errorThrown.message);
                 console.log("Status: " + status);
-                alert("Could not retrieve action list")
+                alert(Main.tr("Could not retrieve action list"));
             }
         });
     }
@@ -205,9 +207,9 @@ var Actions = (new function ($) {
             },
             error: function (xhr, status, errorThrown) {
                 console.log("Error posting action " + actionName);
-                console.log("Error: " + errorThrown);
+                console.log("Error: " + errorThrown.message);
                 console.log("Status: " + status);
-                alert("Could not call server")
+                alert(Main.tr("Error sending action to server: ") + errorThrown.message);
             }
         });
     }
@@ -292,5 +294,5 @@ var Actions = (new function ($) {
 
         //Connects all checkbox input elements below this container to the StelAction that corresponds to its value
         connectActionContainer: connectActionContainer
-    }
-}(jQuery));
+    };
+})(jQuery);

data/webroot/location.js

@@ -1,6 +1,6 @@
-"use strict";
+var Locations = (function($) {
+    "use strict";
 
-var Locations = (new function($) {
     //Private variables
     var $loc_mapimg;
     var $loc_mappointer;
@@ -73,7 +73,7 @@ var Locations = (new function($) {
             editMode = false;
         });
 
-        scope = "input.ui-spinner-input"
+        scope = "input.ui-spinner-input";
         $("#loc_inputs").on("spin", scope, function(evt, ui) {
             var field = $(this).data("field");
             queueData(field,ui.value);
@@ -149,7 +149,7 @@ var Locations = (new function($) {
                     var op = document.createElement("option");
                     op.innerHTML = data[i];
                     $loc_list[0].appendChild(op);
-                };
+                }
 
                 parent.prepend($loc_list);
 
@@ -158,9 +158,9 @@ var Locations = (new function($) {
             },
             error: function(xhr, status, errorThrown) {
                 console.log("Error updating location list");
-                console.log("Error: " + errorThrown);
+                console.log("Error: " + errorThrown.message);
                 console.log("Status: " + status);
-                alert("Could not retrieve location list");
+                alert(Main.tr("Could not retrieve location list"));
             }
         });
     }
@@ -193,15 +193,15 @@ var Locations = (new function($) {
                     op.innerHTML = data[i].name_i18n; //translated
                     op.value = data[i].name;
                     $loc_country[0].appendChild(op);
-                };
+                }
 
                 parent.append($loc_country);
             },
             error: function(xhr, status, errorThrown) {
                 console.log("Error updating country list");
-                console.log("Error: " + errorThrown);
+                console.log("Error: " + errorThrown.message);
                 console.log("Status: " + status);
-                alert("Could not retrieve country list");
+                alert(Main.tr("Could not retrieve country list"));
             }
         });
     }
@@ -223,15 +223,15 @@ var Locations = (new function($) {
                     op.innerHTML = data[i].name_i18n; //translated
                     op.value = data[i].name;
                     $loc_planet[0].appendChild(op);
-                };
+                }
 
                 parent.append($loc_planet);
             },
             error: function(xhr, status, errorThrown) {
                 console.log("Error updating planet list");
                 console.log("Error: " + errorThrown);
                 console.log("Status: " + status);
-                alert("Could not retrieve planet list");
+                alert(Main.tr("Could not retrieve planet list"));
             }
         });
     }
@@ -296,5 +296,5 @@ var Locations = (new function($) {
                 movePointer(loc.latitude, loc.longitude);
             }
         }
-    }
-}(jQuery));
+    };
+})(jQuery);

data/webroot/remotecontrol.js

@@ -1,22 +1,25 @@
-"use strict";
+/* jshint expr: true */
 
-var UISettings = (new function($) {
+var UISettings = (function() {
+    "use strict";
+
+    var data = {};
 
     // Automatically poll the server for updates? Otherwise, only updated after commands are sent.
-    this.updatePoll = true;
+    data.updatePoll = true;
     //the interval for automatic polling
-    this.updateInterval = 1000;
+    data.updateInterval = 1000;
     //use the Browser's requestAnimationFrame for animation instead of setTimeout
-    this.useAnimationFrame = true;
+    data.useAnimationFrame = true;
     //If animation frame is not used, this is the delay between 2 animation steps
-    this.animationDelay = 500;
+    data.animationDelay = 500;
     //If no user changes happen after this time, the changes are sent to the Server
-    this.editUpdateDelay = 500;
+    data.editUpdateDelay = 500;
     //This is the delay after which the AJAX request spinner is shown.
-    this.spinnerDelay = 100;
-
+    data.spinnerDelay = 100;
 
-}(jQuery));
+    return data;
+})();
 
 //DOM-ready hook, starting the GUI
 $(document).ready(function() {
@@ -38,7 +41,9 @@ $(window).load(function() {
 });
 
 // The main functionality including communication with the server
-var Main = (new function($) {
+var Main = (function($) {
+    "use strict";
+
     //Private variables
     var connectionLost = false;
     var animationSupported;
@@ -53,6 +58,15 @@ var Main = (new function($) {
 
     var sel_infostring;
 
+    /* Translates a string using Stellariums current locale. String must be present in translationdata.js */
+    function tr(str) {
+        if(str in TranslationData) {
+            return TranslationData[str];
+        }
+        console.log("Error: string '" +str + "' not present in translation data");
+        return str;
+    }
+
     function animate() {
 
         Time.updateAnimation();
@@ -85,7 +99,7 @@ var Main = (new function($) {
                     sel_infostring.innerHTML = data.selectioninfo;
                     sel_infostring.className = "";
                 } else {
-                    sel_infostring.innerHTML = "No current selection";
+                    sel_infostring.innerHTML = tr("No current selection");
                     sel_infostring.className = "bold";
                 }
 
@@ -144,7 +158,7 @@ var Main = (new function($) {
                     // Firefox wraps long text (possibly a rounding bug)
                     // so we add 1px to avoid the wrapping (#7513)
                     ul.width("").outerWidth() + 1,
-                    this.options.position.of == null ? this.element.outerWidth() : this.options.position.of.outerWidth()
+                    this.options.position.of === null ? this.element.outerWidth() : this.options.position.of.outerWidth()
                 ));
             }
         });
@@ -240,11 +254,11 @@ var Main = (new function($) {
                 }
             }, this));
         }, this), UISettings.editUpdateDelay);
-
     };
 
     //Public stuff
     return {
+        tr: tr,
         init: function() {
             initControls();
 
@@ -261,9 +275,9 @@ var Main = (new function($) {
             animationSupported = (window.requestAnimationFrame !== undefined);
 
             if (!animationSupported) {
-                console.log("animation frame not supported")
+                console.log("animation frame not supported");
             } else {
-                console.log("animation frame supported")
+                console.log("animation frame supported");
             }
             //kick off animation
             animate();
@@ -294,7 +308,7 @@ var Main = (new function($) {
                     console.log("Error posting command " + url);
                     console.log("Error: " + errorThrown);
                     console.log("Status: " + status);
-                    alert("Could not update the server!")
+                    alert(tr("Error sending command to server: ") + errorThrown.message);
                 },
                 complete: completeFunc
             });
@@ -303,15 +317,15 @@ var Main = (new function($) {
         forceUpdate: function() {
             update();
         },
-
         UpdateQueue: UpdateQueue
-
-    }
-}(jQuery));
+    };
+})(jQuery);
 
 
 //some custom controls
 (function($) {
+    "use strict";
+
     $.widget("custom.combobox", {
         _create: function() {
             this.wrapper = $("<span>")
@@ -366,7 +380,7 @@ var Main = (new function($) {
 
             $("<a>")
                 .attr("tabIndex", -1)
-                .attr("title", "Show All Items")
+                .attr("title", Main.tr("Show All Items"))
                 .tooltip()
                 .appendTo(this.wrapper)
                 .button({
@@ -432,7 +446,7 @@ var Main = (new function($) {
             // Remove invalid value
             this.input
                 .val("")
-                .attr("title", value + " didn't match any item")
+                .attr("title", Main.tr("Input did not match any item"))
                 .tooltip("open");
             this.element.val("");
             this._delay(function() {

data/webroot/scripts.js

@@ -1,6 +1,6 @@
-"use strict";
+var Scripts = (function($) {
+    "use strict";
 
-var Scripts = (new function($) {
     //Private variables
     var $activescript;
     var $bt_runscript;
@@ -61,7 +61,7 @@ var Scripts = (new function($) {
                     console.log("Error updating script list");
                     console.log("Error: " + errorThrown);
                     console.log("Status: " + status);
-                    alert("Could not retrieve script list")
+                    alert(Main.tr("Could not retrieve script list"));
                 }
             });
         },
@@ -70,11 +70,11 @@ var Scripts = (new function($) {
             if (script.scriptIsRunning) {
                 $activescript.text(script.runningScriptId);
             } else {
-                $activescript.text("-none-");
+                $activescript.text(Main.tr("-none-"));
             }
             $bt_stopscript.prop({
                 disabled: !script.scriptIsRunning
             });
         }
-    }
-}(jQuery));
+    };
+})(jQuery);