class: center, middle # L'écriture académique au format texte ## Niveau avancé Dr Bernard Pochet, 2025 - CC-BY     .center[] --- .right[]     ### Apprendre Markdown (ou un autre format) ce n'est pas juste apprendre un nouveau langage mais c'est avant tout adhérer à de nouvelles méthodes et à de nouveaux outils, c'est décider de reprendre le contrôle. ### Adopter Markdown est donc un choix qui ne va pas nécessairement de soi. Il y a, dans un premier temps, des tâtonnements, des pertes de temps pour résoudre un problème particulier, des renoncements mais, à l'arrivée, le gain de temps et de liberté est évident --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 1. Typora 2. Ghoswriter 3. Joplin 4. Nexcloud 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. Faire une présentation 1. avec Beamer 2. avec Remark.js 7. Rédiger un Curriculum 8. Projet de livre en cours --- **Schéma de base des fichiers et programmes** :  --- **Sur OpenSolution.be et dans le manuel** :  --- .right[] # Les bases       ## Avant d'aller plus loin, avez-vous une question sur les bases de Markdown ? --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. **Critiques de Markdown** 3. Présentation plus en détail de quatre outils : 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. Faire une présentation 7. Rédiger un Curriculum 8. Projet de livre en cours --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes 3. la légèreté 4. la complexité 5. le coût du changement --- .right[] # 2. Les critiques 1. les différentes versions - on dénombre actuellement **35 varantes** (*flavors*) - il y a en fait **quatre grandes familles** (Markdown Extra, Github Markdown, Vanilla Flavored Markdown et MultiMarkdown) - les varantes sont fonction de **communautés** (d'utilisateurs) **spécifiques** - les **balises de base** (*CommonMark*) sont toujours les mêmes --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes - Markdown, vu le nombre d'utilisateurs et d'utilisations est devenu un **standard de fait** - il y a eu un gros travail autour du *Commonmark* pour définir des **spécifications techniques solides** - il faut considérer Markdown comme un **outil pour produire des documents** qui eux répondent à des normes et des standards (html, ePub, pdf, odt…) - il y a néanmoins des **tentatives de normalisation** mais non encore abouties --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes 3. la légèreté - la critique porte sur le **Markdown original** qui ne contient que quelques balises (pour rappel, dans le but de faciliter la production de pages html) - avec les développements et l'**utilisation de *LaTeX***, Markdown n'a rien à envier aux traitements de texte --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes 3. la légèreté 4. la complexité - la critique porte surtout sur l'utilisation de la **ligne de commande** dans un terminal - le problème vient d'une diminution sensible des **compétences numériques**… il est pourtant indispensable de : - comprendre l’organisation de son disque dur (programmes, dossiers et fichiers) ; - savoir où se trouvent les documents (fichiers) que l’on utilise ; - savoir renommer et déplacer des fichiers et des dossiers ; - savoir installer un programme et le lancer ; - savoir comment télécharger des fichiers, les compresser et les décompresser. - l'**impératif fonctionnel** imposé par les GAFAM ("il faut que ça marche" et "on s'occupe de tout") a réduit ces compétences au minimum … avec Markdown, il faut nécessairement reprendre le contrôle et reprendre la main --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes 3. la légèreté 4. la complexité 5. le coût du changement quitter un logiciel et des habitudes a un coût : - prendre le temps de comprendre, chercher, installer, tester, configurer - réorganiser/changer ses outils et ses méthodes --- .right[] # 2. Les critiques 1. les différentes versions 2. l'absence de normes 3. la légèreté 4. la complexité 5. le coût du changement     .center[**Vous en pensez quoi ?**] --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. **Présentation plus en détail de quatre outils :** 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. Faire une présentation 7. Rédiger un Curriculum 8. Projet de livre en cours --- .right[] # 3. Présentation plus en détail de quatre outils 1. Typora 2. Ghoswriter 3. Joplin 4. Nexcloud --- .right[] # 3. Présentation plus en détail de quatre outils 1. [Typora](https://typora.io/) - mode, interprété (mais possibilité d'affichage du code), sans distraction - utilise Pandoc mais pas *LaTeX* sauf pour Texmath (donc pas d'utilisation de YAML) - beaucoup d'options d'import et d'export - thèmes gérés via css (lié à html donc) - payant (14,99 $) 2. Ghoswriter 3. Joplin 4. Nexcloud --- .right[] # 3. Présentation plus en détail de quatre outils 1. Typora 2. [Ghoswriter](https://ghostwriter.kde.org/fr/) - logiciel libre, sans distraction, aperçu en deux colonnes (configurable) - choix du mode de transformation, dont Pandoc et *LaTeX* (utilisation de YAML + commandes directes) - thèmes configurables 3. Joplin 4. Nexcloud --- .right[] # 3. Présentation plus en détail de quatre outils 1. Typora 2. Ghoswriter 3. [Joplin](https://joplinapp.org/) - logiciel libre de prise de notes basé sur Markdown - synchronisation (avec Nextcloud par exemple) entre plusieurs appareils - partages, imports et exports 4. Nexcloud --- .right[] # 3. Présentation plus en détail de quatre outils 1. Typora 2. Ghoswriter 3. Joplin 4. [Nexcloud](https://nextcloud.com/fr/) - cloud personnel (remplace les outils GAFAM) - fichiers basés sur Markdown - partage de fichiers et dossiers - écriture collaborative et historique des changements (penser aussi aux [pads publics](https://pads.domainepublic.net/)) - chez [Zaclys.com](https://www.zaclys.com/quel-cloud-pour-mes-besoins/) = 1 € / mois pour 10 Gb (+ calendrier, mail, viso-conférence, sondage…) --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 4. **Utiliser *LaTeX* avec Markdown** 5. Rédiger un article 6. Faire une présentation 7. Rédiger un Curriculum 8. Projet de livre en cours --- .right[] # 4. Utiliser *LaTeX* avec Markdown *LaTeX* est un système de composition de documents, idéal pour les textes scientifiques et techniques. *LaTeX*, existe depuis 1982 et n’a pas cessé d’être amélioré. C'est une extension de *TeX* (langage de programmation de mise en page) créé en 1977. *LaTeX* produit des documents au rendu professionnel, avec une mise en page soignée : - contrôle précis de la typographie ; - composition de formules mathématiques complexes ; - gestion complexe (placement, index et numérotation) des figures et des tableaux ; - gestion des images vectorielles ; - création de bibliographies ; - tables des matières ; - renvois… --- .right[] # 4. Utiliser *LaTeX* avec Markdown *LaTeX* permet une séparation claire entre le **contenu** et la **mise en forme**. L'**entête** d'un document *LaTeX* permet de : - déclarer sa **classe** : article (par défaut), report, book, letter et beamer - ajouter des fonctionnalités avec un ou plusieurs **packages** (ou "paquets") - modifier l'**apparence** d'un document avec de nombreuses variables (taille des caractères, interligne…) - déclarer les **métadonnées** du document (titre, auteur…) Par ailleurs, dans le document, *LaTeX* autorise aussi de (très) nombreuses **commandes**.   **… néanmoins, un document *LaTeX* n'est pas simple à lire et à manipuler.** --- .right[] # 4. Utiliser *LaTeX* avec Markdown **Avec Markdown, on peut utiliser la puissance de *LaTeX* sans être confronté à sa complexité.** 1. les déclarations de l'entête *LaTeX* sont placées dans l'entête **YAML** du document Markdown. 2. certaines commandes sont utilisables directement via Markdown (exemple : \newpage ou \fbox{boite de texte}).   Voir tout ce qui est possible dans le [site compagnon du manuel](https://opensolution.be/mv2) "Markdown et vous" --- .right[] # 4. Utiliser *LaTeX* avec Markdown #### Exemple d'entête YAML : ``` --- # format du document documentclass: article header-includes: - \usepackage[french]{babel} - \usepackage{wallpaper} - \usepackage[sfdefault]{noto} geometry: - left=2.5cm - right=2.5cm - top=2.5cm - bottom=2.5cm - a4paper linestretch: 1.5 fontsize: 11pt toc: false toc depth: 2 numbersections: false ``` --- .right[] ``` # métadonnées title: Titre du document subtitle: Sous-titre du document author: Non, Prénom date: 2021 (cc-by) abstract: Ce court document est destiné à démontrer … keywords: Markdown, rédiger right: CC-BY 0.4 # liens links-as-notes: true linkcolor: green urlcolor: blue # bibliographie bibliography: library.bib csl: apa.csl --- ``` --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 4. Utiliser *LaTeX* avec Markdown 5. **Rédiger un article** 6. Faire une présentation 7. Rédiger un Curriculum 8. Projet de livre en cours --- .right[] # 5. Rédiger un article ## Format Le principe de base, est de rédiger cet article en suivant le guide des auteurs de la revue à laquelle l'article va être soumis. Il est en effet essentiel, dès le départ, de : - choisir la revue (pour rédiger directement avec les bonnes instructions) ; - décider de la liste des auteurs (pour éviter de mauvaises surprises par la suite). Dans la majorité des cas, les instructions demanderont : - de fournir un document au format **.docx** ; - de fournir un titre (et éventuellement un titre court pour l'en-tête), en français et en anglais ; - de rédiger un résumé (le plus souvent structuré) en français et en anglais ; - de fournir des mots-clés et des keywords ; - de structurer l'article (par exemple, pour un article STM, au format IMReD ; - de préciser, pour chaque autrice et auteur, un identifiant [ORCiD](https://orcid.org/) et l'apport individuel en utilisant éventuellement la taxonomie [CReDiT](https://credit.niso.org/). --- .right[] # 5. Rédiger un article ## Bibliographie La liste bibliographique et les citations dans le texte constituent des éléments essentiels d'un article scientifique. L'utilisation du format *Pandoc Markdown* est particulièrement puissant à ce propos. Pour rappel, il faut : - que deux fichiers bien spécifiques soient présents dans le même dossier : - un fichier **BibTex** créé avec un gestionnaire bibliographique (Zotero par exemple) - le fichier **csl** (*Citation Stype Language*) correspondant au style bibliographique (préconisé par la revue) - que ces deux fichiers soient renseignés dans l’en-tête YAML --- .right[] # 5. Rédiger un article ## Modèle - on choisit la classe *article* ; - pour améliorer la lisibilité, on veille à choisir un interligne supérieur à la valeur par défaut (ici 1,5 au lieu de 1) et on choisit un caractère de 12 ; - on n'utilise pas le paquet **orcidlink** parce qu'il ne fonctionne pas pour les exports **.docx** (on va néanmoins introduire le n° ORCiD au début de l'affiliation qui apparaît en note pour chaque auteur) ; - on va mettre le résumé dans les deux langues et les mots-clés dans les deux langues en dehors de l'en-tête YAML (avec les métadonnées YAML, on ne gère qu'une seule langue à la fois), au début du texte. Pour l'interligne et la taille des caractères, il faudra de toutes façons se conformer aux instructions de l'éditeur. S'il fournit un modèle .DOCX, on pourra l'utiliser pour "formater" le manuscrit envoyé. --- .right[] # 5. Rédiger un article (entête YAML) ``` --- documentclass: article header-includes: - \usepackage[french]{babel} title: Titre author: - Auteur1^[Orcid1, université 1] - Auteur2^[Orcid2, université 2] date: 2025 right: CC-BY geometry: - left=2cm - right=2cm - top=2cm - bottom=2cm - a4paper linestretch: 1.5 fontsize: 12pt bibliography: library.bib csl: apa.csl --- ``` --- .right[] # 5. Rédiger un article (contenu) ``` ## Résumé ## Abstract ## mots-clés ## Keywords # Introduction # Matériel et méthode # Résultats # Discussion/conclusion # remerciements # Bibliographie ``` --- .right[] # 5. Rédiger un article (pandoc)  ---     ### Vous pouvez tester ce modèle (et les suivants) 1. téléchargez le fichier [https://opensolution.be/docs/modelesmd.zip](https://opensolution.be/docs/modelesmd.zip) 2. décompressez les fichiers (4 dossiers) sur votre disque dur (choisissez bien l'emplacement) 3. allez dans le dossier /modelesmd/article/ 4. pour ce premier modèle, ouvrez les fichiers - article.md - article.docx - article.pdf 5. modifiez à votre aise le fichier article.md 6. re-générez les fichiers pdf et docx avec : - pandoc --citeproc article.md -o article.pdf - pandoc --citeproc article.md -o article.docx    Pandoc et *LaTeX* doivent [être installés](https://opensolution.be/site/installer/) --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. **Faire une présentation** 7. Rédiger un Curriculum 8. Projet de livre en cours --- .right[] # 6. Faire une présentation 1. avec **Beamer** (*LaTeX*) 2. avec **Remark.js** (*Javascript*) --- .right[] # 6. Faire une présentation *Beamer* Pour pouvoir produire une présentation sous forme de diapositives, on doit activer ***Beamer*** (géré par *LaTeX*). *Beamer* propose une série de **thèmes** qui modifient la couleur, les styles et la disposition des informations sur la page. Les deux exemples qui suivent utilisent le *theme* **Madrid** et le *colortheme* **seahorse**) --- .right[] # 6. Faire une présentation *Beamer* (thèmes)  --- .right[] # 6. Faire une présentation *Beamer* ## Les commandes de base - “#” pour créer une nouvelle page avec un titre courant (qui suit le signe “#” dans la source) ; - "\-\-\-” (trois tirets) pour créer une nouvelle page sans titre ; - “##” pour créer un bloc (avec cadre pour certains thèmes) dans une diapositive ; - “. . .” (trois points séparés par une espace) pour créer une pause dans la présentation. *Beamer* va créer autant de pages qu’il y a de pauses (un “clic” pour afficher la suite de la page. C’est la seule animation possible). --- .right[] # 6. Faire une présentation *Beamer* ## Les commandes de base Le texte est aligné à gauche. Les images sont alignées à gauche et automatiquement redimensionnées si elles dépassent le cadre. S'il y a une légende (!\[légende\](image.png)), l’image est alors centrée. Il est possible de réduire la taille des images avec la commande { width=50% }. Les tableaux sont bien reproduits. Les équations également. Pour exporter : **pandoc -t beamer votrefichier.md -o votrefichier.pdf** --- .right[] # 6. Faire une présentation *Beamer* ## L'entête YAML ``` --- title: How to search and organize documents? subtitle: author: Bernard Pochet, PhD (ULiège Library) date: 2021 (cc-by) output: beamer_presentation theme: Madrid colortheme: seahorse fontsize: 10pt aspectratio: 169 titlegraphic: ull.png logo: linkcolor: blue --- ``` ---  --- .right[] # 6. Faire une présentation *Beamer* ## La première diapositive ``` # What is the best way to ask a question? Doing a literature search is not « looking for information about. » ## You must : – start with a question (a sentence with a « ? ») – to obtain an answer(s) to this question ## Therefore : – write a « real question » – identify the concepts present in this question – search for the keywords related to these concepts – write the documentary question ``` ---  ---       .center[**Testez maintenant ce modèle**] --- .right[] # 6. Faire une présentation avec Remark.js - création de diaporamas encore plus légère et simple - basé sur le format *Github flavor Markdown* (moins complet que *Pandoc Markdown*) - le fichier est directement interprété par le navigateur web (*Firefox, Chrome*…). On peut introduire - des images - des fonds d'écran - des liens - des listes - des tableaux. L'ensemble des commandes possibles est décrit sur le [wiki du projet](https://github.com/gnab/remark/wiki). --- .right[] # 6. Faire une présentation avec Remark.js On crée un fichier **index.html** avec du code (quelques lignes) *Javascript* - au début - à la fin. On ajoute nos diapositives (en Markdown) entre les deux.   Avec Remark.js, on n'utilise pas Pandoc et il ne faut rien installer (mais être connecté pour l'appel JavaScript). Le fichier (html) reste sur notre ordinateur ou peut être déposé sur un serveur (c'est le cas des diapositives présentées actuellement). Il est possible d'imprimer (au format pdf, depuis le navigateur) cette présentation pour la partager. --- .right[] # 6. Faire une présentation avec Remark.js (code du debut) ``` <!DOCTYPE html> <html> <head> <title>Titre</title> <meta charset="utf-8"> <style> @import url(https://fonts.googleapis.com/css?family=Yanone+Kaffeesatz); @import url(https://fonts.googleapis.com/css?family=Droid+Serif:400,700,400italic); @import url(https://fonts.googleapis.com/css?family=Ubuntu+Mono:400,700,400italic); body { font-family: 'Droid Serif'; } h1, h2, h3 { font-family: 'Yanone Kaffeesatz'; font-weight: normal; } .remark-code, .remark-inline-code { font-family: 'Ubuntu Mono'; } </style> </head> <body> <textarea id="source"> ``` --- .right[] # 6. Faire une présentation avec Remark.js (code à la fin) ``` < /textarea> <script src="https://remarkjs.com/downloads/remark-latest.min.js"> </script> <script> var slideshow = remark.create({ratio: '16:9'}); </script> </body> </html> ``` --- .right[] # 6. Faire une présentation avec Remark.js (entre les deux) ``` class: center, middle # Titre ## Sous-titre date --- # Diapositive 1 Liste : - un - deux - trois .center[] --- # Diapositive 2 ## Premier sous-titre texte ## Deuxième sous-titre texte ``` --- class: center, middle # Titre ## Sous-titre date --- # Diapositive 1 Liste : - un - deux - trois .center[] --- # Diapositive 2 ## Premier sous-titre texte ## Deuxième sous-titre texte ---       .center[**Testez maintenant ce modèle**] --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. Faire une présentation 7. **Rédiger un Curriculum** 8. Projet de livre en cours --- .right[] # 7. Rédiger un Curriculum Comme il s'agit d'un document en une ou deux pages (ce qui est demandé par les employeurs), on va choisir la classe *article*. On va également choisir un rendu sobre. Dans ce modèle, rien de particulier si ce n'est l'utilisation : - du paquet **orcidlink** - l'ajout d'une photographie (en haut, à droite) avec le paquet **wallpaper** - le choix de la police de caractères **Noto**, plus élégante que la police par défaut. --- .right[] # 7. Rédiger un Curriculum (l'entête YAML) ``` --- documentclass: article header-includes: - \usepackage[french]{babel} - \usepackage{orcidlink} - \usepackage{wallpaper} - \usepackage[sfdefault]{noto} geometry: - a4paper - top=2.5cm - bottom=2cm - left=2.5cm - right=2.5cm right: CC-BY fontsize: 12pt linkcolor: blue --- ``` --- .right[] # 7. Rédiger un Curriculum (le contenu) ``` \ThisURCornerWallPaper{0.2}{personne.jpg} # Curriculum Vitae -- Nom Prénom \orcidlink{0000-0001-0002-0003} né le 1 janvier 1980 à Pétaouchnok\ nationalité : européen\ état civil : pas marié, pas d'enfant\ courriel : non.prenom@mailo.fr\ Mastodon : https://mastodon.zaclys.com/\@nomp\ LinkedIn : https://be.linkedin.com/in/nomp\ Blog : https://monblog.org --- ## 1. Diplômes universitaires - Master … ; - Doctorat en …. ## 2. Autres diplômes - … ## 3. Emplois - … ``` --- ``` ### Autres mandats : - … (dates) ### Anciens mandats ou activités significatives : - … (dates) ## 4. Autres activités et hobbies - … ## 5. Publications (et activités de recherche) - … ## 6. Compétences linguistiques Langue maternelle : français autres langues : - Anglais : ABCD - Néerlandais : ABCD - Espagnol : ABCD ### Résumé des domaines d'expertise - … ### Coordonnées privées : 4, rue du Machin\ 01235140 Houtsiplou (Europe)\ tél. : +12(0)34 56 78 90\ Courriel : [non.prenom@mailo.fr](mailto:non.prenom@mailo.fr) ### Coordonnées professionnelles : Université Machin-chose\ …\ …\ tél. : …\ Courriel : [non.prenom@umchosec.eu](non.prenom@umchosec.eu) ``` --- .right[]  ---       .center[**Testez maintenant ce modèle**] --- .right[] # Programme 1. Rappel des notions de base + Q/R 2. Critiques de Markdown 3. Présentation plus en détail de quatre outils : 4. Utiliser *LaTeX* avec Markdown 5. Rédiger un article 6. Faire une présentation 7. Rédiger un Curriculum 8. **Projet de livre en cours** --- .right[] # 8. Projet de livre en cours Un exemple d'utilisation de Pandoc-Markdown (associé à *LaTeX* donc) pour un document complexe exporté dans plusieurs formats : - nouvelle édition revue et augmentée de Markdown & vous - projet avec 31 fichiers Markdown numérotés (+ fichier .bib, fichier .csl et images) - fichiers déposés sur NexCloud pour pouvoir être partagés (relectures, corrections…) - export en html, pdf, docx… = *single Source Publishing* --- ## 8. Projet de livre en cours : 33 fichiers et 61 images  --- ## 8. Projet de livre en cours : entête YAML dans un fichier spécifique  --- ## 8. Projet de livre en cours : une seule commande pour générer le pdf  --- ## 8. Projet de livre en cours : la table des matières du pdf  --- .right[] # En définitive… Markdown, c'est : - **simplicité et accessibilité** : la syntaxe simple de Markdown permet aux utilisateurs de se concentrer sur le contenu plutôt que sur la mise en forme ; - **compatibilité et pérennité** : les fichiers Markdown sont des fichiers au format texte, ce qui assure leur lisibilité à long terme et leur compatibilité avec divers systèmes ; - **intégration avec les outils de recherche** : Markdown s'intègre bien avec des outils comme Zotero pour la gestion des références bibliographiques ou avec R pour le travail statistique ; - **flexibilité de publication** : les documents Markdown peuvent être facilement convertis en divers formats (HTML, PDF, DOCX) à l'aide d'outils comme Pandoc ; - **puissance et qualité** : Pandoc utilise *LaTeX* pour produire des documents pdf. Il permet d’ajouter de nombreuses fonctions proposées par *LaTeX* (équations , tableaux, bibliographie...) sans avoir à maîtriser sa complexité ; - **collaboration et contrôle de version** : l'utilisation de Markdown facilite la collaboration et le suivi des modifications, notamment via des plateformes comme GitHub ; - **portabilité et indépendance** : Markdown libère les chercheurs de la dépendance à des logiciels propriétaires spécifiques, permettant l'utilisation de divers éditeurs de texte. Mais adopter Markdown est donc un choix qui ne va pas nécessairement de soi. --- .right[] ## Ce que vous retenez de cette formation ? --- .right[] ## Ce que vous retenez de cette formation ? ## Ce qui vous a le plus intéressé ? --- .right[] ## Ce que vous retenez de cette formation ? ## Ce qui vous a le plus intéressé ? ## Ce que vous souhaitez que je réexplique ? --- .right[] ## Ce que vous retenez de cette formation ? ## Ce qui vous a le plus intéressé ? ## Ce que vous souhaitez que je réexplique ? ## Allez-vous utiliser *Markdown* à l'avenir (ou l'utilisez vous déjà) ? --- .right[]           .center[**Ces slides ont été rédigés en *Markdown* dans un fichier .html avec la technologie remark.js**] .center[(pressez ctrl-u pour voir le code source)]   .center[**Merci pour votre participation !**]