diff --git a/README.md b/README.md index 2830fc250692e749ab07d49e8e98ab40adac7595..75de4444aae721eb1c7e2e1a23de9e5b00a9eb59 100644 --- a/README.md +++ b/README.md @@ -1,47 +1,69 @@ -# Block Groups : Moodle - Mahara - -This Moodle plugin create group(s) in Mahara, based on Moodle course users. You can either create one Mahara group per Moodle course user groups. - -## Authors - -- Vrignaud Camille *(cvrignaud@softia.fr)* -- Lebeau Michaël *(mlebeau@softia.fr)* -- Thomas Fradet *(thomas.fradet@univ-lorraine.fr)* - -## Compatibility and support - -The plugin was tested in Moodle 3.3, 3.4 and 3.5. - -For more information contact : support_git@softia.fr or iena-contact@univ-lorraine.fr. - -## Installation - -The plugin installs with the classical way but require a specific configuration to link moodle and mahara. - -Installation : - -- Trough the Moodle Administration section "Plugin" -> Add plugin -- Add block in edit mode - -Configuration : - -??? - -## Functionalities - -By clicking a button in this block, editing teachers can create one mahara group within every student enrolled in the moodle course will become members of the mahara group. Moodle course enrolled users with the role of "teacher" and "editingteacher" will have the role of "admin" in the mahara group, other will be simple members. - -After group creation, every user enrolled in this moodle cours will be able to see and click a button witch grand access to the mahara group previously created. - -Alternatively, if they are user groups within the moodle cours, teacher can choose to create one mahara group per moodle course group. In this case, students and teachers will be enroll in the mahara group witch correspond to they moodle group. Warning : if one user is in two groups in moodle course, only the first will be considerated by this plugin to grand access to mahara group. - -Usecase : place 3 groups with 1 teacher and n students in a moodle course and create in one click 3 mahara groups where each teacher will be able to administrate his mahara group and each student will be able to access the right group in mahara, based on the moodle group. - -## Warning - -This plugin is currently under development. - -This plugin does not support groupments (moodle group of group) in addition to the creation of a mahara group for each moodle group. If you have groupments in moodle, choose to create on mahara group for all the moodle course participants or place the groupes in groupment 0. - -In the case of generating one mahara group for each moodle group, if one user is in two groups in moodle course, only the first will be considerated by this plugin to grand access to mahara group. - +# Bloc Connecteur Mahara iENA + +Ce plugin est un bloc de cours qui permet de lier un cours Moodle à un groupe sur une plateforme Mahara, avec les participants du cours. + +This plugin is a block that provide a link between a Moodle course and a Mahara group, with course participants. + +## Auteurs + +- Vrignaud Camille <cvrignaud@softia.fr> +- Lebeau Michaël <mlebeau@softia.fr> +- Thomas Fradet <thomas.fradet@univ-lorraine.fr> + +## Compatibility + +MOODLE 3.5 + +Stabilité : expérimental. + +## Contribution + +Contributors are welcom ! Please contact <iena-contact@univ-lorraine.fr>. + +## Contact + +Pour assistance interne (Univesité de Lorraine) : <https://helpdesk.univ-lorraine.fr>. + +Pour tout autre question : <iena-contact@univ-lorraine.fr>. + +Other : <iena-contact@univ-lorraine.fr>. + +## Activation et paramétrage + +__Documentation à préciser : __ +- création du user mahara avec les bons droits pour l'api +- paramétrage du plugin dans moodle + +## Fonctionnalités + +L'enseignant peut activer le bloc et lier un cours à un groupe Mahara. Les étudiants pourront accéder au groupe Mahara en un clic. Si le cours Moodle comporte des groupes, alors un groupe Mahara peut être créé pour chaque groupe Moodle du cours. Attention, ce choix doit être fait à l'activation et est définitif. Il n'est pas possible de lier à un cours Moodle un groupe existant. + +La connexion, l'éventuelle création de compte utilisateur et la création de groupe sur Mahara est prise en charge par le plugin. Le lien entre les deux plateformes doit préalablement exister (paramétrage préalable). + +Usecase : place 3 groups with 1 teacher and n students in a moodle course and create in one click 3 mahara groups where each teacher will be able to administrate his mahara group and each student will be able to access the right group in mahara, based on the moodle group. + +--- + +By clicking a button in this block, editing teachers can create one mahara group within every student enrolled in the moodle course will become members of the mahara group. Moodle course enrolled users with the role of "teacher" and "editingteacher" will have the role of "admin" in the mahara group, other will be simple members. + +After group creation, every user enrolled in this moodle cours will be able to see and click a button witch grand access to the mahara group previously created. + +Alternatively, if they are user groups within the moodle cours, teacher can choose to create one mahara group per moodle course group. In this case, students and teachers will be enroll in the mahara group witch correspond to they moodle group. + +Usecase : place 3 groups with 1 teacher and n students in a moodle course and create in one click 3 mahara groups where each teacher will be able to administrate his mahara group and each student will be able to access the right group in mahara, based on the moodle group. + +## Problèmes connus + +- Un groupe mahara existant ne peut être lié au cours. +- Si le bloc est activé pour lier un seul groupe Mahara pour ce cours, il n'est plus possible par la suite d'en lier un par groupe Moodle (et vice-versa). +- Créer tous les groupes de force inscrit l'enseignant qui active cette fonctionnalité dans tous les groupes. +- Lorsque le groupe n'existe pas encore, il est créé, mais la redirection finale à l'issue de la création mène vers une page d'erreur (même si la création et l'inscription fonctionnent. ) +- Les groupements ne sont pas supportés, ne les utilisez pas avec ce plugin. Seuls les groupes sans groupement sont pris en compte. + +## Amélioration à effectuer + +- Liaison d'un groupe Mahara existant au cours +- Pré-création de tous les groupes Mahara liés au cours en un clic sans inscription de l'enseignant dans tous ces groupes +- Inscription de l'enseignant dans tous les groupes en un clic +- Management des groupes Mahara liés au cours (liaison d'un groupe Mahara existant à un groupe du cours ou au cours, suppression d'un groupe Mahara préalablement lié au cours) +- Passage possible du mode un groupe Mahara pour tout le cours Moodle à un groupe Mahara par groupe Moodle et vice-versa.