Les meilleurs plugins d'obsidienne pour l'écriture académique

May 10 2023

En tant qu'étudiant universitaire, vous avez besoin d'outils spécialisés qui vous permettent de produire des rapports de laboratoire, des essais et des revues de littérature de qualité supérieure. Vous devez être capable de gérer de longs manuscrits, des références, la mise en forme et le rendu d'une sortie d'un document. Il existe une sélection d'outils qui peuvent être organisés pour réaliser tout ce qui suit, mais il est difficile de construire un système où toutes les parties séparées se parlent de manière transparente pour éliminer les frictions liées à la création d'une sortie. Dans cet article, je vais parler de mon système d'écriture académique dans Obsidian et expliquer les étapes que vous pouvez suivre pour mettre en œuvre vous-même certains des outils.

Conservation et gestion de référence

Dans la rédaction académique, chaque fait doit être vérifié et référencé à partir d'autres recherches, ce qui nécessite un moyen de gérer tout le contenu que vous lisez et dont vous obtenez un aperçu. Il existe des logiciels de gestion de références capables de gérer les métadonnées et les PDF et d'exporter ces informations vers un fichier référencé par Obsidian.

À mon avis, la meilleure option, et celle que j'utilise pour le travail, est Zotero. C'est gratuit et open source, et fait très bien le travail à accomplir. Il dispose d'une extension de navigateur qui importe les métadonnées et le texte intégral en PDF d'un simple clic tant que vous êtes sur la page du journal de la ressource à laquelle vous faites référence.

Tout comme dans Obsidian, vous pouvez ajouter des plugins à Zotero qui étendent ses fonctionnalités pour mieux s'intégrer à votre environnement d'écriture (Obsidian dans ce cas). Les plugins Zotero que j'utilise sont Zotfile et Better BibTeX. Zotfile vous permet de gérer les citekeys et les fichiers de différentes entrées dans votre base de données. Il permet de créer des liens vers des fichiers stockés en dehors de l'environnement Zotero, ouvrant ainsi des capacités de synchronisation avec d'autres services. Better BibTeX crée un fichier de sortie .bib du contenu de votre bibliothèque, qu'il met constamment à jour lorsque la bibliothèque le fait.

Ce fichier .bib peut être référencé par Obsidian en utilisant le plugin Citations. Ce plugin vous permet de générer des entrées de notes de littérature dans Obsidian pour les fichiers de votre bibliothèque Zotero, générant un fichier contenant toutes vos annotations ou toutes vos notes sur cette ressource. Les citations facilitent également l'insertion de citations de démarquage dans votre script lors du processus d'écriture - vous pouvez lier l'invite d'ouverture modale à un raccourci clavier et rechercher facilement l'ensemble de votre bibliothèque Zotero avec une seule commande, en insérant la référence correcte dans le bon format dans votre texte lors de l'écriture.

Rédaction des manuscrits

Il existe plusieurs plugins dans Obsidian qui améliorent l'expérience lorsque vous écrivez votre contenu académique. Les objectifs qu'ils servent vont de la gestion de longs scripts à l'aide avec des caractères spéciaux au formatage de votre écriture. Bien que je ne l'utilise pas activement, j'ai expérimenté le plugin Longform, qui est conçu pour gérer des sections d'un script plus long, et peut voir l'utilité de pouvoir éditer différentes sections d'un texte dans des fichiers individuels et compiler un manuscrit complet une fois le brouillon terminé.

Un plugin que j'utilise est Latex Suite. Cela fournit une suite d'extraits de clavier qui aident à écrire des équations, des formules et des symboles en utilisant la syntaxe LaTeX. Ceci est particulièrement utile lorsque votre écriture concerne un sujet scientifique ou mathématique, car cela s'accompagne souvent d'une notation légèrement plus complexe. Le plugin Linter effectue des actions de formatage sur vos notes. Ceci est utile car cela signifie que la façon dont vous disposez vos notes reste cohérente, de sorte que le document qui est rendu à l'étape suivante semble présentable et bien rangé.

Génération du document

C'est l'étape la plus complexe, mais une fois qu'elle a été configurée pour que vous puissiez l'utiliser une fois, vous allez réaliser la puissance d'avoir construit le système que j'ai décrit dans cet article, car pendant que vos pairs ont du mal à insérer des citations , formatage des graphiques et des figures et conversion aux formats requis, vous allez avoir une commande qui ouvre un menu d'options pour la sortie à prendre. C'est ça. Les plugins se chargeront de la conversion, de l'insertion des références, du formatage et de tout le reste pour vous.

Pour ce faire, vous devez installer quelques logiciels trouvés en dehors d'Obsidian. Le premier est Pandoc, qui est un outil qui convertit presque tous les formats de fichiers en presque tous les autres formats de fichiers. L'autre est toute distribution $LaTeX$, car Pandoc utilise certains packages $LaTeX$ pour rendre les fichiers en sortie .pdf. Une fois ces deux logiciels installés, vous pouvez configurer Obsidian pour rendre le script.

Le plugin Pandoc dans Obsidian vous donne une interface avec Pandoc, qui est normalement un outil CLI. Vous pouvez sélectionner différents formats pour transformer le fichier Obsidian .md actuel en, y compris .docx, .html et .pdf, qui sont les plus utiles. Vous pouvez spécifier des arguments Pandoc pour personnaliser cette sortie selon vos besoins, ce que nous ferons. Dans les paramètres du plug-in Pandoc, ajoutez - citeproc au paramètre 'Extra Pandoc arguments'. Ce sera ce qui prend les citations de démarquage et les convertit en citations dans le texte dans le processus de conversion. Il insère également automatiquement une liste de références complète à la fin de votre document, le tout entièrement formaté. Pour que cela fonctionne, vous devez spécifier l'emplacement du fichier .bib sur votre système en ajoutant le chemin, entre guillemets, à une propriété YAML "bibliographie".

J'utilise ce système ci-dessus pour convertir mes manuscrits, que j'écris en obsidienne, en documents PDF bien formatés que je peux soumettre pour mes devoirs.

Suppléments

Il y a d'autres choses que vous pouvez faire pour étendre les fonctionnalités de ce système, qui ne sont pas essentielles, donc je ne les ai pas mentionnées dans le guide de flux de travail principal. Une chose est de spécifier le langage de style de citation (CSL) pour changer la façon dont les références sont formatées. Ceci est important si vous avez une CSL spécifique qui est obligatoire pour l'écriture qui est soumise. Vous pouvez trouver le fichier nécessaire, avec l'extension .csl en ligne et le télécharger, en l'utilisant dans le document en spécifiant le chemin du fichier sous une propriété 'csl' dans le YAML, identique à la bibliographie.

J'ai une autre petite différence dans mon flux de travail pour les rapports de laboratoire. Parce que ceux-ci m'obligent à inclure mes propres chiffres pour les données que j'ai collectées dans mes recherches, j'utilise le plugin qmd as md afin d'éditer les documents Quarto de la même manière que les documents de démarquage dans Obsidian. En combinant cela avec le plugin Shell Commands, je peux inclure du code R dans mes scripts et les rendre en tracés parfaits dans une sortie PDF en utilisant un raccourci clavier pour exécuter une commande shell directement depuis Obsidian. La grande majorité des gens n'auront pas besoin de ce type de fonctionnalité, j'ai donc décidé de l'inclure comme un supplément qui pourrait inspirer le petit nombre de personnes qui pourraient vouloir construire un système comme celui-ci.

Conclusion

Merci d'avoir lu cet article. J'espère qu'il vous a convaincu de l'avantage de construire un système intégré de gestion de la production d'écritures académiques. C'est pourquoi j'aime Obsidian en tant qu'outil - il est extrêmement flexible et peut être manipulé pour n'importe quel cas d'utilisation spécifique. Si vous avez appris quelque chose, applaudissez l'article et envisagez de suivre pour un contenu plus similaire. Merci encore!