commit 4f549171389133e6c8ae751a0d7ebcee9dd1c366
parent b4e921364e09a8327c953623d1fa08c5d1adcd68
Auteur: Selve <selve@asteride.xyz>
Date: Thu, 23 Nov 2023 10:37:58 -0500
ajout de la page du manuel pour aplat(5)
Diffstat:
2 files changed, 150 insertions(+), 1 deletion(-)
diff --git a/man/fr/aplat.1 b/man/fr/aplat.1
@@ -1,4 +1,4 @@
-.Dd novembre 19, 2023
+.Dd 23 novembre 2023
.Dt APLAT 1
.Os
.Sh NOM
diff --git a/man/fr/aplat.5 b/man/fr/aplat.5
@@ -0,0 +1,149 @@
+.Dd 2023-11-23
+.Dt APLAT 5
+.Os
+.Sh NOM
+.Nm aplat
+.Nd Format de document structuré hiérarchiquement
+.Sh DESCRIPTION
+.Nm aplat
+est un format de document structuré hiérarchiquement conçu pour être facile à
+utiliser, aussi bien par un humain que par une machine.
+.Pp
+C'est le format que
+.Xr aplat 1
+prend en entrée.
+.Pp
+Le format
+.Nm aplat
+est constitué de quatre objets\|: les
+.Em domaines ,
+les
+.Em atomes ,
+les
+.Em étiquettes
+et le
+.Em contenu .
+.Pp
+Un
+.Em domaine
+sectionne un document. Ses limites sont représentées par des parenthèses.
+Les parenthèses ouvrante
+.Pq Sq \(
+et fermante
+.Pq Sq )\&
+en marque le début et la fin, respectivement.
+Les limites de tout domaine (et plus généralement, de tout object) doivent être
+contenues à l'intérieur du domaine parent immédiat.
+Le domaine racine, domaine absolument supérieur en ce qu'il n'a pas de parent et
+qu'il contient tous les autres domaines, fait exception à la règle.
+.Pp
+Lorsque l'étendue d'un domaine est la même que celle de son parent immédiat, il
+est possible d'utiliser le raccourcis syntaxique noté par le deux-points
+.Pq Sq :\& .
+Dans cette notation, à gauche du deux-points se trouve le domaine parent et à
+droite, le domaine enfant.
+Il est possible d'ajouter de la sorte autant que domaines coextensifs à leur
+parent que le permet la mémoire disponible.
+.Pp
+Ces deux constructions sont donc équivalentes\|:
+.Bd -literal -offset indent
+(parent
+ (intermédiaire
+ (enfant "Contenu du domaine")))
+.Ed
+.Bd -literal -offset indent
+(parent:intermédiaire:enfant "Contenu du domaine")
+.Ed
+.Pp
+Une
+.Em étiquette
+nomme un domaine. Ce nom correspond au premier
+.Em atome
+du domaine.
+Ainsi, dans l'exemple ci-dessus,
+.Em parent ,
+.Em intermédiaire
+et
+.Em enfant
+sont des étiquettes.
+.Pp
+Le
+.Em contenu
+d'un domaine correspond la concaténation de tous les atomes qu'il contient,
+excepté le premier, qui est l'\c
+.Em étiquette .
+.Pp
+Finalement, un
+.Em atome
+est une suite de caractères séparés par des parenthèses ou par des espaces.
+Sont traités comme des espaces les caractères suivants\|:
+l'espace normal
+.Pq Sq \ ,
+le saut de ligne
+.Pq Sq \en
+et le caractère de tabulation
+.Pq Sq \et .
+.Pp
+Il existe trois moyens d'échapper ces caractères\|: l'utilisation de la barre
+oblique inversée
+.Pq Sq \e\e ,
+l'encadrement avec des guillemets droits doubles
+.Pq Sq \(dq
+et l'encadrement avec une suite de trois de ces guillemets
+.Pq Sq \(dq\(dq\(dq .
+.Pp
+Le caractère d'échappement
+.Pq Sq \e
+change l'interprétation des caractères spéciaux. Son effet varie selon le
+caractère.
+Les parenthèses, les espaces normaux, les guillemets et les caractères
+d'échappement eux-mêmes sont interprétés dans leur sens littéral lorsque ce
+caractère les précède.
+Cependant, une nouvelle ligne échappée est ignorée,
+et l'échappement de tout autre caractère est équivalent à ce même caractère sans
+échappement.
+.Pp
+Lorsqu'une chaîne de caractères est placée entre guillemets droits doubles
+.Pq Sq \(dq ,
+les espaces recoivent leur interprétation littérale.
+C'est le seul apport de ces guillemets.
+Le comportement du caractère d'échappement est le même à l'intérieur de
+guillemets qu'à l'extérieur.
+.Pp
+La dernière stratégie d'échappement a recourt à un
+.Em bloc .
+Un bloc est délimité par une paire de triples guillemets droits doubles
+.Pq Sq \(dq\(dq\(dq .
+Les caractères qui se trouvent entre le triplet ouvrant et la première nouvelle
+ligne
+.Pq Sq \en ,
+inclusivement, et ceux qui se trouvent de la dernière nouvelle ligne et le
+triplet fermant, inclusivement, sont ignorés.
+Ces caractères ignorés peuvent servir à donner certaines informations à
+d'éventuels préprocesseurs.
+Le texte qui se trouve à l'intérieur d'un bloc est interprété
+.Em verbatim .
+Une construction spéciale permet d'y inclure une suite de trois guillemets.
+Il suffit de les faire suivre d'un point d'exclamation
+.Pq Sq !\&
+.Pp
+Ainsi, les trois constructions suivantes sont équivalentes\|:
+.Bd -literal -offset indent
+(doc
+ (par La\e suite\e \e"\e"\e"\e marque\e les\e limites\e d'un\e bloc.))
+.Ed
+.Bd -literal -offset indent
+(doc
+ (par "La suite \e"\e"\e" marque les limites d'un bloc."))
+.Ed
+.Bd -literal -offset indent
+(doc
+ (par """ type=texte
+La suite """! marque les limites d'un bloc.
+"""))
+.Ed
+.Sh VOIR AUSSI
+.Xr aplat 1 ,
+.Xr plat 5
+.Sh AUTEURS
+.An Selve <selve@asteride.xyz>
