diff --git a/.gitignore b/.gitignore index 95ea976..5a06677 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,3 @@ *.zip *.pdf +document.html diff --git a/Makefile b/Makefile index 1cf65c7..be5f45a 100644 --- a/Makefile +++ b/Makefile @@ -6,19 +6,20 @@ document.md output_file_name := document pandoc := \ - pandoc -s --citeproc \ + pandoc \ --css=style.css --template=template.html \ --toc --toc-depth=2 \ pandoc_html := \ $(pandoc) \ + --standalone \ --to=html --output=$(output_file_name).html \ $(input_files) pandoc_pdf := \ $(pandoc) \ -V noscript=true \ - --embed-resource --to=pdf \ + --embed-resources=true --to=pdf \ --pdf-engine=pagedjs-cli \ --output=$(output_file_name).pdf \ $(input_files) diff --git a/README.md b/README.md index adfa826..8a42778 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,43 @@ --- -title: BUNIGE document -date: 2025-05-07T10:59:48+0200 -id: 20250507105948 -tags: ["modèle", "BUNIGE", "pagedjs"] -template_version: v0.2.0 +title: Refs-amc-moodle +date: 2025-05-20T11:57:36+0200 +id: 20250520115743 +tags: ["moodle", "zotero", "amc"] +version: v0.1.0-alpha.1 --- -# [Document utilisant le modèle BUNIGE][1] +# [Procédure pour s'aider de Zotero pour les références recommandées sur Moodle][1] -Modèle pour faciliter la création d'un document utilisant le modèle pour la -BUNIGE avec Pagedjs. +Ce document est une procédure pour la rédaction des références des lectures +recommandées sur les pages Moodle des AMC. ## Licence Ce projet est sous licence CC-BY-SA 4.0. -## Mise à jour des fichiers du modèle +## La procédure au format PDF -Il faut télécharger l'archive sur la page de la [dernière publication de -version][2] du projet du modèle. L'archive est nommée avec le numéro de version -correspondant. +La dernière version de la procédure au format PDF est disponible dans la +dernière publication de version : [v0.1.0-alpha.1][4]. -```bash -curl -o modèle.zip https://git.milhit.ch/igor/bunige-pagedjs-template/releases/download/v0.2.0/v0.2.0.zip -unzip modèle.zip -``` +La source, au format markdown, est le fichier `document.md`. -## Utilisation du modèle +## Génération du fichier -Pour utiliser le modèle, il faut rédiger votre document dans un fichier avec -une extension `.md`, autrement dit un fichier au format texte utilisant la -syntaxe markdown. Pour cela, il est possible de s'aider de l'[exemple][3] pour -comprendre ce qu'il est possible de faire. +Pour générer le fichier final, il est nécessaire d'avoir installé les logiciels +suivants : +- `pandoc`. +- `pagedjs-cli`. +Si vous disposez également de `make`, alors les commandes suivantes sont +possibles : + +- `make html`. Le format HTML est utile pour une prévisualisation au moyen d'un + serveur web local. +- `make pdf`. [1]: ./ -[2]: https://git.milhit.ch/igor/bunige-pagedjs-template/releases/latest -[3]: https://git.milhit.ch/igor/bunige-pagedjs-template/src/branch/main/example/example.md +[4]: https://git.milhit.ch/igor/bunige-pagedjs-template/releases/tag/v0.1.0-alpha.1 diff --git a/document.md b/document.md new file mode 100644 index 0000000..4b4cdc2 --- /dev/null +++ b/document.md @@ -0,0 +1,207 @@ +--- +title: Références des AMC sur Moodle +subtitle: Procédure pour s'aider avec Zotero +creation_date: 2025-05-07T12:00:24+0200 +id: 20250507120024 +date: printemps 2025 +logo: +- ./static/moodle-logo.svg +- ./static/zotero-logo.png +tags: ["procédure", "AMC", "moodle", "zotero"] +toc-title: Table des matières +version: v0.1.0-alpha.1 +--- + +:::{#licence} +![Logo de la licence CC BY-SA 4.0][1] \ +[CC BY-SA 4.0][2] \ +[Sources][3] --- Version [v0.1.0-alpha.1][27] +::: + +## Contexte {#first-section} + +Ce document est une procédure pour la rédaction des références des lectures +recommandées sur les pages Moodle des AMC. Pour l'appliquer, il faut : + +- Avoir ajouté les références dans une bibliothèque Zotero, de préférence une + bibliothèque de groupe[^0], afin de la partager avec les personnes responsables + de sélectionner les lectures recommandées et avec les personnes en charge de + mettre à jour les pages Moodle. +- Que les informations associées aux références correspondent aux exigences de + ce qui est attendu comme rendu (auteurs, titres, etc.). +- Avoir déterminé quel style Zotero utiliser, vraisemblablement le style + Vancouver ou l'une de ses variantes. +- Avoir associé à chaque fois que cela est possible un fichier PDF aux + références, que ce soit le *full text* d'un articles scientifiques, la + numérisation d'un chapitre de livre, etc. + +## Principes de base + +Les PDF des documents vont être ajoutés dans un dossier. Le mieux est d'avoir +un dossier par section de l'AMC (ARC, séminaire, tutoriel, etc.) et de nommer +le dossier comme la section. Cela facilite la gestion des fichiers. + +Le dossier peut être configuré pour qu'il ne soit pas visible par les +étudiant-es, mais leur être disponible. Le but est de ne pas encombrer la page +Moodle, mais de pouvoir leur donner accès à l'ensemble du dossier. + +Enfin, une section est créée sous la forme d'une ressource « page », dans +laquelle sont rédigées les références, par copier-coller depuis Zotero. Enfin, +un lien vers le PDF est ajouté. + +:::{.exercise} +⚠️ Une fois que l'ensemble des références sont mise en place, la mise à jour sera +beaucoup plus rapide ! +::: + +## Création du dossier et ajout des PDF + +Depuis la section de l'AMC qui doit afficher les références : + +1. Cliquer sur « Ajouter une activité ou ressource. + +![Ajouter une ressource][4] + +2. Sélectionner la ressource « dossier. » + +![Ajouter un dossier][5] + +3. Nommer le dossier de manière claire, pour le retrouver plus facilement + ensuite. Le champ « description » est optionnel. + +![Nommer le dossier][6] + +4. Cocher les cases suivantes si elles ne le sont pas. + +![Cases à cocher][7] + +5. Dans la partie « Réglages courants », changer la disponibilité en « Rendre + disponible, mais invisible sur la page de cours ». + +![Rendre invisible][11] + +6. Glisser-déposer les PDF dans la partie « Fichiers » du « Contenu ». + +![Glisser-déposer les PDF][8] + +7. Si nécessaire, créer un sous-dossier, par exemple « Pour en savoir plus ». + Ensuite, glisser-déposer des PDF dans ce sous-dossier. + +![Sous-dossier][9] + +![Structure du dossier][10] + +8. Une fois que le dossier contient tous les fichiers nécessaires, enregistrer + avec le bouton « Enregistrer et revenir au cours » au fond de la page. + +## Affichage des références + +Toujours depuis la section de l'AMC qui doit afficher les références, on a 2 +possibilités pour le faire : + +1. Créer une ressource page. +1. Utiliser le champ description de la section. + +La démarche est la même, mais la 2ͤ solution à l'avantage d'éviter un clic pour +afficher la liste des références. C'est ce qui est montré ci-dessous. + +Dans notre cas, on dispose d'une section qui contient un dossier avec les PDF +des références. Nous allons éditer cette section : + +1. Modifier les réglages de la section. + +![Modifier les réglages de la section][12] + +Le champ description est maintenant éditable. + +2. Dans Zotero, sélectionner les références à afficher. + +![Sélection des références][13] + +3. Clic-droit sur la sélection et choisir « Créer une bibliographie à partir des + documents sélectionnés » + +![Créer une bibliographie à partir des documents][14] + +4. Un dialogue s'ouvre pour choisir le style bibliographique[^1], ainsi que le + mode et la méthode de création. Enfin, cliquer sur « OK ». + +![Paramétrage de la bibliographie][15] + +5. Coller les références dans l'éditeur du champ « description » de Zotero. Il + faut cliquer dans l'éditeur pour y activer le curseur et utiliser le + raccourci clavier « ctrl+v ». Vous pouvez également mettre en forme le + contenu de ce champ. + +![La bibliographie collée dans l'éditeur][17] + +6. Si nécessaire, faire la même chose pour les références « Pour en savoir + plus ». Voici ce que ça donne avec l'ajout du format « puces » : + +![La bibliographie complète, mise en forme][18] + +7. Ajouter le lien vers le PDF. Commencer par ajouter le texte du lien, + sélectionner ce texte et cliquer sur le bouton pour ajouter un lien. + +![Ajouter un lien hypertexte][19] + +8. Dans le dialogue qui s'ouvre, cliquer sur « Parcourir les dépôts… » pour + aller chercher le PDF correspondant à la référence. + +![Parcourir les dépôts][20] + +9. Dans le sélecteur de fichiers qui s'ouvre, rester dans la section « Fichiers + disponibles » et chercher le dossier créé plus tôt. + +![Sélection du dossier contenant les PDF][21] + +10. Sélectionner le PDF correspondant à la référence. + +![Sélectionner le bon PDF][22] + +11. Dans le nouveau dialogue, paramétrer l'ajout du fichier, en préférant un + lien vers le fichier + +![Paramétrer l'ajout du fichier][23] + +Une fois que l'on a ajouté les liens vers chaque PDF, voici ce que ça donne : + +![Résultat final][25] + + + +[^0]: Voir [la documentation][24] pour les bibliothèques de groupe. +[^1]: Il faut sélection un style qui correspond à vos exigences. En médecine, +en général il s'agit du style Vancouver. Pour ajouter des styles à Zotero, voir +[la documentation][16]. \ +Pour ma part, j'utilise une version modifiée du style Vancouver qui n'ajoute +pas les entrées numériques et qui limite le nombre des auteurs-trices à 3, +avant d'ajouter le « et al. ». Il est disponible [en ligne][26]. + +[1]: ./static/by-sa.svg +[2]: https://creativecommons.org/licenses/by-sa/4.0/deed.fr "Texte de la licence en français" +[3]: https://git.milhit.ch/igor/refs-amc-moodle +[4]: ./static/ajouter-ressource.png +[5]: ./static/ajouter-dossier.png +[6]: ./static/nommer-dossier.png +[7]: ./static/dossier-cases-cocher.png +[8]: ./static/dossier-glisser-deposer.png +[9]: ./static/sous-dossier.png +[10]: ./static/dossier-structure.png +[11]: ./static/dossier-non-visible.png +[12]: ./static/modifier-reglages-sections.png +[13]: ./static/zotero-selection-references.png +[14]: ./static/zotero-creer-bibliographie.png +[15]: ./static/zotero-parametres-bibliographie.png +[16]: https://docs.zotero-fr.org/styles/#installer-des-styles-supplementaires +[17]: ./static/coller-bibliographie.png +[18]: ./static/bibliographie-avec-puces.png +[19]: ./static/ajouter-lien.png +[20]: ./static/parcourir-depots.png +[21]: ./static/selection-dossier-pdf.png +[22]: ./static/selection-pdf.png +[23]: ./static/parametrer-insertion-fichier.png +[24]: https://docs.zotero-fr.org/groups/ +[25]: ./static/resultat-final.png +[26]: https://drive.switch.ch/index.php/s/dTYvOvVwYCBb4yo +[27]: https://git.milhit.ch/igor/refs-amc-moodle/releases/tag/v0.1.0-alpha.1 diff --git a/static/ajouter-dossier.png b/static/ajouter-dossier.png new file mode 100644 index 0000000..c508f4b Binary files /dev/null and b/static/ajouter-dossier.png differ diff --git a/static/ajouter-lien.png b/static/ajouter-lien.png new file mode 100644 index 0000000..6283f08 Binary files /dev/null and b/static/ajouter-lien.png differ diff --git a/static/ajouter-ressource.png b/static/ajouter-ressource.png new file mode 100644 index 0000000..6f6fcea Binary files /dev/null and b/static/ajouter-ressource.png differ diff --git a/static/bibliographie-avec-puces.png b/static/bibliographie-avec-puces.png new file mode 100644 index 0000000..ab4231b Binary files /dev/null and b/static/bibliographie-avec-puces.png differ diff --git a/static/coller-bibliographie.png b/static/coller-bibliographie.png new file mode 100644 index 0000000..442531b Binary files /dev/null and b/static/coller-bibliographie.png differ diff --git a/static/dossier-cases-cocher.png b/static/dossier-cases-cocher.png new file mode 100644 index 0000000..2706061 Binary files /dev/null and b/static/dossier-cases-cocher.png differ diff --git a/static/dossier-glisser-deposer.png b/static/dossier-glisser-deposer.png new file mode 100644 index 0000000..2fe3a08 Binary files /dev/null and b/static/dossier-glisser-deposer.png differ diff --git a/static/dossier-non-visible.png b/static/dossier-non-visible.png new file mode 100644 index 0000000..6ba03d1 Binary files /dev/null and b/static/dossier-non-visible.png differ diff --git a/static/dossier-structure.png b/static/dossier-structure.png new file mode 100644 index 0000000..365e790 Binary files /dev/null and b/static/dossier-structure.png differ diff --git a/static/modifier-reglages-sections.png b/static/modifier-reglages-sections.png new file mode 100644 index 0000000..338bf9d Binary files /dev/null and b/static/modifier-reglages-sections.png differ diff --git a/static/moodle-logo.svg b/static/moodle-logo.svg new file mode 100644 index 0000000..f5c60e0 --- /dev/null +++ b/static/moodle-logo.svg @@ -0,0 +1,4 @@ + + + + diff --git a/static/nommer-dossier.png b/static/nommer-dossier.png new file mode 100644 index 0000000..bb2abfa Binary files /dev/null and b/static/nommer-dossier.png differ diff --git a/static/parametrer-insertion-fichier.png b/static/parametrer-insertion-fichier.png new file mode 100644 index 0000000..0a14403 Binary files /dev/null and b/static/parametrer-insertion-fichier.png differ diff --git a/static/parcourir-depots.png b/static/parcourir-depots.png new file mode 100644 index 0000000..fa11c5a Binary files /dev/null and b/static/parcourir-depots.png differ diff --git a/static/resultat-final.png b/static/resultat-final.png new file mode 100644 index 0000000..74aff80 Binary files /dev/null and b/static/resultat-final.png differ diff --git a/static/selection-dossier-pdf.png b/static/selection-dossier-pdf.png new file mode 100644 index 0000000..4fa4cd5 Binary files /dev/null and b/static/selection-dossier-pdf.png differ diff --git a/static/selection-pdf.png b/static/selection-pdf.png new file mode 100644 index 0000000..5655c3e Binary files /dev/null and b/static/selection-pdf.png differ diff --git a/static/sous-dossier.png b/static/sous-dossier.png new file mode 100644 index 0000000..1616e5a Binary files /dev/null and b/static/sous-dossier.png differ diff --git a/static/zotero-creer-bibliographie.png b/static/zotero-creer-bibliographie.png new file mode 100644 index 0000000..02ee71f Binary files /dev/null and b/static/zotero-creer-bibliographie.png differ diff --git a/static/zotero-logo.png b/static/zotero-logo.png new file mode 100644 index 0000000..557fcb1 Binary files /dev/null and b/static/zotero-logo.png differ diff --git a/static/zotero-logo.svg b/static/zotero-logo.svg new file mode 100644 index 0000000..8f201ac Binary files /dev/null and b/static/zotero-logo.svg differ diff --git a/static/zotero-parametres-bibliographie.png b/static/zotero-parametres-bibliographie.png new file mode 100644 index 0000000..b7dfbc2 Binary files /dev/null and b/static/zotero-parametres-bibliographie.png differ diff --git a/static/zotero-selection-references.png b/static/zotero-selection-references.png new file mode 100644 index 0000000..3cfaae2 Binary files /dev/null and b/static/zotero-selection-references.png differ