i18n of the plugin (english & french for now)

README.md

@@ -1,6 +1,9 @@
 # Description
 This plugin allows users to subscribe to pads and receive email updates when a pad is being modified.  You can modify the frequency.  This plugin is very much in alpha stage and has a lot of things TODO (See TODO).
 
+# Source code
+On Github : https://github.com/JohnMcLear/ep_email_notifications
+
 # Installation
 Make sure an SMTP gateway is installed IE postfix
 Configure SPF and RDNS records to ensure proper mail flow <-- Search online
@@ -26,6 +29,11 @@ NOTE: You will NOT receive an email if you(the author that registered their emai
   }
 ```
 
+# Translation
+This plugin has for now an english and french translation.
+In case you would like to have it in another language, you can easily translate the few sentences and then contact us on irc (#etherpad-lite-dev on irc.freenode.net) or create a Pull-Request on the GitHub repository.
+You can find the sentences to translate in the ep_email_notifications/locales/ directory.
+
 # TODO
 * Clean up all code
 

static/js/ep_email.js

@@ -10,9 +10,9 @@ exports.postAceInit = function(hook, context){
   if (typeof clientVars.panelDisplayLocation != "object") {
     $.gritter.add({
       // (string | mandatory) the heading of the notification
-      title: "Email subscription error",
+      title: window._('ep_email_notifications.titleGritterError'),
       // (string | mandatory) the text inside the notification
-      text: "Some settings for the 'email_Notifications' plugin are missing.<br />Please contact your administrator.",
+      text: window._('ep_email_notifications.msgParamsMissing'),
       // (int | optional) the time you want it to be alive for before fading out
       time: 10000,
     });
@@ -150,9 +150,9 @@ function askClientToEnterEmail(){
 
   $.gritter.add({
     // (string | mandatory) the heading of the notification
-    title: "Email subscription",
+    title: window._('ep_email_notifications.titleGritterSubscr'),
     // (string | mandatory) the text inside the notification
-    text: "<p>(Receive an email when someone modifies this pad)</p>" + formContent,
+    text: "<p>" + window._('ep_email_notifications.headerGritterSubscr') + "</p>" + formContent,
     // (bool | optional) if you want it to fade out on its own or just sit there
     sticky: true,
     // (int | optional) the time you want it to be alive for before fading out
@@ -195,9 +195,9 @@ function checkAndSend(e) {
       && !$('#' + formName + ' [name=ep_email_onEnd]').is(':checked')) {
     $.gritter.add({
       // (string | mandatory) the heading of the notification
-      title: "Email subscription error",
+      title: window._('ep_email_notifications.titleGritterError'),
       // (string | mandatory) the text inside the notification
-      text: "You need to check at least one of the two options from 'Send a mail when someone..'"
+      text: window._('ep_email_notifications.msgOptionsNotChecked')
     });
   } else if (email) {
     $('#' + formName).submit();
@@ -253,9 +253,9 @@ Manage return msgs from server
 function showRegistrationSuccess(){
   $.gritter.add({
     // (string | mandatory) the heading of the notification
-    title: "Email subscription",
+    title: window._('ep_email_notifications.titleGritterSubscr'),
     // (string | mandatory) the text inside the notification
-    text: "An email was sent to your address.<br />Click on the link in order to validate your subscription.",
+    text: window._('ep_email_notifications.msgSubscrSuccess'),
     // (int | optional) the time you want it to be alive for before fading out
     time: 10000
   });
@@ -266,19 +266,19 @@ function showRegistrationSuccess(){
  */
 function showAlreadyRegistered(type){
   if (type == "malformedEmail") {
-    var msg = "The email address is malformed";
+    var msg = window._('ep_email_notifications.msgEmailMalformed');
   } else if (type == "alreadyRegistered") {
-    var msg = "You are already registered for emails for this pad";
+    var msg = window._('ep_email_notifications.msgAlreadySubscr');
   } else {
-    var msg = "Unknown error";
+    var msg = window._('ep_email_notifications.msgUnknownErr');
   }
   $.gritter.add({
     // (string | mandatory) the heading of the notification
-    title: "Email subscription",
+    title: window._('ep_email_notifications.titleGritterSubscr'),
     // (string | mandatory) the text inside the notification
     text: msg,
-    // (bool | optional) if you want it to fade out on its own or just sit there
-    sticky: false
+    // (int | optional) the time you want it to be alive for before fading out
+    time: 7000
   });
 
 }
@@ -289,9 +289,9 @@ function showAlreadyRegistered(type){
 function showUnregistrationSuccess(){
   $.gritter.add({
     // (string | mandatory) the heading of the notification
-    title: "Email unsubscription",
+    title: window._('ep_email_notifications.titleGritterUnsubscr'),
     // (string | mandatory) the text inside the notification
-    text: "An email was sent to your address.<br />Click on the link in order to validate your unsubscription.",
+    text: window._('ep_email_notifications.msgUnsubscrSuccess'),
     // (int | optional) the time you want it to be alive for before fading out
     time: 10000
   });
@@ -303,11 +303,11 @@ function showUnregistrationSuccess(){
 function showWasNotRegistered(){
   $.gritter.add({
     // (string | mandatory) the heading of the notification
-    title: "Email unsubscription",
+    title: window._('ep_email_notifications.titleGritterUnsubscr'),
     // (string | mandatory) the text inside the notification
-    text: "This email address is not registered for this pad",
-    // (bool | optional) if you want it to fade out on its own or just sit there
-    sticky: false
+    text: window._('ep_email_notifications.msgUnsubscrNotExisting'),
+    // (int | optional) the time you want it to be alive for before fading out
+    time: 7000
   });
 
 }

templates/email_notifications_settings.ejs

@@ -1,21 +1,21 @@
 <p>
   <input type="checkbox" id="options-emailNotifications"></input>
-  <label for="options-emailNotifications">Email Notifications</label>
+  <label for="options-emailNotifications" data-l10n-id="ep_email_notifications.menuLabel"></label>
   <div class="ep_email_settings">
     <form id='ep_email_form_mysettings'>
       <input name='ep_email' class='ep_email_input' placeholder='your@email.com' type=email>
       <br />
-      <label>Send a mail when someone..</label>
+      <label data-l10n-id="ep_email_notifications.formOptionsTitle"></label>
       <br />
       <input name='ep_email_onStart' type="checkbox" class="ep_email_checkbox"></input>
-      <label for="ep_email_onStart">starts editing the pad</label>
+      <label for="ep_email_onStart" data-l10n-id="ep_email_notifications.formOptionOnStart"></label>
       <br />
       <input name='ep_email_onEnd' type="checkbox" class="ep_email_checkbox"></input>
-      <label for="ep_email_onEnd">finish editing the pad</label>
+      <label for="ep_email_onEnd" data-l10n-id="ep_email_notifications.formOptionOnEnd"></label>
       <input name='ep_email_option' type=hidden >
       <br />
-      <input name='ep_email_subscribe' type=button class="ep_email_buttons" value=subscribe>
-      <input name='ep_email_unsubscribe'type=button class="ep_email_buttons" value=unsubscribe>
+      <button name='ep_email_subscribe' type=button class="ep_email_buttons" data-l10n-id="ep_email_notifications.formBtnSubscr"></button>
+      <button name='ep_email_unsubscribe'type=button class="ep_email_buttons" data-l10n-id="ep_email_notifications.formBtnUnsubscr"></button>
     </form>
   </div>
 </p>