commit 77bc89f1fcad796a425089d5b2ac74a2945606e8 parent 4b091eb145a36e7a84ca3bc10f236cfb68976936 Auteur: Selve <selve@asteride.xyz> Date: Mon, 23 Oct 2023 18:29:02 -0400 [gen] un peu de documentation ajoutée Il s'agit d'un premier essai de description des éléments utilisés dans les fichiers .debout normaux. Diffstat:
| A | doc/éléments.txt | | | 91 | +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ |
1 file changed, 91 insertions(+), 0 deletions(-)
diff --git a/doc/éléments.txt b/doc/éléments.txt @@ -0,0 +1,91 @@ +:doc: + +Racine du document. + +@titre +* Titre du document. +@type +* Type de document. +* Valeurs possibles: + - accueil + - article + - index +@date-pub +* Date de la publication. +@date-mod +* Date de la dernière modification. +@auteur +* Auteur du document +@uid +* Identifiant unique. +* Utile à la génération des flux atom. + +:par: + +Cet élément tire son nom de « paragraphe » mais ne correspond pas exactement à +ce concept. :par: est destiné à contenir quelque chose qui a une certaine unité, +qu'on pourrait isoler par des lignes vides. + +@type +* Type de « paragraphe » +* Valeurs possibles: + - texte (défaut) + - liens + - citation +@césure +* Type de césure +* Valeurs possibles: + - continue (défaut) + - pre: texte préformaté + +:par:lien: + +Décrit un lien. Il contient le texte affiché à la place du lien. +Voir aussi :@:ref:std: + +@ref +* URL + +:@:ref:std: + +Contient un identifiant qu'un programme externe remplacera par une URL. Utile +pour éviter l'élément :si:. + +:liste: + +Décrit une liste. + +@ordonnée +* Créer une liste ordonnée à la place. Gemini ne supporte pas les listes + ordonnées. + +:liste:elem: + +Élément d'une liste. + +:section: + +Section d'un document. Par défaut, correspond à ## ou à <h2> + +@niveau +* Niveau + - 2 (défaut) + - 3 + +:note: + +Note de bas de page. S'encre au premire l':encrage: avec un identifiant "notes". + +:citation: + +Citation. + +@auteur +@date + +:encrage: + +Point d'encrage. + +@id +* Identifiant