From 6f6be22df1928ffeb4017818788be6688271e76c Mon Sep 17 00:00:00 2001
From: Yannick Warnier <ywarnier@beeznest.org>
Date: Wed, 18 Jan 2023 17:48:18 +0100
Subject: [PATCH] Plugin: Exercise Signature: Improve documentation

---
 plugin/exercise_signature/README.md        | 16 +++++++++++++++-
 plugin/exercise_signature/lang/english.php |  2 +-
 plugin/exercise_signature/lang/french.php  |  2 +-
 plugin/exercise_signature/lang/spanish.php |  2 +-
 4 files changed, 18 insertions(+), 4 deletions(-)

diff --git a/plugin/exercise_signature/README.md b/plugin/exercise_signature/README.md
index e59f9c520d..2664c08e3e 100644
--- a/plugin/exercise_signature/README.md
+++ b/plugin/exercise_signature/README.md
@@ -1 +1,15 @@
-Students can sign exercise results.
\ No newline at end of file
+# Exercises signature
+
+This plugin allows the teacher to check a box in any exercise configuration to request a signature from the user at the end of the exercise attempt.
+
+A modal window, a bit like a mini-whiteboard, will then appear to students asking them to sign. The signature can be done through the mouse (unpractical), through a touch device (ideal with tablets) or through a touch-sensitive laptop screen.
+
+Teachers will see the signature when they review the attempt details.
+
+## Installation
+
+This plugin creates extra fields for exercises automatically.
+
+Signatures are saved as a drawing in the database.
+
+Uninstalling this plugin will remove the extra fields, so all signatures will disappear (instantly) if you uninstall this. Consider using the "disable" option inside the plugin configuration instead.
\ No newline at end of file
diff --git a/plugin/exercise_signature/lang/english.php b/plugin/exercise_signature/lang/english.php
index 5340962ae1..5dc0bb89c4 100644
--- a/plugin/exercise_signature/lang/english.php
+++ b/plugin/exercise_signature/lang/english.php
@@ -4,7 +4,7 @@
 
 // Needed in order to show the plugin title
 $strings['plugin_title'] = "Exercise signature";
-$strings['plugin_comment'] = "";
+$strings['plugin_comment'] = "Add the possibility for teachers to ask for a signature at the end of any exam attempt. The signature request is made through a modal window with a whiteboard-style area that works in touch mode, and teachers can later check (manually) the signature attached to the attempt.";
 $strings['tool_enable'] = 'Tool enabled';
 $strings['ProvideASignatureFirst'] = 'Please provide a signature first';
 $strings['Sign'] = 'Sign';
diff --git a/plugin/exercise_signature/lang/french.php b/plugin/exercise_signature/lang/french.php
index 0938308fdc..1cf1616698 100644
--- a/plugin/exercise_signature/lang/french.php
+++ b/plugin/exercise_signature/lang/french.php
@@ -4,7 +4,7 @@
 
 // Needed in order to show the plugin title
 $strings['plugin_title'] = "Exercice signature";
-$strings['plugin_comment'] = "";
+$strings['plugin_comment'] = "Ajoute la possibilité pour l'enseignant de demander une signature en fin d'examen. La signature est possible au travers d'une fenêtre modale de type tableau blanc qui fonctionne en mode 'touch'. L'enseignant peut ensuite visualiser la signature associée à chaque tentative.";
 $strings['tool_enable'] = 'Activer le plugin';
 $strings['Sign'] = 'Signer';
 $strings['ProvideASignatureFirst'] = "Veuillez d'abord fournir une signature";
diff --git a/plugin/exercise_signature/lang/spanish.php b/plugin/exercise_signature/lang/spanish.php
index 991a29cde6..7c8faff187 100644
--- a/plugin/exercise_signature/lang/spanish.php
+++ b/plugin/exercise_signature/lang/spanish.php
@@ -4,7 +4,7 @@
 
 // Needed in order to show the plugin title
 $strings['plugin_title'] = "Exercise signature";
-$strings['plugin_comment'] = "";
+$strings['plugin_comment'] = "Agrega la posiblidad para los profesores de solicitar una firma al fin de cada intento de examen. La firma se hace a través de una ventana modal tipo pizarra blanca que funciona en modo 'touch'. El profesor puede luego revisar la firma asociada con cada intento.";
 $strings['tool_enable'] = 'Activar plugin';
 $strings['Sign'] = 'Firmar';
 $strings['ProvideASignatureFirst'] = "Primero ingrese una firma";