Documentation à jour

This commit is contained in:
julien
2026-08-06 16:51:17 +02:00
parent 7a0e75442c
commit 1767245f10
2 changed files with 11 additions and 11 deletions
+7 -7
View File
@@ -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 front matter TOML contient les données brèves et structurées ;
- le corps Markdown contient les explications, tableaux, exemples et commentaires ; - le corps Markdown contient les explications, tableaux, exemples et commentaires ;
- les champs prévus par un modèle restent présents, même lorsquils sont vides ; - les champs prévus par un modèle restent présents, même lorsquils 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. 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` | | Texte | `src/content/textes/` | `genres` |
| Vocabulaire | `src/content/vocabulaire/` | `natures` | | 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. 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 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 ```sh
./scripts/check-content.py ./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. Les tables propres au type de contenu viennent ensuite dans le même front matter.
- `title` est le titre affiché ; - `title` est le titre affiché ;
- `date` est lhorodatage de publication ; - `date` est lhorodatage initial de la fiche et sert de date de publication ;
- `updated` est lhorodatage de la dernière modification substantielle ; - `updated` est lhorodatage de la dernière modification substantielle ;
- `description` est un résumé court, rédigé manuellement lorsquil est utile ; - `description` est un résumé court, rédigé manuellement lorsquil est utile ;
- `draft` détermine si la page est publiée. - `draft` détermine si la page est publiée.
@@ -214,7 +214,7 @@ themes = ["morphologie nominale"]
genres = ["lettre"] 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 ## Fiches de vocabulaire
@@ -259,7 +259,7 @@ Chaque nature ajoute les champs suivants, dans lordre produit par le généra
| Particule | `function` | | Particule | `function` |
| Numéral | `numeral_type`, `value`, `gender`, `feminine` | | Numéral | `numeral_type`, `value`, `gender`, `feminine` |
Tous les champs simples restent des chaînes, même lorsquils 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à linfinitif et ne le répète donc pas dans `[extra]`. Tous les champs simples restent des chaînes, même lorsquils 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à linfinitif et celui-ci nest donc pas répété dans `[extra]`.
### Sens des principaux champs ### 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 ; - `draft` doit être un booléen ;
- `updated`, lorsquil est actif, doit également être un horodatage TOML. - `updated`, lorsquil 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 nexige 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 nexige 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 : Pour le vocabulaire, il vérifie en plus :
+4 -4
View File
@@ -33,7 +33,7 @@ Toutes les commandes ci-dessous sont exécutées depuis la racine du dépôt.
## Développement local ## Développement local
Valider les contenus : Valider la structure des fiches :
```sh ```sh
./scripts/check-content.py ./scripts/check-content.py
@@ -69,7 +69,7 @@ Le résultat est écrit dans `src/public/`, répertoire ignoré par Git.
## Rédaction des contenus ## Rédaction des contenus
Les contenus sont rédigés en Markdown dans `src/content/`. Des scripts permettent de créer des squelettes complets, dhorodater les modifications substantielles et de vérifier que chaque fiche conserve les champs prévus pour son type. Les contenus sont rédigés en Markdown dans `src/content/`. Des scripts permettent de créer des squelettes complets, dhorodater les modifications substantielles et de vérifier que chaque fiche conserve les champs prévus pour son modèle. Ils concernent uniquement les fiches placées dans les cinq sections du site ; les fichiers `_index.md` et les pages autonomes situées directement dans `src/content/` restent gérés manuellement.
Les conventions éditoriales, les commandes et les modèles de chaque type de fiche sont décrits dans le [guide de rédaction](GUIDE_REDACTION.md). Les conventions éditoriales, les commandes et les modèles de chaque type de fiche sont décrits dans le [guide de rédaction](GUIDE_REDACTION.md).
@@ -101,11 +101,11 @@ Les conventions éditoriales, les commandes et les modèles de chaque type de fi
- `src/sass/main.scss` contient les styles ; - `src/sass/main.scss` contient les styles ;
- `src/static/` contient les ressources servies telles quelles ; - `src/static/` contient les ressources servies telles quelles ;
- `src/zola.toml` contient la configuration de Zola ; - `src/zola.toml` contient la configuration de Zola ;
- `scripts/` contient les outils de création, de mise à jour et de validation des contenus. - `scripts/` contient les outils de création, de mise à jour et de validation structurelle des fiches.
## Déploiement avec Docker Compose ## Déploiement avec Docker Compose
Limage est construite en trois étapes : validation des contenus, construction avec Zola 0.22.1, puis service des seuls fichiers statiques. Limage est construite en trois étapes : validation structurelle des fiches, construction complète avec Zola 0.22.1, puis service des seuls fichiers statiques.
Vérifier la configuration : Vérifier la configuration :