Merge pull request #115 from victorsalaun/issue/#107

add documentation link

Author: thomaslhostis

src/app/hesperides/hesperides.js

@@ -110,18 +110,21 @@ hesperidesModule.run(function (editableOptions, editableThemes, $rootScope, $htt
 
     $rootScope.setHesperidesConfiguration = function () {
 
-        if (hesperidesConfiguration == undefined) {
+        if (hesperidesConfiguration === undefined) {
             console.warn("[Hesperides] Config file not found or empty, applying default configuration");
             hesperidesConfiguration = {};
         }
 
-        if (hesperidesConfiguration.nexusMode == undefined) {
+        if (hesperidesConfiguration.documentationLink === undefined) {
+            hesperidesConfiguration.documentationLink = "https://voyages-sncf-technologies.github.io/hesperides-gui/";
+        }
+        if (hesperidesConfiguration.nexusMode === undefined) {
             hesperidesConfiguration.nexusMode = false;
         }
-        if (hesperidesConfiguration.localChangesTTL == undefined) {
+        if (hesperidesConfiguration.localChangesTTL === undefined) {
             hesperidesConfiguration.localChangesTTL = 50;
         }
-        if (hesperidesConfiguration.feedbackRoomName == undefined) {
+        if (hesperidesConfiguration.feedbackRoomName === undefined) {
             hesperidesConfiguration.feedbackRoomName = "";
         }
     }

src/app/i18n/label_en.json

@@ -1,6 +1,6 @@
 {
-  "hesperides.date" : "{{  timestamp | date : 'MMMM d yyyy h:mm a' }}",
-  "welcome.apps.title" : "Preferred applications",
+  "hesperides.date": "{{  timestamp | date : 'MMMM d yyyy h:mm a' }}",
+  "welcome.apps.title": "Preferred applications",
   "menu.template.title": "Regroup templates",
   "menu.techno.title": "By techno",
   "menu.techno.create": "Create a working copy",
@@ -12,11 +12,12 @@
   "menu.platform.title": "For applications",
   "menu.platform.create": "Create a platform",
   "menu.platform.createFrom": "Create a platform from...",
-  "menu.language.fr.aria" : "View the website in french",
-  "menu.language.en.aria" : "View the website in english",
-  "menu.help.title": "Help",
-  "menu.help.swagger": "Swagger",
+  "menu.language.fr.aria": "View the website in french",
+  "menu.language.en.aria": "View the website in english",
   "menu.help.about": "About",
+  "menu.help.documentation": "Documentation",
+  "menu.help.swagger": "Swagger",
+  "menu.help.title": "Help",
   "event.nocomment": "No comment",
   "template.event.created": "The template has been created",
   "template.event.updated": "The template has been updated",
@@ -239,8 +240,8 @@
   "file.modal.title": "Preview of",
   "file.modal.error": "This file is in error state, click to see what is going on.",
   "file.modal.content": "File content",
-  "file.error" : "Error !",
-  "file.loading.message" : "Waiting the file to load ...",
+  "file.error": "Error !",
+  "file.loading.message": "Waiting the file to load ...",
   "event.modal.title": "History of",
   "event.modal.title.noHistory": "History is empty",
   "event.modal.filtering.findInEvents": "Filter events",
@@ -249,10 +250,10 @@
   "event.modal.filtering.user.placeholder": "Filter by username",
   "event.modal.filtering.myevents": "My events",
   "event.modal.diff": "Show the diff",
-  "about.title":"About the release",
-  "about.version.backend":"Backend version:",
-  "about.version.api":"API version:",
-  "about.version.front":"Front version:",
+  "about.title": "About the release",
+  "about.version.backend": "Backend version:",
+  "about.version.api": "API version:",
+  "about.version.front": "Front version:",
   "settings.title": "User settings",
   "settings.introduction": "This screen helps you to personalize Hesperides (by web browser)",
   "settings.display": "Displaying the logic platforme's components",

src/app/i18n/label_fr.json

@@ -1,6 +1,6 @@
 {
-  "hesperides.date" : "{{ timestamp | date : 'd MMMM yyyy HH:mm' }}",
-  "welcome.apps.title" : "Applications préférées",
+  "hesperides.date": "{{ timestamp | date : 'd MMMM yyyy HH:mm' }}",
+  "welcome.apps.title": "Applications préférées",
   "menu.template.title": "Regrouper des templates",
   "menu.techno.title": "En techno",
   "menu.techno.create": "Créer une working copy",
@@ -12,11 +12,12 @@
   "menu.platform.title": "Pour des applications",
   "menu.platform.create": "Créer une plateforme",
   "menu.platform.createFrom": "Créer une plateforme à partir de...",
-  "menu.language.fr.aria" : "Visualiser le site en français",
-  "menu.language.en.aria" : "Visualiser le site en anglais",
-  "menu.help.title": "Aide",
-  "menu.help.swagger": "Swagger",
+  "menu.language.fr.aria": "Visualiser le site en français",
+  "menu.language.en.aria": "Visualiser le site en anglais",
   "menu.help.about": "A propos",
+  "menu.help.documentation": "Documentation",
+  "menu.help.swagger": "Swagger",
+  "menu.help.title": "Aide",
   "event.nocomment": "Pas de commentaire",
   "template.event.created": "Le template a bien été créé",
   "template.event.updated": "Le template a été mis à jour",
@@ -239,8 +240,8 @@
   "file.modal.title": "Prévisualisation de",
   "file.modal.error": "Ce fichier est en erreur, cliquer pour voir pourquoi.",
   "file.modal.content": "Contenu du fichier",
-  "file.error" : "Erreur !",
-  "file.loading.message" : "En attente de chargement...",
+  "file.error": "Erreur !",
+  "file.loading.message": "En attente de chargement...",
   "event.modal.title": "Historique de",
   "event.modal.title.noHistory": "Aucun historique à afficher",
   "event.modal.filtering.findInEvents": "Filtrer l'historique",
@@ -249,10 +250,10 @@
   "event.modal.filtering.user.placeholder": "Filtrer par nom de user",
   "event.modal.filtering.myevents": "Mon historique",
   "event.modal.diff": "Voir la diff",
-  "about.title":"A propos de la release",
-  "about.version.backend":"Version du backend :",
-  "about.version.api":"Version de l'API :",
-  "about.version.front":"Version du front :",
+  "about.title": "A propos de la release",
+  "about.version.backend": "Version du backend :",
+  "about.version.api": "Version de l'API :",
+  "about.version.front": "Version du front :",
   "settings.title": "Préférences de l'utilisateur",
   "settings.introduction": "Cet écran vous permet de personnaliser certains comportements d'hesperides (à setter par navigateur)",
   "settings.display": "Affichage des composants logiques d'une plateforme",

src/app/menu/menu.html

@@ -158,6 +158,11 @@
                             {{ 'menu.help.swagger' | translate}}
                         </md-button>
                     </md-menu-item>
+                    <md-menu-item>
+                        <md-button id="menu_help-documentation-menu" ng-click="display_hesperides_documentation()">
+                            {{ 'menu.help.documentation' | translate}}
+                        </md-button>
+                    </md-menu-item>
                     <md-menu-item>
                         <md-button id="menu_help-about-menu" ng-click="display_hesperides_informations()">
                             {{ 'menu.help.about' | translate}}

src/app/menu/menu.js

@@ -374,6 +374,10 @@ menuModule.controller('MenuHelpCtrl', ['$scope', '$mdDialog', '$hesperidesHttp',
         });
      };
 
+     $scope.display_hesperides_documentation = function() {
+         window.open(hesperidesConfiguration.documentationLink);
+     };
+
     $scope.display_hesperides_informations = function(){
 
         $scope.front_version = '${project.version}';