Improve whispeak plugin docs - refs BT#14921

chamilo · Oct 8, 2018 · 15d9bbd · 15d9bbd
1 parent 8e1fe57
commit 15d9bbd
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 3 deletions.
diff --git a/plugin/whispeakauth/README.md b/plugin/whispeakauth/README.md
@@ -0,0 +1,7 @@
+# Speech authentication with Whispeak
+
+Instructions:
+1. Install plugin in Chamilo.
+2. Set the plugin configuration with the token and API url. And enable the plugin.
+3. Set the `login_bottom` region to the plugin. 
+4. Add `$_configuration['whispeak_auth_enabled'] = true;` to `configuration.php` file.
diff --git a/plugin/whispeakauth/WhispeakAuthPlugin.php b/plugin/whispeakauth/WhispeakAuthPlugin.php
@@ -13,6 +13,7 @@ class WhispeakAuthPlugin extends Plugin
     const SETTING_ENABLE = 'enable';
     const SETTING_API_URL = 'api_url';
     const SETTING_TOKEN = 'token';
+    const SETTING_INSTRUCTION = 'instruction';
 
     const EXTRAFIELD_AUTH_UID = 'whispeak_auth_uid';
 
@@ -28,8 +29,7 @@ protected function __construct()
                 self::SETTING_ENABLE => 'boolean',
                 self::SETTING_API_URL => 'text',
                 self::SETTING_TOKEN => 'text',
-                '<p>Add <code>$_configuration[\'whispeak_auth_enabled\'] = true;</code> '.
-                    'in <code>configuration.php</code> file</p>' => 'html',
+                self::SETTING_INSTRUCTION => 'html',
             ]
         );
     }

diff --git a/plugin/whispeakauth/lang/english.php b/plugin/whispeakauth/lang/english.php
@@ -2,6 +2,14 @@
 /* For licensing terms, see /license.txt */
 
 $strings['plugin_title'] = 'Speech authentication with Whispeak';
+$strings['plugin_comment'] = 'Allow speech authentication in Chamilo.';
+
+$strings['enable'] = 'Enable';
+$strings['api_url'] = 'API URL';
+$strings['api_url_help'] = 'http://api.whispeak.io:8080/v1/';
+$strings['token'] = 'API key';
+$strings['instruction'] = '<p>Add <code>$_configuration[\'whispeak_auth_enabled\'] = true;</code>'.
+    'in the <code>configuration.php</code> file</p>';
 
 $strings['EnrollmentSampleText'] = 'The famous Mona Lisa painting was painted by Leonardo Da Vinci.';
 
@@ -11,5 +19,5 @@
 $strings['EnrollmentFailed'] = 'Enrollment failed.';
 $strings['EnrollmentSuccess'] = 'Enrollment success.';
 $strings['AuthentifyFailed'] = 'Login failed.';
-$strings['AuthentifySuccess'] = '¡Authentication success!';
+$strings['AuthentifySuccess'] = 'Authentication success!';
 $strings['TryAgain'] = 'Try again';
diff --git a/plugin/whispeakauth/lang/spanish.php b/plugin/whispeakauth/lang/spanish.php
@@ -2,7 +2,22 @@
 /* For licensing terms, see /license.txt */
 
 $strings['plugin_title'] = 'Authenticación de voz con Whispeak';
+$strings['plugin_comment'] = 'Permitir autenticación de voz en Chamilo.';
+
+$strings['enable'] = 'Habilitar';
+$strings['api_url'] = 'URL del API';
+$strings['api_url_help'] = 'http://api.whispeak.io:8080/v1/';
+$strings['token'] = 'Llave del API';
+$strings['instruction'] = '<p>Agrega <code>$_configuration[\'whispeak_auth_enabled\'] = true;</code>'.
+    'al archivo <code>configuration.php</code></p>';
 
 $strings['EnrollmentSampleText'] = 'El famoso cuadro de Mona Lisa fue pintado por Leonardo Da Vinci.';
 
 $strings['RepeatThisPhrase'] = 'Repita esta frase tres veces después de permitir la grabación de audio:';
+
+$strings['SpeechAuthentication'] = 'Atenticación con voz';
+$strings['EnrollmentFailed'] = 'Inscripción fallida.';
+$strings['EnrollmentSuccess'] = 'Inscripción correcta.';
+$strings['AuthentifyFailed'] = 'Inicio de sesión fallido.';
+$strings['AuthentifySuccess'] = '¡Autenticación correcta!';
+$strings['TryAgain'] = 'Intente de nuevo.';