Ecriture académique / Arthur Perret === ###### tags: `Webinaire` Support : https://www.arthurperret.fr/2021-09-21-ecriture-academique-format-texte.html Démo : https://github.com/infologie/2021-09-21-ecriture-academique-format-texte Twitter : https://twitter.com/hashtag/apf2109?src=hashtag_click&f=live ## L'écriture académique avec des éditeurs de texte * **Ecriture académique** : besoins de structurer le texte, d'intégrer des types d'écritures différents, des citations, des figures * **Format texte** : alternative au format binaire, mais abus de langage, tout est binaire sur un ordinateur. Pour résumer, tout fichier qui peut s'ouvrir dans un éditeur de texte = format texte. * Cette formation : environnement d'un éditeur de texte * **Editeur de texte** : environnement dans lequel on affiche des caractères textuels, des suites, etc. Caractéristique importante : on va préciser le codage (écriture latine, unicode, ascii, etc.). Environnement dans lequel on peut accéder à ce format textuel et débrouiller le format d'encodage * Editeur facilite la vie : syntaxe est colorée, mais rien de plus en termes de mise en forme. Pas de gras ou d'italique (on peut l'ajouter suivant les éditeurs) * Contrairement au traitement de texte, dans un éditeur de texte, on peut avoir plusieurs modes pour un même fichier. * Editeurs cités : BBEdit, IAwriter, PanWriter * Certains éditeurs sont plutôt orientés codage, d'autres favorisent la concentration, etc. * Traitement de texte est inadapté à la communication sur le web, on ne se limite pas au ctrl+P... Format .doc est fermé, on perd l'accès à la donnée quand on n'a plus la licence du logiciel * docx : à l'intérieur de ce type de ficher, on trouve du xml (pour l'interopérabilité word / libre office). Format complexe pour rien et très lourd. * **pandoc** : permet une coexistence plus ou moins pacifique entre traitement de texte et éditeur de texte. Utiliser d'autres outils sans se couper des pratiques des collègues et des éditeurs. * **Avantages** inhérents au format texte : plus léger, peut être ouvert par une catégorie de logiciels libres, donc pas de risque de perte de données (mais on continue à sauvegarder, hein !), possibilité d'interopérabilité (on utilise les mêmes formats dans différents contextes logiciels). Beaucoup plus de choix d'écosystèmes d'outils : plateformes intégrées comme par exemple Authorea en ligne ; éditeurs à installer sur sa machine ; possibilités de visualiser les formats de sortie. * Autre avantage du format texte : on n'a plus le problème de quelque chose qui a l'apparence d'un titre mais qui n'est pas un titre. On repère immédiatement à la fois le fond et la forme. * **Inconvénients** du format texte : ça dépend des perspectives. Ce n'est pas plus ou moins simple que le traitement de texte. C'est plutôt un déplacement de son investissement. N'oublions pas que Word nous a tous demandé un apprentissage ! * **Conséquence** : ça redonne du temps de cerveau disponible pour améliorer le fond et y travailler sans distraction. On libère du temps pour travailler sur le fond. * Mise en forme : du format texte au format demandé par le destinataire, montée en compétence à faire. * Autre difficulté : pratique du format texte entre en conflit avec d'autres pratiques, comme le publipostage par exemple. * L'enfer, c'est les autres : "on va utiliser gdocs, hein" ;) * **HackMD, CodiMD** : outils attractifs, mais pas spécialisés pour l'écriture scientifique. * Distinction à faire entre des formats de balisage un peu lourds, xml et html, ou un format comme LaTeX. Formats d'écriture qui ne sont pas très agréables pour l'écriture. Chacun a son enfer à lui ;) Formats qu'on ne peut pas transformer facilement. * Pas de correcteur d'orthographe et de grammaire de base dans les éditeurs de texte, mais parfois des modules suivant les éditeurs * **LaTeX** : logiciel de composition pour une impression propre (Donald Knuth) * **html et md** : monde de la rédaction web ## Pandoc * **Couteau suisse des conversions**. * Témoin de pandoc ;) * Créé par un prof de philo, John MacFarlane * On peut utiliser pandoc avec plusieurs éditeurs : par exemple, PanWriter (permet de paginer du html !) * pandoc ne sert pas uniquement à convertir : pour convertir avec pandoc, il faut utiliser un md spécifiquement calibré pour pandoc, avec des balises spécifiques (celles des citations par exemple). ### Conversions de base dans le terminal * **Prérequis** : installer LaTeX, qui sera ensuite géré par pandoc. Seule dépendance de pandoc * Quand on convertit md > pdf, il utilise LaTeX (on le reconnaît à sa police Computer Modern avec ses énormes marges) * **Markdwon vers docx** ``` pandoc pouet.md -o pouet.docx ``` * Utilisation d'un **template** : on peut convertir md > docx et ajouter un template déjà prêt. ``` pandoc pouet.md -o pouet.docx --reference-doc=referecnce.docx ``` * Pour avoir un pdf avec du LaTeX propre, ajouter dans le **yaml** : ``` documentclass: scrartl number_sections: true ``` * Document avec **entête** ``` pandoc pouet-entete.md -o pouet-entete.docx --standalone ``` * Document avec **mise en page** ``` pandoc pouet-entete.md -o pouet-entete.pdf --number-sections --template=template.latex ``` * **Citations** : format en md, par exemple au format [@dupont2021] issu du fichier Zotero exporté en BibTex ``` pandoc article.md -article.pdf --citeproc --bibliography=references.bib pandoc article.md -article.pdf --citeproc --bibliography=references.bib --csl=styles.csl ``` ## Autres exemples sans passer par le Terminal ### Stylo * Interface web, assez austère * Intérêt du dispositif, on peut écrire dans son éditeur de prédilection sur sa machine ### Zettlr * Automatisation de la procédure, mais moins malléable ### Cosma * https://cosma.graphlab.fr/ * Modèle de fiche, exemple : ![](https://i.imgur.com/wX6uCx9.png) --- ## Ressources Atelier BU - Prendre des notes et rédiger en Markdown. https://atelier-markdown-uppa.netlify.app/#/. Consulté le 21 septembre 2021. Élaboration et conversion de documents avec Markdown et Pandoc. https://www.jdbonjour.ch/cours/markdown-pandoc/. Consulté le 21 septembre 2021. Frédéric Santos / meetup-orgmode-2021 · GitLab. https://gitlab.com/f-santos/meetup-orgmode-2021. Consulté le 21 septembre 2021. GitHub - jgm/pandoc-templates: Templates for pandoc, tagged to release. https://github.com/jgm/pandoc-templates. Consulté le 21 septembre 2021. L’écriture académique au format texte. https://www.arthurperret.fr/2021-09-21-ecriture-academique-format-texte.html. Consulté le 21 septembre 2021. Manubot - Manuscripts, open and automated. https://manubot.org/. Consulté le 21 septembre 2021. Pandoc - Pandoc User’s Guide. https://pandoc.org/MANUAL.html. Consulté le 21 septembre 2021. Raphael Kabo. https://raphaelkabo.com/blog/introducing-docdown/. Consulté le 21 septembre 2021. Rédaction durable avec Pandoc et Markdown | Programming Historian. https://programminghistorian.org/fr/lecons/redaction-durable-avec-pandoc-et-markdown. Consulté le 21 septembre 2021. vscode-reveal - Visual Studio Marketplace. https://marketplace.visualstudio.com/items?itemName=evilz.vscode-reveal. Consulté le 21 septembre 2021. ## Antisèches commandes ![](https://i.imgur.com/CtLMhPJ.png) ![](https://i.imgur.com/sWP5MuA.png) ![](https://i.imgur.com/T1Z855K.png) ![](https://i.imgur.com/Hfq8cVw.png)