diff --git a/docs/ModuleAssiduites.md b/docs/ModuleAssiduites.md new file mode 100644 index 00000000..280b0198 --- /dev/null +++ b/docs/ModuleAssiduites.md @@ -0,0 +1,50 @@ +## Module "Assiduités" + +Ce module de ScoDoc a pour but de remplacer le module d'Absences présent dans Scodoc. +En plus de moderniser l'ancien module, le module assiduités met à disposition une api complète. + +Ce projet a été développé en 2022-2023, par Matthias Hartmann, apprenti de l'IUT de +Lannion financé par l'Association ScoDoc. + +[Vidéo de présentation du module d'assiduités ](#) + +## Fonctionnalités + +Le module, intégrée à ScoDoc, fournit pour l'instant: + +- Gestion des absences/présences/retard +- Précision des saisies (périodes déterminées par une heure de début et une heure de fin au lieu de demi-journées) +- Gestion et sauvegarde de justificatifs numériques. +- API complète + +## Guide d'utilisation + +- [Personnalisation du module](#personnalisation-du-module) + +### Personnalisation du module + +Le module possède deux types de configuration, une générale et une par département/semestre. + +**La configuration générale permet de configurer la ligne temporelle visible sur certaines pages de saisie d'assiduités.** + +![Configuration de l'assiduité : Général](screens/config_assiduites_gen.png) + +- `Début de la journée` : l'heure de début de la ligne temporelle (par défaut : 8h00) +- `L'heure de midi` : l'heure pivot qui sépare la matinée de l'après-midi (par défaut : 13h00) +- `Fin de la journée` : l'heure de fin de la ligne temporelle (par défaut : 18h00) +- `Granularité` : La granularité de la ligne temporelle. (par défaut : 15 min) + +**La configuration par département/semestre permet de configurer certaines actions liés à l'assiduité** + +![Configuration de l'assiduité : département](screens/config_assiduites_dept.png) + +- `Forcer la déclaration du module` : Forcer les utilisateurs de ScoDoc à renseigner le module à chaque saisie d'assiduités. +- `Forcer l'appel des présents` : Force les utilisateurs à noter les présences/absences/retard lors d'une saisie. +- `Durée par défaut d'un créneau` : Détermine la durée classique d'un cours. (Ce sera la période préenregistrée sur la ligne temporelle) +- `Définir l'état par défaut` : Défini l'état par défaut qui sera appliqué aux étudiants avant validation d'une saisie d'assiduité. +- `Jours non travaillés` : Défini les jours sur lesquels la saisie d'assiduités ne sera pas possible. +- `Métrique de l'assiduité` : Défini l'unité de l'assiduité qui sera utilisé par les autres modules de ScoDoc. + - `1/2 J.` : Demi-Journée + - `J.` : Journées + - `H.` : Heures + diff --git a/docs/screens/config_assiduites_dept.png b/docs/screens/config_assiduites_dept.png new file mode 100644 index 00000000..dde58f86 Binary files /dev/null and b/docs/screens/config_assiduites_dept.png differ diff --git a/docs/screens/config_assiduites_gen.png b/docs/screens/config_assiduites_gen.png new file mode 100644 index 00000000..87b45d8f Binary files /dev/null and b/docs/screens/config_assiduites_gen.png differ diff --git a/mkdocs.yml b/mkdocs.yml index c117353e..fb73d5dc 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -62,6 +62,8 @@ extra_javascript: - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js markdown_extensions: + - toc: + permalink: true - admonition - pymdownx.details - pymdownx.arithmatex: