Introduction
Ce document de référence contient tous les éléments de syntaxe qui doivent être respectés dans l'écriture des métadonnées des articles d'Ecrisoi.
Les métadonnées
Les métadonnées sont des données qui permettent aux articles d'être générés correctement. Elles doivent donc être précisées en plus du texte de l'article.
La zone YAML
- Tous les articles doivent comporter une zone YAML.
Il s'agit d'une partie au début de tous les articles qui commence par :
---et se termine par :
---- Cette zone YAML doit commencer à la première ligne de l'article.
Les entrées et les valeurs
- Toutes les métadonnées sont écrites dans cette zone. Il est nécessaire d'avoir au moins la mention du titre. Cette zone doit commencer à la première ligne.
---
title: "un titre"
---Notez bien les minuscules, les guillemets et l'espace après les deux points. Ces éléments sont sensibles, leur altération engendre des erreurs. Il s'agit ici d'une syntaxe particulière que l'on appelle le YAML et qui vient en plus du Markdown. Le YAML se charge des métadonnées et donc du traitement sur les données.
Si vous oubliez de préciser ce titre, il sera généré automatiquement depuis le nom de votre article.
Si vous ne souhaitez pas mettre de valeur, vous devez placer deux guillemets vides.
---
title: ""
---Entrée avec | (pipe)
De la même manière les métadonnées peuvent contenir une entrée du type :
reference: |Le dernier caractère ,« | », appelé pipe en anglais dans un contexte de programmation et qui correspond à la barre verticale en français, introduit généralement du texte long. Par exemple :
summary: |
Entretien avec Clare Brant et Max Saunders, par Jean-Louis Jeannelle
(Sorbonne Université) et Bruno Tribout (University of Aberdeen) --
Automne 2021Notez bien la présence habituelle de l'espace après le signe de ponctuation double (:). Ce pipe appelle un retour à la ligne (avec la touche entrée par exemple). Toutes les lignes qui appartiennent ici au summary doivent alors débuter ensuite par deux espaces.
À la fin de ce texte toutes les entrées qui suivent retrouvent une indentation normale le long du bord de la marge de gauche.
summary: |
Entretien avec Clare Brant et Max Saunders, par Jean-Louis Jeannelle
(Sorbonne Université) et Bruno Tribout (University of Aberdeen) --
Automne 2021
image: "https://api.nakala.fr/data/10.34847/nkl.ab031tocEntrée avec - (tiret)
Parmi les métadonnées, il est possible de trouver des entrées sous la forme de liste :
keywords:
- "Archive"
- "Autobiografiction"
- "Autobiographie"
- "Autobiography"
- "Autofiction"
- "Biographie"
- "Biographie de groupe"
- "Blogs"
- "Correspondance"
- "Diary"
- "Digital Subjectivity"
- "Eco-Narrative"
- "Egodocument"
- "Ego Media"
- "Journal d’écrivain"
- "Life"
- "Life History"
- "Life Narrative"
- "Life Writing"
- "Memoir"
- "Mémoire"
- "Mémoires"
- "Numérique"
- "Récit de vie"
- "Self-Biography"
- "Vie"
- "Vie médicale"
- "Vlog"Il est alors nécessaire de faire un retour à la ligne après le signe de ponctuation double. Toutes les entrées entre guillemets doivent ensuite commencer par un tiret (-) précédé de deux espaces et suivi d'un retour à la ligne.
index_authors:
- "Austen Jane"
- "Coleridge-Taylor Samuel"À la suite de cette liste, les métadonnées suivantes retrouvent une indentation normale le long du bord de la marge de gauche.
- "Woolf Virginia"
index_theoreticians:Si jamais la liste ne connaît pas de valeurs, vous devez placer deux crochets vides
index_authors: []Les métadonnées spécifiques des corpus
Les différentes sections du site sont produites depuis les différents corpus de stylo. Il existe donc un corpus critiques_comptes-rendus qui contient l'intégralité des pages de cette section du site.
Chaque corpus et donc chaque section a besoin de ses propres métadonnées. Ces métadonées permettent de produire notamment les informations présentes sur les pages web du site, par exemple les mots-clés.
Il est nécessaire que toutes ces métadonnées soient présentes. Par exemple pour l'article ecrisoi_critiques_entretien_brant-saunders_fr_trad, ces métadonnées sont :
---
title: "Conversation avec Clare Brant et Max Saunders, membres fondateurs et co-directeurs du Centre for Life-Writing Research (King’s College London)"
interviewers:
- "Jean-Louis Jeannelle"
- "Bruno Tribout"
translators:
- "Bruno Tribout"
guests:
- "Clare Brant"
- "Max Saunders"
date: "22 septembre 2021"
lang: "fr"
summary: |
Entretien avec Clare Brant et Max Saunders, par Jean-Louis Jeannelle
(Sorbonne Université) et Bruno Tribout (University of Aberdeen) --
Automne 2021
image: "https://api.nakala.fr/data/10.34847/nkl.ab031toc/43fc6b63fc5ef4034c88228c5da7104f1e6d5534"
keywords:
- "Archive"
- "Autobiografiction"
- "Autobiographie"
- "Autobiography"
- "Autofiction"
- "Biographie"
- "Biographie de groupe"
- "Blogs"
- "Correspondance"
- "Diary"
- "Digital Subjectivity"
- "Eco-Narrative"
- "Egodocument"
- "Ego Media"
- "Journal d’écrivain"
- "Life"
- "Life History"
- "Life Narrative"
- "Life Writing"
- "Memoir"
- "Mémoire"
- "Mémoires"
- "Numérique"
- "Récit de vie"
- "Self-Biography"
- "Vie"
- "Vie médicale"
- "Vlog"
index_authors:
- "Austen Jane"
- "Coleridge-Taylor Samuel"
- "Ford Ford Madox"
- "Gray John"
- "Huntington William"
- "Joyce James"
- "Proust Marcel"
- "Reynolds Stephen"
- "Tennyson Alfred"
- "Woolf Virginia"
index_theoreticians:
- "Brant Clare"
- "Saunders Max"
---Mais les métadonnées d'une autre section du site sont différentes et ne peuvent pas être interchangées.
Vous retrouvrez au sein cette documentation toutes les métadonnées spécifiques à chacune des sections du site. Ces informations indispensables sont situées au sein de leur développement propre. Par exemple, en ce qui concerne les Entretiens, vous retrouvez à l'adresse https://documentation-e8bdfe.gitpages.huma-num.fr/Critiques/entretiens/#2.1.-Mod%C3%A8le-standard-des-entretiens le modèle type de métadonnées prêt à être copié-collé au tout début d'un nouvel article sur Stylo qui appartiendrait à ce corpus avec l'ensemble des métadonnées indispensables à la bonne mise en page des articles.