Publier une collection

Guide pour regrouper plusieurs ePocs dans une collection importable depuis l'application mobile.

Une collection regroupe plusieurs ePocs sous une même bannière (éditeur, logo, licence, etc). Une fois ajoutée dans l'application mobile, elle affiche tous les ePocs qui la composent et se met à jour automatiquement.

Principe

Une collection est décrite par un fichier JSON de métadonnées : titre, description, logo, éditeur, contact, licence, mots-clés et liste des ePocs. Ce fichier doit être accessible publiquement via une URL fixe, que les utilisateurs ajoutent ensuite dans l'application.

Créer le fichier de la collection

Partir du modèle de données ci-dessous (au format YAML, ce qui permet d'y ajouter des commentaires) et le remplir
Convertir le fichier en JSON avec un convertisseur comme JSON Formatter
Héberger le fichier JSON sur un service accessible publiquement, par exemple un Gist GitHub ou un snippet GitLab, ou GitHub / GitLab Pages

Modèle de données

Modèle à remplir (les commentaires expliquent chaque champ). La liste ePocs se complète avec les métadonnées de chaque ePoc, voir Collection d'ePocs.

# Identifiant unique de la collection, sous forme de reverse-DNS.
# Exemple : fr.inria.learninglab.epocs
id: fr.example.organisme.epocs

# Titre affiché de la collection.
title: Nom de la collection

# Description du contenu ou de l'objectif de la collection.
description: Description courte de la collection de formations proposées.

# Publisher : entité responsable de la publication de la collection.
publisher:
  # Identifiant unique de l'éditeur (reverse-DNS).
  id: fr.example.organisme
  # Nom de l'éditeur.
  name: Nom de l'organisme éditeur
  # (optionnel) Description de l'éditeur.
  description: Description de l'organisme éditeur (missions, public visé, etc.).
  # URL du logo (480x320px)
  logo: https://exemple.fr/chemin/vers/logo.png
  # Email de contact de l'éditeur.
  email: contact@exemple.fr
  # (optionnel) Site web de l'éditeur.
  website: https://exemple.fr

# Licence (optionnel) : licence par défaut appliquée à la collection.
licence:
  # Nom de la licence par défaut sur vos ePocs, ex. "CC-BY-SA-4.0".
  name: "Nom de la licence (ex : Creative Commons Attribution 4.0 International)"
  # URL vers le texte complet de la licence.
  url: https://creativecommons.org/licenses/by/4.0/
  # content: "Texte complet de la licence (optionnel, alternative à l'URL)."

# URL publique où sera hébergé ce même fichier JSON de collection.
url: https://exemple.fr/chemin/vers/collection.json

# (optionnel) Mots-clés pour la catégorisation de la collection.
tags:
  - tag1
  - tag2
  - tag3

# La liste des ePocs avec leurs métadonnées
ePocs: {}

Héberger le fichier JSON

Si vous n'avez pas de site web, un Gist GitHub ou un snippet GitLab suffit pour obtenir une URL publique.

GitHub Gist

Se rendre sur gist.github.com et se connecter
Nommer le fichier collection.json et coller le contenu JSON de la collection
Cliquer sur Create public gist (un gist secret reste accessible à qui possède le lien, mais n'est pas listé)
Cliquer sur le bouton Raw du fichier et copier l'URL de la page obtenue

L'URL ressemble à https://gist.githubusercontent.com/{utilisateur}/{id}/raw/{révision}/collection.json. Supprimez la partie {révision} pour obtenir une URL fixe qui pointe toujours vers la dernière version :

https://gist.githubusercontent.com/{utilisateur}/{id}/raw/collection.json

GitLab Snippet

Se rendre sur gitlab.com/-/snippets/new et se connecter
Choisir la visibilité Public, nommer le fichier collection.json et coller le contenu JSON de la collection
Cliquer sur Create snippet
Cliquer sur Open raw et copier l'URL de la page obtenue

L'URL ressemble à :

https://gitlab.com/-/snippets/{id}/raw/main/collection.json

Mettre à jour la collection

Modifiez le gist ou le snippet pour ajouter un ePoc ou changer une information : l'URL ne change pas et les utilisateurs récupèrent la nouvelle version au prochain lancement de l'application.

Ajouter la collection dans l'application

Dans l'application, utilisez Ajouter un ePoc > Collection puis importez la collection depuis son lien ou un QR Code. La procédure est détaillée dans le guide d'importation.

Une fois ajoutée, la collection est rafraîchie à chaque lancement de l'application : tout ePoc ajouté ou modifié dans le fichier JSON apparaît automatiquement chez les utilisateurs.

Export SCORM
Exporter votre ePoc sous forme de paquet SCORM pour l'intégrer à une plateforme d'apprentissage (Moodle, etc).
Contribuer
Guide pour contribuer au code source d'ePoc