Aide:Modèle MOOC administration
Créer une formation au format MOOC
[modifier | modifier le wikicode]Modèle MOOC
[modifier | modifier le wikicode]Le code est disponible publiquement ici.
Les sources sont dans le dossier src.
- script.scss : css
- index.js : point d'entrée du script (contenant l'appel du template)
- Bootstrap.js : chargement des composants du template
- utils.js : fonctions internes utilitaires
- messages.js : gestion des erreurs, contient les avertissements
Ressources externes
[modifier | modifier le wikicode]- Police d'écriture : https://fonts.googleapis.com/css?family=Open+Sans:400,700
- Sprite (script.scss ligne 367) : https://upload.wikimedia.org/wikipedia/commons/1/18/V1_-_20160706.png
Installation
[modifier | modifier le wikicode]Node.js (https://nodejs.org/en/download/) et NPM (inclus dans Node.js).
npm install
Note pour les utilisateurs de Windows
[modifier | modifier le wikicode]Les Makefile ne sont pas utilisables comme tel sous Windows. Les commandes suivantes fonctionnent avec Cygwin (https://www.cygwin.com).
Mettre à jour le modèle
[modifier | modifier le wikicode]JavaScript
[modifier | modifier le wikicode]Les sources sont divisées en composant (dossier components). Il doit être compilé pour pouvoir être utilisé dans un navigateur.
Compilation :
make build
Ensuite copier/coller le contenu du fichier dist/script.js dans le fichier JavaScript du Gadget stocké sur la Wikiversité.
CSS
[modifier | modifier le wikicode]Le CSS utilise SASS. Il doit être compilé pour pouvoir fonctionner sur le Web.
Compilation :
make buildcss
Ensuite copier/coller le contenu du fichier dist/script.css dans le fichier CSS du Gadget stocké sur la Wikiversité.
Modifier les messages d'aide et d'erreur
[modifier | modifier le wikicode]Pour simplifier la maintenance tous les messages émis par le modèle se trouvent dans le fichier src/messages.js. Pour appliquer les changements, veuillez consulter la partie Mettre à jour le modèle.
Exemple
[modifier | modifier le wikicode]function createMenuUrlNotFound(url) {
return `
Erreur : URL du menu introuvable ${url ? "(" + url + ")": ""}.
${createSeeHelpPage("https://fr.wikiversity.org/wiki/Modèle_MOOC_administration#Erreur_:_URL_du_menu_introuvable")}
`
}
Le message d'erreur est entre les caractères (`). Il modifiable et supporte les balises HTML.
La function createSeeHelpPage permets d'inclure un lien vers une page d'aide de la Wikiversité. L'URL est spécifié en paramètre comme ci-dessus.
Dépanner le modèle
[modifier | modifier le wikicode]Voici la liste des messages émis par le modèle ainsi que des indications pour les corriger.
Erreur : URL du menu introuvable
[modifier | modifier le wikicode]La configuration du modèle est incorrecte. Dans la plupart des cas il s'agit d'une erreur de saisie ; vérifiez la syntaxe du titre ou du lien vers la page contenant le menu.
Voir section "3. Etape 1 : création du menu" et "5. intégrer ou rédiger les contenus" du guide utilisateur du modèle MOOC.
Erreur : cette page est introuvable dans le menu
[modifier | modifier le wikicode]L'URL courante du modèle doit être contenu dans le menu. Vérifiez que l'URL est présente dans la page contenant le menu (nommée Menu-…), vous pouvez cliquer sur le lien pour confirmer que le lien est correct.
Voir section "3. Etape 1 : création du menu" du guide utilisateur du modèle MOOC.
Erreur : l'en-tête n'a pas pu être chargé
[modifier | modifier le wikicode]Il s'agit d'une erreur JavaScript, apparu durant la génération de l'en-tête. Si un message d'erreur est dispo, veuillez la rapporter aux administrateurs de la Wikiversité.
Voir section "4) Etape 2 : créer les items : objectif, prérequis, compétences visées, public, durée" du guide utilisateur du modèle MOOC.
Erreur : icône introuvable
[modifier | modifier le wikicode]L'icône indiquée par l'utilisateur est introuvable. Le noms des icônes disponibles sont indiqués dans le guide d'implémentation du modèle.
Voir section "4) Etape 2 : créer les items : objectif, prérequis, compétences visées, public, durée" ou "3. Etape 1 : création du menu" du guide utilisateur du modèle MOOC.
Lien précédent ou suivant introuvable
[modifier | modifier le wikicode]Il s'agit d'une erreur mineure de configuration du modèle. Veuillez consulter le manuel d'implémentation.
Voir section "5) intégrer ou rédiger les contenus" du guide utilisateur du modèle MOOC.
Le modèle n'a pas pu être généré
[modifier | modifier le wikicode]Une erreur inconnue est survenu. Veuillez la rapporter aux administrateurs de la Wikiversité.
Pour une étude plus poussé de l'origine du problème veuillez consulter la partie Dépanner le modèle (avancé)
Erreur persistante
[modifier | modifier le wikicode]Si votre erreur persiste vous pouvez vous adresser aux administrateurs de la Wikiversité via La salle café. Pensez à y inclure le plus de détails possible (capture d'écran, message d'erreur, URL de la page sur la Wikiversité, contenu de la console des outils de développement, …).
Dépanner le modèle (avancé)
[modifier | modifier le wikicode]Le code du Gadget-MOOC est minifié. Cela peut rendre l'investigation d'une erreur JavaScript difficile. Pour simplifier cette opération vous pouvez utiliser les sourcemaps.
Pour générer le sourcemap veuillez suivre les étapes décrites dans Mettre à jour le modèle > JavaScript. Une fois terminé le fichier "map" sera accessible dans le dossier `dist` (dist/script.js.map). Vous devez ensuite importer le fichier dans les outils de développement de votre navigateur. Pour Google Chrome il suffit de se rendre dans l'onglet `sources` et faire un clique droit puis "Add Source Map".
Une fois que vous avez installé le source map, les erreurs dans la console pointeront directement sur des lignes dans le code source.
