Consignes

Les indications suivantes sont rédigées à l'intention de l'animateur mais peuvent aussi servir aux apprenants pour se repérer dans le déroulé de l'atelier.

1. Matin (3 heures)

1.1 installation

Présenter aux apprenants les différents éléments constitutifs du dossier : coffre de notes, dossier images, dossier .obsidian

1.2 Présentation d'Obsidian et de la journée avec le canvas de la formation

Ouvrir le fichier Formation,_urfist et commenter les branches.
Indiquer en quoi consistent les fichiers .canvas

Au niveau de Zettelkasten, montrer comment une note peut donner lieu à un diaporama
(faire activer le plugin par défaut "Diapositives")
Expliquer les similarités et les différences entre la méthode Zettelkasten et l'usage d'Obsidian.

Présenter la syntaxe Markdown (cf note markdown et markdown_memo)

Notes capables de contenir du texte et du code mélangés dans un format globalement en markdown
Faire une démo de l'exécution d'un code avec le plugin Execute-code (par exemple en récupérant ce code Mode d'emploi d'Obsidian#exécuter du code dans une note)
Attention pour exécuter le code, il faut être en mode lecture. En cas d'erreur, voir le registre des solutions

1.3. Créer le graphe de notes

Dans la carte mentale, les nœuds surlignés en orange indiquent comment les notes peuvent être liées entre elles. Pour chacun de ces nœuds surlignés existe une note.

Aller sur la note markdown et suivre les consignes qui sont inscrites en commentaires en vous servant de la feuille d'aide sur Markdown.

1.4. Modèles, tags et alias

1.4.1 tags et alias

réserver un entête pour quelques notes : texte simple, zotero, pandoc, obsidian

---
title: 
tags: []
aliases: []

tagger les notes mentionnées ci-dessus avec le tag "logiciel_libre"
apporter comme alias à la note "plain_text" les ajouts suivants dans l'entête :
title : trouver un autre titre que le nom de fichier
aliases : indiquer les alias possibles (texte brut, plain text, texte simple)

1.4.2 modèles

Dans Obisidian, créer un dossier Templates
Aller dans le plugin coeur Modèles et indiquez que le chemin vers le dossier que vous venez de créer (> "emplacement du dossier modèles")
créer une note "template A" comportant l'entête suivant :

---
title: {{title}}
date: {{date: DD/MM/YYYY}}
tags: []
aliases: []

déplacer cette note dans le dossier Templates
Retourner dans les paramètres du plugin modèle, indiquer le chemin relatif vers le "template A".
Définir un raccourci-clavier pour l'inclusion du modèle dans une nouvelle fiche (par exemple Ctrl+maj+M)

2. Après-midi (3 h)

2.1 CSS

Sous Obsidian_June>.obsidian>snippets, créer un fichier texte.
aller chercher un bout de code CSS dans la galerie de Akashagarwal
coller ce bout de code CSS ('snippet') dans le document texte
renommer ce document texte (nom de fichier + extension .css au lieu de .txt)
Aller dans Apparence (en bas de la fenêtre), recharger la liste des snippets CSS et activer le fichier qui apparaît.
Pour en savoir plus : Mode d'emploi d'Obsidian#9. changer le CSS

2.2 Lien avec Zotero / Jabref

Expliquer avec un schéma comment les deux applications vont pouvoir dialoguer entre elles.
Charger le plugin betterbibtex pour Zotero
Aucun plugin n'est à charger pour Jabref

Le plugin Citations

Charger le plugin Citations de Jon Gauthier
S'il s'agit du premier plugin communautaire que l'on télécharge, expliquer ce qu'est un plugin communautaire et comment on les installe et on les active.
Si le parefeu de la pièce où a lieu la formation gène le chargement du plugin, faire charger le plugin manuellement depuis Github.

Demander aux étudiants d'entrer dans Zotero les sources mentionnées dans la note "markdown".

source note
https://eveille.hypotheses.org/5990 Eveille
https://eriac.hypotheses.org/80 Julien Dehut
https://www.sudoc.abes.fr/cbs/DB=2.1/SRCH?IKT=12&TRM=260187429 Julie Denouel
https://theconversation.com/les-chercheurs-en-shs-savent-ils-ecrire-93024 Vitali-Rosati

créer dans le coffre un dossier biblio

Créer une collection dans Zotero avec ces documents (vérifier que les références sont complètes)
Exporter la collection en biblatex en gardant un jour (synchronisant avec Zotero), envoyer le fichier bib (par exemple sous le nom de markdown.bib) dans le coffre sous le dossier biblio

Si vous utilisez Jabref, copiez votre fichier bib dans le coffre Obsidian (éventuellement en les synchronisant avec rsync) sous le dossier biblio que vous avez créé.

Créer sous Biblio un dossier references
Indiquer dans les préférences du plugin Citations le lien vers le fichier bib.
Dans les préférences du plugin opter pour le format biblatex (et non Json)
Pointer vers le dossier references comme dossier de destination des notes biblio créées par l'utilisation du plugin Citations.
Définir un raccourci-clavier pour l'insertion de notes biblio dans le texte (par exemple Ctrl + Maj + E)
Au moyen de ce raccourci-clavier, insérer les quatre appels de citation en lien et place des URL mentionnées ci-dessus.

A la fin de la note Markdown, ajouter un titre Références

Le plugin Zotero Integration

Le Plugin Zotero Integration est actuellement le plugin le plus populaire lié à Zotero sur Obsidian.
Pour l'installer, aller dans les plugins communautaires, chercher Zotero integration, installer le plugin et comme d'habitude : n'oubliez pas d'activiter les plugins que vous installez !

Dans votre coffre, créer un dossier où iront les notes exportées de zotero (par exemple zotero_notes)

dans le menu "database", choisir Zotero
dans note import location, indiquer le chemin vers ce dossier que vous venez de créer (zotero_notes)

Dans le format de citation, vous pouvez laisser le nom du format (format #1). Choisir ensuite "pandoc"

paramétrez les raccourcis clavier nécessaires pour le fonctionnement du plugin.

le plugin Pandoc Reference List

Ce plugin nécessite que pandoc soit bien installé sur la machine. Il permet d'afficher dans une colonne à droite de la note selon une norme bibliographique choisie par l'utilisateur, les références comprises dans la note et d'en faire une bibliographie normée.
Pour savoir, comment cela fonctionne, se reporter à la note Pandoc Reference List
Pandoc Reference List peut fonctionner en lien avec le plugin Citations ou bien avec le plugin Zotero Integration.

2.3 Export en PDF avec Pandoc

Si les étudiants n'ont pas pu ou souhaité télécharger la suite LaTeX indiquée, préciser qu'ils pourront tester Pandoc en lien avec LaTex au moyen des ordinateurs de la classe mobile
(préalable : vérifier avec la DSI que tous les logiciels nécessaires - pandoc, obsidian, suite LaTeX, Zotero- sont bien installés.)

Si ce n'est fait, faire installer Pandoc par les étudiants.
Présenter Pandoc et la manière de passer des commandes en Shell.
Faire une démo de démonstration simple (pandoc fichier_source.md -o fichier destination.htm)

On peut utiliser Pandoc pour convertir en même temps plusieurs fichiers ayant la même extension :

for f in *.odt; do pandoc "$f" -s -t markdown -o "${f%.odt}.md"; done

cette commande convertit tous les fichiers en open document qui se trouvent dans le répertoire en fichiers en markdown.

2.3.1 markdown vers html

rajouter l'argument Standalone pour que les images soient bien prises en compte pendant la conversion.

pandoc -s document.md -o document.html

Injecter du CSS lors de la conversion :

pandoc -s fichier_source.md -H feuille.css -o fichier_destination.html

Essayer avec la note "Jardins Numériques" et la feuille de style markdown2html.css

2.3.2 markdown vers pdf

rappeler qu'on peut faire un export en PDF d'une note depuis l'interface d'Obsidian mais que cet export ne pourra pas gérer les références héritées de Zotero.

On a au préalable téléchargé le style nature.csl depuis Zotero (lien direct) Dans cet exemple markdown.bib contient les références bibliographiques inscrites dans le texte de la note markdown.md

pdf-engine = choix du logiciel qui va assurer la conversion du markdown vers le PDF
-f = format de départ
-o = nom du fichier attendu comme résultat
--citeproc = package de pandoc qui va parser les références bibliographiques en bibtex
markdown+smart : signifie qu'on ajoute le composant smart à Markdown ; ce n'est pas du tout obligatoire, mais cela ajoute quelques fonctionnalités de plus (voir ici)

pandoc document.md
	--bibliography=markdown.bib
	--csl=nature.csl
	--pdf-engine=xelatex 
	--citeproc -f markdown+smart 
	-o document.pdf

Vous pouvez aussi tester le plugin d'Oliver Balfour Pandoc for Obsidianen le chargeant depuis les plugins communautaires.
Il vous faudra sans doute ajouter dans les paramètres le lien vers le fichier biblio et vers la feuille de style CSL pour que cela fonctionne bien.

2.3.3 Markdown vers un fichier Word en utilisant un template

Dans le cas d'une production de documents pour une entreprise ou un collectif par exemple, on n'a plus à se soucier de la mise en page : elle est réalisée à travers un document word qui sert de template.
On va rédiger librement du texte (sans s'encombrer l'esprit avec cette mise en page) et au final utiliser Pandoc pour convertir ce texte en format word mais en suivant le template de l'entreprise.

pandoc document.md --reference-doc=template.docx -o document.docx

faire un essai avec le template fourni dans le coffre : template.docx
Celui-ci se trouve dans le dossier assets, par conséquent il faudra ajuster la commande ci-dessus en fonction de cette localisation.
Essayer la conversion d'une note avec ce template.

2.4 What else ?

Pour finir, demander aux apprenants de parcourir la galerie des plugins communautaires et de chercher deux ou trois plugins à tester dont ils pensent qu'ils pourraient leur être utiles.
Leur proposer de les télécharger, activer et de les tester.

S'ils le préfèrent, leur proposer de parcourir les chapitres du mode d'emploi d'Obsidian et de s'arrêter aux passages qui les intéressent pour mettre en pratique ce qui vous est proposé dans ce guide.