logo yaml

YAML

Ce billet est en cours d’écriture, les informations ne sont donc pas encore complètes.

Le YAML est un format simple de représentation de données conçu pour être lisible par des humains, tout en travaillant avec des langages de programmation (c’est presque la quadrature du cercle !). Dans le cadre du Markdown, le langage YAML est avant tout utilisé pour déclarer en en-tête des informations sur le fichier qui ne font pas partie du contenu à proprement parler, c’est-à-dire des métadonnées comme le nom de l’auteur, les mots-clés, ou le titre.

Exemple d’en-tête YAML. 

À savoir

Un certains nombres de paramètres d’affichage dépendent des déclarations du YAML. Par exemple, la création d’une bibliographie finale du document, d’une table des matières, mais aussi des éléments de ponctuations selons les normes anglaises ou françaises (citation, guillemets, etc.), il est donc important de compléter le YAML avant l’export. D’autres paramètres vont dépendre de Pandoc1.

La langue

Pour déclarer la langue, il faut utiliser des valeurs de la norme BCP-47. Elle est composée d’une première valeur qui indique la langue et d’une deuxième valeur pour indiquer la région. Les deux valeurs sont séparées par un tiret :

en-US pour l'anglais américain.

En plus d’intervenir au moment de l’export sur la ponctuation, cette variable contrôle la langue des éléments généré automatiquement comme, par exemple, le titre de la bibliographie2.

Quelques exemples de clés de langue

  • Allemand : de-DE
  • Anglais : en-GB ; en-US ; en-CA
  • Français : fr-FR ; fr-CA (Canada) ; fr-CH (Suisse) ; fr-BE (Belgique)
  • Espagnol : es-ES ; es-US ; es-MX (Mexique)
  • Italien : it-IT ; it-CH
  • Néerlandais : nl-BE ; nl-NL
  • Chinois : zh-CN ; sh-HK (Hong Kong) ; zh-TW (Taiwan)



Citer ce billet
Marine Parra et Benoît Roux (2023, 27 janvier). YAML. Eveille. Consulté le 20 avril 2024, à l’adresse https://doi.org/10.58079/ommw

  1. Voir à ce sujet les billets “Du markdown au word” ; “Du markdown au pdf” ; “Du markdown au html”. []
  2. Ce titre n’existe pas dans le corps du fichier md, il est ajouté si le YAML déclare une bibliographie finale []

Une réflexion sur « YAML »

  1. Ping : Le langage Markdown comme carrefour entre le texte, l’humain et la donnée – Dataflow

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *

Ce site utilise Akismet pour réduire les indésirables. En savoir plus sur comment les données de vos commentaires sont utilisées.