changeset 1206:d2755c9d4c47

cont
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 24 Oct 2025 18:13:36 +0200
parents e52bf9c8e16b
children 76bc30dfeeb5
files Sphinx/source/plugins/education.rst
diffstat 1 files changed, 60 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/Sphinx/source/plugins/education.rst	Fri Oct 24 17:43:00 2025 +0200
+++ b/Sphinx/source/plugins/education.rst	Fri Oct 24 18:13:36 2025 +0200
@@ -21,8 +21,8 @@
 :ref:`whole-slide imaging primitives <wsi>` of Orthanc.
 
 The Education plugin requires the version of Orthanc to be above or
-equal to 1.12.9. Note that this plugin overwrites the way users are
-authenticated by Orthanc.
+equal to 1.12.9. It is released under the AGPL license. Note that this
+plugin overwrites the way users are authenticated by Orthanc.
 
 This development was partially funded by the `Virtual Hospital grant
 <https://www.virtual-hospital.org/>`__ at `Louvain School of
@@ -34,8 +34,8 @@
 
 The Orthanc plugin supports two modes of operation. The **standalone
 mode** allows Orthanc to operate as a Web server for sharing
-collections of medical images with students. In this mode, instructors
-can provide students with a URL linking to a Web page that lists the
+collections of medical images with learners. In this mode, instructors
+can provide learners with a URL linking to a Web page that lists the
 images in the collection, allowing them to view the images using their
 preferred Web viewer. The following screenshot shows this page:
 
@@ -58,16 +58,16 @@
 |
 
 In this video, the left portion of the screen presents the
-administrative interface of Orthanc, used to associate medical images
-with **collections of images** (those collections are referred to as
-"projects"). The right portion displays the Moodle user interface,
-enabling students to access the images and open Web viewers managed by
-Orthanc. The instructor of the project 
+administrative interface of the Education plugin, used to associate
+medical images with **collections of images** (those collections are
+referred to as "projects"). The right portion displays the Moodle user
+interface, enabling learners to access the images and open Web viewers
+managed by Orthanc. Contrarily to the standalone mode,
 
 Both modes of operation include a **permission system** ensuring that
-students can only view images they are authorized to
+learners can only view images they are authorized to
 access. Additionally, the Education plugin supports multiple
-collections, which can be associated with different teachers.
+collections, which can be associated with different instructors.
 
 
 Compilation
@@ -107,17 +107,59 @@
 ``https://debian.orthanc-labs.com/``.
 
 
-
+Terminology
+-----------
 
-Standalone mode
----------------
+This section introduces the various concepts that are necessary to
+understand how the Education plugin for Orthanc works.
 
 
-Integration with Learning Management Systems
---------------------------------------------
+User management
+^^^^^^^^^^^^^^^
+
+The Education plugin for Orthanc makes the distinction between 3
+categories of users:
+
+* **Administrators** are responsible for the configuration of Orthanc
+  and for the management of the collections of medical images
+  (referred to as "projects"). It is up to the administrators to
+  upload the DICOM images, to create the projects, to dispatch the
+  images among the different projects, and to associate projects with
+  instructors and learners.  To this end, administrators have access
+  to the administrative interface of the Education plugin, as well as
+  to :ref:`Orthanc Explorer <orthanc-explorer>` and :ref:`Orthanc
+  Explorer 2 <orthanc-explorer-2>`.
 
-This plugin adds a dedicated button to Orthanc Explorer, which
-provides an easy, fast access to the OHIF viewers ():
+* **Standard users** represent either instructors (teachers) or
+  learners (students). These users cannot modify the configuration of
+  the platform, upload medical images, or distribute images across
+  projects. Instructors can modify project-specific settings based on
+  their pedagogical objectives, such as controlling project visibility
+  or selecting which viewers are available for a given project. A user
+  may act as an instructor in certain projects and as a learner in
+  others. For this reason, the "teacher vs. learner" terminology is
+  avoided, as it implies a fixed role for each user.
+
+* **Guest users** are users who are not authenticated by the
+  platform. They behave like learners but can only access projects
+  with public visibility. This functionality can be used to publish
+  massive open online courses (MOOCs) through the standalone mode of
+  operation.
+
+The way the Education plugin authenticates administrators and standard
+users is specified in the :ref:`configuration file of Orthanc
+<configuration>`. The following authentication mechanisms are
+available:
+
+* **Login**. In this case, the Education plugin displays a login page
+  where the user can enter their credentials, which are specified in
+  the configuration file.
+
+
+
+
 
 
 Labels
+
+HTTPS