Markdown : The Programming Historian

Le format markdown présente l’avantage d’être un langage à la syntaxe relativement simple et léger. Il permet aussi de s’affranchir, au moment de la rédaction, de la question du format de fichier. En effet, au moment de la publication vous pourrez enregistrer le texte et les images dans un certain nombre de format courant (.docx, .pdf, .html, .epub a titre d’exemple). Ce n’est pas un format de texte propriétaire et il est plus puissant que le format .txt.

Dans le cadre d’une série d’articles consacrés au format markdown et à la question de la maîtrise de nos données, je vous présente aujourd’hui The Programming Historian et leurs leçons qui pourront vous être utiles dans le cadre de votre « encapacitation » (empowerment).

Présentation

The Programming Historian est un collectif d’universitaire qui publie des tutoriels évalués par des pairs permettant l’initiation à et l’apprentissage d’un large éventail d’outils numériques, de techniques et de flux de travail pour faciliter la recherche et l’enseignement en sciences humaines et sociales.

Les tutoriels et leçons sont publiés en trois langues : anglais, espagnol et français. Concernant les équipes éditoriales, la page suivante présente leurs membres : https://programminghistorian.org/fr/equipe-projet.html.

Leçon 1 : Préserver ses données de recherche

Avant d’en venir aux leçons sur le Markdown, il paraît utile de commencer par la leçon relative à la préservation de ses données de recherche. Cette leçon donne des pistes aux historiens et aux historiennes pour documenter, structurer et pérenniser leurs données de recherche.

Cette leçon est l’oeuvre de James Baker, maître de conférences en histoire et archives numériques à l’Université du Sussex et au Sussex Humanities Lab.

S’appuyant sur les leçons et l’expertise de professionnels en données de la recherche, cette leçon suggère aux historiennes et aux historiens des moyens de documenter et de structurer leurs propres données de manière à ce qu’elles restent utilisables dans le futur. Il ne se veut pas normatif mais suppose que les lecteurs et lectrices itéreront, changeront et adapteront les idées présentées pour correspondre au mieux à leurs recherches.

James Baker cite, notamment à l’appui de ces propos, William Stafford Noble :

Le principe de base est simple: quelqu’un non familiarisé avec votre projet devrait être capable de consulter vos fichiers informatiques et de comprendre en détails ce que vous avez fait et pourquoi […] Cependant, le plus souvent ce « quelqu’un » c’est vous. Dans quelques mois, vous ne vous souviendrez peut-être plus de ce que vous faisiez lorsque vous avez créé un ensemble particulier de fichiers, ou des conclusions que vous avez tirées. Vous devrez alors passer du temps à reconstruire vos expériences précédentes ou perdre toutes les connaissances que vous aviez acquises de ces expériences.
William Stafford Noble (2009) A Quick Guide to Organizing Computational Biology Projects. PLoSComputBiol 5(7): e1000424. doi:10.1371/journal.pcbi.1000424

Après en avoir poser le cadre et la nécessité, la leçontraite des points suivants :
1. Formats des fichiers.
2. Structuration des données de la recherche.

Pour poursuivre : James Baker, «Préserver ses données de recherche,» traduction par Anne-Sophie Bessero-Lagarde, The Programming Historian en français 2 (2020), https://doi.org/10.46430/phfr0009.

Leçon 2 : Débuter avec Markdown

Dans cette deuxième leçon, Sarah Simpkin, bibliothécaire spécialisée en SIG, géographie et informatique à l’Université d’Ottawa, nous propose une introduction à Markdown, une syntaxe en texte brut pour le formatage de documents. Vous découvrirez pourquoi l’utiliser, comment formater des fichiers Markdown et comment prévisualiser de tels fichiers sur le web.
Développé en 2004 par John Gruber, Markdown est à la fois un langage de balisage de fichiers textes et une fonctionnalité du langage Perl permettant de convertir des fichiers Markdown en HTML.
Les fichiers texte brut présentent plusieurs avantages comparés aux autres formats. Non seulement ils sont compatibles avec tout type d’appareil et de système d’exploitation, mais ils s’avèrent aussi plus pérennes. Comme l’indique Sarah Simpkin,

Si jamais vous avez tenté d’ouvrir un document sauvegardé dans une version antérieure d’un logiciel de traitement de texte, vous pouvez comprendre facilement les problèmes de compatibilité qui sont en jeu.

L’utilisation de la syntaxe Markdown vous permettra de produire des fichiers à la fois lisibles en texte brut et prêts à recevoir davantage de traitement sur une autre plateforme. Plusieurs systèmes de gestion de blogs, des générateurs de sites web statiques ou encore des plateformes comme GitHub prennent en charge des fichiers Markdown pour les convertir en HTML et les publier sur le web.

Par ailleurs, j’ajouterai que les fichiers en texte brut, tel que Markdown, sont de taille très modeste et donc occupent peu de place sur vos supports de mémoire ou lors de leur transmission.

Dans ce tutoriel, vous pratiquerez concrètement la syntaxe Markdown directement depuis votre navigateur préféré en utilisant un éditeur en ligne (StackEdit)

A lire : Sarah Simpkin, «Débuter avec Markdown,» traduction par Sofia Papastamkou, The Programming Historian en français 2 (2020), https://doi.org/10.46430/phfr0007.

Pour ma part, j’utilise Markdown pour prendre mes notes ou rédiger mes articles avec Ulysses, réaliser mes présentations de colloque ou de séminaire sur hackmd.io, organiser une partie de ma veille en récupérant des publications en ligne à l’aide de DevonThink ou publier, comme ici, sur mon blog (WordPress) à l’aide d’Ulysses ou de Drafts.

Leçon 3 : Rédaction durable avec Pandoc et Markdown

Dans cette leçon, un peu plus technique, Dennis Tenen, professeur en littérature anglaise et comparée à l’Université Columbia, et Grant Wythoff, maître de conférences au département de littérature anglaise et comparée de l’Université Columbia, vous apprennent les notions de base de Markdown, une syntaxe de balisage facile à lire et écrire, ainsi que Pandoc, un outil en ligne de commande qui permet de convertir du texte brut en différents types de fichiers bien formatés: PDF, .docx, HTML, LaTeX, diaporama, et plus encore.
À l’aide de Pandoc comme outil de composition numérique, vous pouvez utiliser la syntaxe Markdown pour ajouter des figures ou une bibliographie, et changer facilement de style de citation, par exemple de Chicago à MLA, le tout en utilisant du texte brut.
Écrire ce cette façon libère l’auteur(e) de son outil. Vous pouvez écrire en Markdown dans n’importe quel éditeur de texte brut, et la syntaxe dispose d’un riche écosystème de logiciels qui peuvent transformer ces textes en de magnifiques documents. C’est pour cette raison que Markdown connaît actuellement une hausse de popularité, non seulement comme outil de rédaction d’articles scientifiques, mais aussi comme norme pour l’édition en général.
Influencés par diverses disciplines, Dennis Tenen et Grant Wythoff ont été guidés par les principes suivants:
1. Pérennité.
2. Priorité à la lisibilité humaine.
3. Séparation de la forme et du contenu.
4. Compatibilité avec la recherche universitaire.
5. Indépendance vis-à-vis des plateformes.

La leçon : Dennis Tenen et Grant Wythoff, «Rédaction durable avec Pandoc et Markdown,» traduction par Marie-Christine Boucher, The Programming Historian en français 2 (2020), https://doi.org/10.46430/phfr0013.

Nous sommes arrivés maintenant au terme de notre première leçon relativement au Markdown et à la maîtrise de nos données. To be continued…

%d blogueurs aiment cette page :