From 6ed0ab6ab7b39e78638fcd6b1ac2e3c9918a1455 Mon Sep 17 00:00:00 2001 From: viennet Date: Thu, 28 Oct 2021 10:23:28 +0200 Subject: [PATCH] modif page API --- docs/BUT.md | 8 ++++---- docs/GuideAdminSys.md | 2 +- docs/GuideDeveloppeurs.md | 2 +- docs/PublicationEtudiants.md | 2 +- docs/ScoDoc9API.md | 4 +++- docs/ScoDocAPI.md | 3 +-- mkdocs.yml | 3 ++- 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/BUT.md b/docs/BUT.md index f0b651f6f..d6163d4bd 100644 --- a/docs/BUT.md +++ b/docs/BUT.md @@ -43,7 +43,7 @@ niveaux) et UEs. ## Calcul des notes -Les rôles des SAÉ et ressources étant symétriques, on appellera dans al suite (et +Les rôles des SAÉ et ressources étant symétriques, on appellera dans la suite (et dans ScoDoc) *module* un objet de type SAÉ _ou_ ressource. Dans la suite, on considère les poids et coefficients toujours positifs ou @@ -80,7 +80,7 @@ réduit d'apprentissages critiques: La note (moyenne) d'un module (SAÉ ou ressource) se calcule à partir de ses évaluations. Chaque évaluation est pondérée, par un poids $p$ est fixé par -l'enseignant. ce poids joue le même rôle que le coefficient d'une évaluation +l'enseignant. Ce poids joue le même rôle que le coefficient d'une évaluation classique, mais peut se décliner en plusieurs valeurs, une par UE associée au module. @@ -96,7 +96,7 @@ une UE $u$ *doit* être non nulle; si ce n'est pas le cas, le module sera décla ### Moyenne de module (SAÉ ou ressource) -La moyenne d'un module est un vecteur, car on a une note moyenne par UE: +La moyenne d'un étudiant dans un module est un vecteur, car on a une note moyenne par UE: $$\mu_{m, u} = \frac{\sum_e p_{e,u} \, n_e}{\sum_{e} \, p_{u,e}}$$ @@ -110,7 +110,7 @@ $$\mu_m = \frac{\sum_e (\sum_u p_{e,u}) \, n_e}{\sum_{u,e} \, p_{u,e}}$$ On va considérer les coefficients de modules et d'évaluations: -$$\mu_u = \frac{1}{\sum_m c_{u,m}} \, \sum_{m \in u} c_{u,m} \, \frac{\sum_e p_{e,u} \, n_e}{\sum_{e} \, p_{u,e}}$$ +$$\mu_u = \frac{1}{\sum_m c_{u,m}} \, \sum_{m \in u} c_{u,m} \, \frac{\sum_e p_{e,u} \, n_e}{\sum_{e} \, p_{e,u}}$$ L'exemple suivant illustre ce mode de calcul: diff --git a/docs/GuideAdminSys.md b/docs/GuideAdminSys.md index ba9cab3e3..4d42fdccb 100644 --- a/docs/GuideAdminSys.md +++ b/docs/GuideAdminSys.md @@ -34,7 +34,7 @@ référer à [GuideInstallDebianDix](GuideInstallDebianDix.md) ou ## Utilisation avancée * [Interfaçage avec Apogée](ScoDocApogee.md) - * [API](ScoDocAPI.md) : API JSON ou XML pour interfaçage avec d'autres applications + * [API](ScoDoc9API.md) : API JSON ou XML pour interfaçage avec d'autres applications * [ServicesXml](ServicesXml.md) : web services XML pour interfaçage avec d'autres applications (obsolète). * [AdminUsers](AdminUsers.md) : gestion des utilisateurs * [InterrogationPortail](InterrogationPortail.md) : liaison avec portail diff --git a/docs/GuideDeveloppeurs.md b/docs/GuideDeveloppeurs.md index 3a0f862f1..673bce593 100644 --- a/docs/GuideDeveloppeurs.md +++ b/docs/GuideDeveloppeurs.md @@ -9,7 +9,7 @@ Informations pour les développeurs souhaitant étendre ou modifier ScoDoc. un serveur Discord ouvert sur invitation aux développeur actifs. Contacter Emmanuel. * [Générer de nouveaux formats de bulletins PDF](ApiGenerationBulletinsPdf.md) * [Créer de nouveaux types de "parcours"](ApiCreationParcours.md) - * [API](ScoDocAPI.md) : API JSON ou XML pour interfaçage avec d'autres applications + * [API](ScoDoc9API.md) : API JSON ou XML pour interfaçage avec d'autres applications * Notes diverses * [Discussions pour la future gestion des absences](IdeesGestionAbsences.md) * [Anciennes discussions sur la gestion des plannings](IdeesGestionPlannings.md) diff --git a/docs/PublicationEtudiants.md b/docs/PublicationEtudiants.md index 01ef7110b..80f41dc46 100644 --- a/docs/PublicationEtudiants.md +++ b/docs/PublicationEtudiants.md @@ -7,7 +7,7 @@ Pour communiquer aux étudiants leurs réultats, plusieurs solutions: - Envoi des bulletins (pdf) par mail (c'est facile depuis le menu "Notes"). - Publication sur un autre site Web: typiquement l'ENT de l'établissement, ou un mini-site dédié. - - Pour interfacer un ENT, [voir l'API](ScoDocAPI.md). + - Pour interfacer un ENT, [voir l'API](ScoDoc9API.md). - Plusieurs collègues ont développé des mini-sites pour publier les notes (accès protégé par CAS ou autre). Ces codes ne font pas stricto censu partie de ScoDoc. Quelques exemples en PHP sont distribués dans le répertoire `misc/PublicationBulletins` ([voir ici](https://scodoc.org/git/viennet/ScoDoc/src/branch/master/misc/PublicationBulletins)). - Plus récemment (2020), des collègues de l'IUT de Mulhouse ont développé un mini-portail complet: [Scodoc_Notes](https://github.com/SebL68/Scodoc_Notes) (github), [historique](https://notes.iutmulhouse.uha.fr/maj.php). diff --git a/docs/ScoDoc9API.md b/docs/ScoDoc9API.md index 2fa43e882..8878c3497 100644 --- a/docs/ScoDoc9API.md +++ b/docs/ScoDoc9API.md @@ -23,6 +23,8 @@ L'URL complète est de la forme: `https://scodoc.example.com/ScoDoc/api/fonction # Fonctions de l'API ScoDoc 7 portées en ScoDoc 9 +L'ancienne API ScoDoc 7 est décrite ici: [ScoDocAPI](ScoDocAPI.md) + Afin de garantir l'interopérabilité avec les clients ScoDoc 7 (ENT, etc), les fonctions suivantes sont disponibles avec le mécanisme d'authentification basique de ScoDoc 7. Elles sont considérées comme *obsolètes* ("deprecated") et @@ -940,7 +942,7 @@ Et un autre exemple en format JSON: ## En savoir plus -Voir l'exemple complet d'utilisation de l'API JSON en Python, dans `misc/example-api-1.py` +Voir exemples d'utilisation de l'API en Python, dans `tests/api/`. diff --git a/docs/ScoDocAPI.md b/docs/ScoDocAPI.md index 48e25d37d..03d5ec841 100644 --- a/docs/ScoDocAPI.md +++ b/docs/ScoDocAPI.md @@ -914,8 +914,7 @@ Et un autre exemple en format JSON: ## En savoir plus -Voir l'exemple complet d'utilisation de l'API JSON en Python, dans `misc/example-api-1.py` - +Voir exemples d'utilisation de l'API en Python, dans `tests/api/`. diff --git a/mkdocs.yml b/mkdocs.yml index 5d0fb746a..74e7dd1ba 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -18,7 +18,6 @@ nav: - 'Interfaces SI': InterrogationPortail.md - 'Publication des notes': PublicationEtudiants.md - 'Export Apogée': ScoDocApogee.md - - 'API': ScoDocAPI.md - Association: - 'Association 1901': AssociationScoDoc.md @@ -27,6 +26,8 @@ nav: - Développement: - 'Git': https://scodoc.org/git - 'Guide Développeurs': GuideDeveloppeurs.md + - 'API (interfaçages autres logiciels)': ScoDoc9API.md + - FAQ: FAQ.md