commit 6f788588f5d68ae3ee7380e58c7aa91c74b3885f
parent 7bb5fa8e91657fafb3858ded4275be3eba4c9efb
Auteur: Selve <selve@asteride.xyz>
Date: Tue, 23 Jan 2024 18:19:15 -0500
modification de la documentation
Diffstat:
4 files changed, 33 insertions(+), 31 deletions(-)
diff --git a/LISEZ-MOI.txt b/LISEZ-MOI.txt
@@ -4,10 +4,10 @@ aplat(1)
Convertir le format aplat au format plat.
Les formats aplat et plat sont équivalents. Le premier a été conçu pour être
-facile d'utilisation pour un humain et le second, pour bien s'intégrer aux
+facile d’utilisation pour un humain et le second, pour bien s’intégrer aux
utilitaires de traitement de texte des environnements de type Unix.
-Dépendances d'exécution
+Dépendances d’exécution
-----------------------
- POSIX
@@ -24,7 +24,7 @@ Dépendances de compilation
Installation
------------
-aplat(1) a été testé sur
+aplat(1) a été testé sur :
* OpenBSD 7.4
* FreeBSD 14.0
* Alpine Linux 3.19.0
@@ -42,34 +42,35 @@ du programme :
# make install
-Ils s'installeront sous BIN_DOS, MAN_DOS et I18N_DOS, respectivement. Ces
+Ils s’installeront sous BIN_DOS, MAN_DOS et I18N_DOS, respectivement. Ces
variables ont chacune une valeur prédéfinie dans le Makefile et dépendent de
-PREFIX, mais il peut être utile de les modifier.
+PREFIX, mais il peut être utile de les modifier. Il peut être nécessaire de
+régler MANPATH ou /etc/man.conf pour accéder aux pages du manuel.
Objectif
--------
Le format XML est très utile pour créer et pour manipuler des documents
structurés. Il est cependant pénible à écrire à la main et trop complexe pour
-les besoins de plusieurs projets. Il s'intègre en outre généralement très mal
+les besoins de plusieurs projets. Il s’intègre en outre généralement très mal
aux environnements de type Unix.
Le programme aplat(1) a été conçu pour rendre plus agréable la création de
-documents structurés hiérarchiquement et pour rendre possible l'utilisation des
+documents structurés hiérarchiquement et pour rendre possible l’utilisation des
utilitaires de traitement de texte qui fonctionnent bien avec des documents
organisés selons le principe des lignes et des champs (grep, sed, awk, cut,
etc.).
-Deux formats de document ont donc dû être créés : l'un agréable pour les humains
-(aplat) ; l'autre agréable pour les machines (plat). Il faut concevoir le format
+Deux formats de document ont donc dû être créés : l’un agréable pour les humains
+(aplat) ; l’autre agréable pour les machines (plat). Il faut concevoir le format
plat comme un format intermédiaire que divers programmes pourront manipuler le
-long d'un tube et qu'on pourra ensuite convertir vers un ou plusieurs autres
+long d’un tube et qu’on pourra ensuite convertir vers un ou plusieurs autres
formats (XML, HTML, texte, gemtext, epub, etc.)
Utilisation
-----------
-Voici un extrait d'un document au format aplat(5) qui aurait pu servir à la
+Voici un extrait d’un document au format aplat(5) qui aurait pu servir à la
génération de ce LISEZ-MOI.
$ cat lisez-moi.aplat
@@ -100,8 +101,9 @@ On peut alors extraire le titre du document avec la suite de commandes :
$ <lisez-moi.plat grep '^:doc:@:titre ' | cut -f3 | { tr -d '\n' ; echo ; }
Lisez-moi!
-Le dernier segment de la séquence {tr -d '\n' ; echo ;} est nécessaire parce que
-le troisième champ peut s'étendre sur plusieurs lignes. Ainsi,
+Le dernier segment de la séquence {tr -d ’\n’ ; echo ;} est nécessaire parce que
+le troisième champ peut s’étendre sur plusieurs lignes. Ainsi, dans le format
+plat,
:doc:@:titre () Lisez-moi!
et
@@ -110,18 +112,17 @@ et
sont équivalents.
-Une description de ces deux formats se trouvent dans les pages du manuel
-aplat(5) et plat(5).
+Ces deux formats sont décrits dans les pages du manuel aplat(5) et plat(5).
Contribuer
----------
-Pour tout commentaire, rapport de bogue ou diff, on peut m'envoyer un courriel
-au selve@asteride.xyz.
+Pour tout commentaire, rapport de bogue ou diff, on peut m’envoyer un courriel
+à selve@asteride.xyz.
Aussi, les messages de ce programme ont été traduits du français au catalan, à
-l'espagnol et à l'anglais. La documentation, cependant, n'existe pour l'instant
-qu'en français. De l'aide est toujours bienvenue.
+l’espagnol et à l’anglais. La documentation, cependant, n’existe pour l’instant
+qu’en français. De l’aide est toujours bienvenue.
Licence
-------
diff --git a/man/fr/aplat.1 b/man/fr/aplat.1
@@ -1,4 +1,4 @@
-.Dd 21 janvier 2024
+.Dd 23 janvier 2024
.Dt APLAT 1
.Os
.Sh NOM
diff --git a/man/fr/aplat.5 b/man/fr/aplat.5
@@ -1,4 +1,4 @@
-.Dd 22 janvier 2024
+.Dd 23 janvier 2024
.Dt APLAT 5
.Os
.Sh NOM
@@ -15,7 +15,7 @@ prend en entrée.
.Pp
Le format
.Nm aplat
-est constitué de quatre type d’objet\~:
+est constitué de quatre types d’objet\~:
.Em domaine ,
.Em atome ,
.Em étiquette
@@ -93,9 +93,9 @@ excepté le premier, qui est l’\c
.Pp
Finalement, un
.Em atome
-est une suite de caractères séparés par des parenthèses ou par des blancs.
+est une suite de caractères séparées par des parenthèses ou par des blancs.
Sont traités comme des blancs les caractères suivants\~:
-l’espace normal
+l’espace normale
.Pq Sq \ ,
le saut de ligne
.Pq Sq \en
@@ -136,7 +136,8 @@ guillemets qu’à l’extérieur.
Les guillemets n’ont pas à se trouver aux extrémités des atomes
mais fonctionnent plutôt comme des commutateurs
réglant le mode d’interprétation.
-Ils ressemblent en cela aux guillemets des interpréteurs de commandes Unix.
+Ils fonctionnent en cela comme les guillemets des interpréteurs de commandes
+Unix.
.Pp
La dernière stratégie d’échappement a recourt à un
.Em bloc .
@@ -161,17 +162,17 @@ Il suffit de les faire suivre d’un point d’exclamation
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.))
+ (par Un\e bloc\e est\e limité\e par\e la\e suite\e \e"\e"\e"\e.))
.Ed
.Bd -literal -offset indent
(doc
- (par "La suite \e"\e"\e" marque les limites d’un bloc."))
+ (par "Un bloc est limité par la suite\e"\e"\e"."))
.Ed
.Bd -literal -offset indent
(doc
(par
""" type=texte
-La suite """! marque les limites d’un bloc.
+Un bloc est limité par la suite """!.
"""))
.Ed
.Sh VOIR AUSSI
diff --git a/man/fr/plat.5 b/man/fr/plat.5
@@ -1,4 +1,4 @@
-.Dd 2024-01-22
+.Dd 23 janvier 2024
.Dt PLAT 5
.Os
.Sh NOM
@@ -48,9 +48,9 @@ contient l’étiquette du domaine cadet courant
de même que,
le cas échéant,
les étiquettes de tous ses domaines parents.
-Ce champ se présente sous la forme d’une liste d’étiquettes
+Ce champ a la forme d’une liste d’étiquettes
ordonnée de telle sorte qu’un
-parent se trouve se trouve toujours à la gauche de son enfant.
+parent se trouve toujours à la gauche de son enfant.
Chaque étiquette de cette liste est précédée d’un deux-points
.Pq Sq :\& .
Il est impossible d’échapper les deux-points dans ce champ.
