document: rédige la procédure

- Ajoute les copies d'écran.
- Rédige la procédure.
- Adapte le Makefile au projet. À noter que l'option
  `--embed-resources=true` change l'effet du chemin vers les ressources
  dans le `template.html`.

Co-Authored-by: iGor milhit <igor@milhit.ch>
main v0.1.0-alpha.1
iGor milhit 2025-05-09 08:01:58 +02:00
parent eaec536ad4
commit eb907c02fc
Signed by: igor
GPG Key ID: 692D97C3D0228A99
27 changed files with 239 additions and 25 deletions

1
.gitignore vendored
View File

@ -1,2 +1,3 @@
*.zip
*.pdf
document.html

View File

@ -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)

View File

@ -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`.
<!-- références -->
[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/refs-amc-moodle/releases/tag/v0.1.0-alpha.1

207
document.md 100644
View File

@ -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]
<!-- références -->
[^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

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 201 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

View File

@ -0,0 +1,4 @@
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 1290 90">
<path fill="#f98012" d="M289.61 309.77V201.51q0-33.94-28-33.95t-28.06 33.95v108.26H178.4V201.51q0-33.94-27.57-33.95-28.05 0-28 33.95v108.26H67.67V195.12q0-35.43 24.6-53.63 21.66-16.25 58.56-16.25 37.41 0 55.12 19.19 15.26-19.19 55.62-19.19 36.9 0 58.54 16.25 24.6 18.19 24.61 53.63v114.65Zm675.49-.5V0h55.16v309.27Zm-70.3 0v-18.22q-7.39 9.84-25.11 15.76a92.81 92.81 0 0 1-30.05 5.41q-39.4 0-63.28-27.09t-23.89-67c0-26.25 7.76-48.3 23.4-66 13.85-15.65 36.35-26.59 62.29-26.59 29.22 0 46.28 11 56.64 23.63V0h53.68v309.27Zm0-102.92q0-14.78-14-28.33T852 164.47q-21.16 0-33.48 17.24-10.85 15.3-10.84 37.43 0 21.68 10.84 36.94 12.3 17.75 33.48 17.73 12.81 0 27.83-12.07t15-24.86ZM648.57 314.19q-41.87 0-69.19-26.59T552 219.14q0-41.83 27.34-68.45t69.19-26.59q41.85 0 69.44 26.59t27.58 68.45q0 41.88-27.58 68.46t-69.4 26.59Zm0-145.77q-19.94 0-30.65 15.1t-10.71 35.88q0 20.78 10 35.13 11.46 16.34 31.4 16.32T680 254.53q10.46-14.34 10.46-35.13t-10-35.13q-11.46-15.86-31.89-15.85ZM449.13 314.19q-41.86 0-69.2-26.59t-27.33-68.46q0-41.83 27.33-68.45t69.2-26.59q41.83 0 69.44 26.59t27.57 68.45q0 41.88-27.57 68.46t-69.44 26.59Zm0-145.77q-19.94 0-30.66 15.1t-10.71 35.88q0 20.78 10 35.13 11.46 16.34 31.41 16.32t31.39-16.32Q491 240.19 491 219.4t-10-35.13q-11.44-15.86-31.87-15.85Zm636.45 67.47c1.18 13.13 18.25 41.37 46.31 41.37 27.31 0 40.23-15.77 40.87-22.16l58.11-.5c-6.34 19.39-32.1 60.58-100 60.58-28.24 0-54.08-8.79-72.64-26.35s-27.82-40.45-27.82-68.7q0-43.83 27.82-69.68t72.16-25.85q48.25 0 75.34 32 25.13 29.53 25.12 79.28Zm90.13-34c-2.3-11.83-7.23-21.49-14.77-29.06q-12.82-12.3-29.55-12.31-17.25 0-28.82 11.82t-15.5 29.55Z"/>
<path fill="#333" d="m174.74 116.9 54.74-40-.7-2.44C130 86.57 85.08 95.15 0 144.47l.79 2.24 6.76.07c-.62 6.81-1.7 23.64-.32 48.95-9.44 27.32-.24 45.88 8.4 66.07 1.37-21 1.23-44-5.22-66.89-1.35-25.14-.24-41.67.37-48.1l56.4.54a258 258 0 0 0 1.67 33.06c50.4 17.71 101.09-.06 128-43.72-7.47-8.37-22.11-19.79-22.11-19.79Z"/>
</svg>

After

Width:  |  Height:  |  Size: 2.0 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 62 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 138 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.5 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB