Documentation à jour
This commit is contained in:
+7
-7
@@ -7,7 +7,7 @@ Le principe général est simple :
|
||||
- le front matter TOML contient les données brèves et structurées ;
|
||||
- le corps Markdown contient les explications, tableaux, exemples et commentaires ;
|
||||
- les champs prévus par un modèle restent présents, même lorsqu’ils sont vides ;
|
||||
- les champs vides ne sont pas affichés sur le site.
|
||||
- les champs optionnels vides sont généralement omis du rendu ; les champs structurels restent néanmoins présents dans le front matter.
|
||||
|
||||
Toutes les commandes sont exécutées depuis la racine du dépôt.
|
||||
|
||||
@@ -21,7 +21,7 @@ Toutes les commandes sont exécutées depuis la racine du dépôt.
|
||||
| Texte | `src/content/textes/` | `genres` |
|
||||
| Vocabulaire | `src/content/vocabulaire/` | `natures` |
|
||||
|
||||
La bibliographie et les mentions légales sont des pages autonomes placées directement dans `src/content/`.
|
||||
La bibliographie et les mentions légales sont des pages autonomes placées directement dans `src/content/`. Les trois scripts de fiches ne les créent, ne les modifient et ne les valident pas.
|
||||
|
||||
Chaque section contient un fichier `_index.md` qui définit son titre, sa description, son tri et ses templates. Ces index sont maintenus manuellement ; le générateur crée uniquement des pages de contenu.
|
||||
|
||||
@@ -40,7 +40,7 @@ Afficher les brouillons localement :
|
||||
zola --root src serve --drafts
|
||||
```
|
||||
|
||||
Contrôler les contenus avant publication :
|
||||
Contrôler la structure des fiches et la construction du site avant publication :
|
||||
|
||||
```sh
|
||||
./scripts/check-content.py
|
||||
@@ -149,7 +149,7 @@ draft = true
|
||||
Les tables propres au type de contenu viennent ensuite dans le même front matter.
|
||||
|
||||
- `title` est le titre affiché ;
|
||||
- `date` est l’horodatage de publication ;
|
||||
- `date` est l’horodatage initial de la fiche et sert de date de publication ;
|
||||
- `updated` est l’horodatage de la dernière modification substantielle ;
|
||||
- `description` est un résumé court, rédigé manuellement lorsqu’il est utile ;
|
||||
- `draft` détermine si la page est publiée.
|
||||
@@ -214,7 +214,7 @@ themes = ["morphologie nominale"]
|
||||
genres = ["lettre"]
|
||||
```
|
||||
|
||||
La graphie doit rester stable. Une fiche de vocabulaire contient exactement une nature. Les autres taxonomies peuvent contenir plusieurs termes lorsque cela est pertinent.
|
||||
La graphie doit rester stable. Une fiche de vocabulaire contient exactement une nature connue, car cette valeur sélectionne le modèle de champs à contrôler. Les autres taxonomies peuvent contenir plusieurs termes lorsque cela est pertinent.
|
||||
|
||||
## Fiches de vocabulaire
|
||||
|
||||
@@ -259,7 +259,7 @@ Chaque nature ajoute les champs suivants, dans l’ordre produit par le généra
|
||||
| Particule | `function` |
|
||||
| Numéral | `numeral_type`, `value`, `gender`, `feminine` |
|
||||
|
||||
Tous les champs simples restent des chaînes, même lorsqu’ils sont vides. Chaque fiche, brouillon compris, doit conserver tous les champs prévus pour sa nature. Le validateur contrôle leur présence et leur type, sans imposer de valeur non vide ni refuser d’éventuels champs supplémentaires. Le titre fournit déjà l’infinitif et ne le répète donc pas dans `[extra]`.
|
||||
Tous les champs simples restent des chaînes, même lorsqu’ils sont vides. Chaque fiche, brouillon compris, doit conserver tous les champs prévus pour sa nature. Le validateur contrôle leur présence et leur type, sans imposer de valeur non vide ni refuser d’éventuels champs supplémentaires. Pour un verbe, le titre fournit déjà l’infinitif et celui-ci n’est donc pas répété dans `[extra]`.
|
||||
|
||||
### Sens des principaux champs
|
||||
|
||||
@@ -431,7 +431,7 @@ Pour chaque fiche, il vérifie que le fichier peut être lu en UTF-8, que son fr
|
||||
- `draft` doit être un booléen ;
|
||||
- `updated`, lorsqu’il est actif, doit également être un horodatage TOML.
|
||||
|
||||
Les brouillons et les fiches publiées sont contrôlés de la même façon. Le validateur n’évalue pas la qualité éditoriale des valeurs et n’exige donc ni titre, ni sens, ni thème verbal non vide.
|
||||
Les brouillons et les fiches publiées sont contrôlés de la même façon. Le validateur n’évalue pas la qualité éditoriale des valeurs et n’exige donc ni titre, ni sens, ni thème verbal non vide. La nature grammaticale unique et connue sert seulement à déterminer le modèle lexical applicable.
|
||||
|
||||
Pour le vocabulaire, il vérifie en plus :
|
||||
|
||||
|
||||
Reference in New Issue
Block a user