aplat

Documents structurés pour Unix
git clone git://git.asteride.xyz/~ldp/aplat.git
Journaux | Fichiers | Références | LISEZ-MOI | LICENCE

plat.5 (2850B)


      1 .Dd 8 juin 2024
      2 .Dt PLAT 5
      3 .Os
      4 .Sh NOM
      5 .Nm plat
      6 .Nd Format de document structuré hiérarchiquement pour Unix
      7 .Sh DESCRIPTION
      8 .Nm plat
      9 est un format de document organisé en lignes et en champs qui permet la
     10 représentation de structures hiérarchiques.
     11 Les utilitaires de traitement de texte conçus pour bien fonctionner dans un
     12 environnement Unix sont donc,
     13 avec un peu d’aide,
     14 tout à fait capables de le manipuler.
     15 .Pp
     16 Le format se présente comme une suite de lignes, chacune séparée en trois
     17 champs\~: celui des
     18 .Em drapeaux ,
     19 celui de l’\c
     20 .Em étiquette ,
     21 et celui du 
     22 .Em contenu .
     23 Les champs sont séparés
     24 entre eux
     25 par des caractères de tabulation
     26 .Pq Sq \et .
     27 .Pp
     28 Un
     29 .Em domaine
     30 sectionne un document
     31 .Nm .
     32 Les limites de tout domaine sont
     33 contenues à l’intérieur du
     34 .Em "domaine parent"
     35 immédiat.
     36 Le
     37 .Em "domaine racine" ,
     38 domaine absolument supérieur en ce qu’il n’a pas de parent
     39 et qu’il contient tous les autres domaines,
     40 fait exception à la règle.
     41 Le
     42 .Em "domaine cadet"
     43 est le domaine le plus imbriqué à un endroit donné du document.
     44 Tout domaine apparaît au moins une fois en position de domaine cadet,
     45 et ce même s’il est vide.
     46 .Pp
     47 Un
     48 .Em drapeau
     49 permet d’identifier les limites d’un domaine.
     50 La parenthèse ouvrante
     51 .Pq Sq \(
     52 indique que la ligne est la première à être incluse dans un domaine donné\|;
     53 la parenthèse fermante
     54 .Pq Sq ")"
     55 indique que la ligne est la dernière à être incluse dans un domaine donné.
     56 .Pp
     57 Une
     58 .Em étiquette
     59 nomme un domaine.
     60 L’étiquette de chaque domaine n’est affichée qu’une seule fois,
     61 à l’ouverture du domaine.
     62 .Pp
     63 Les champs
     64 .Em contenu
     65 qui se suivent
     66 et qui appartiennent à un même
     67 .Em "domaine cadet"
     68 sont concatenés.
     69 .Pp
     70 Les lignes étant séparées par des nouvelles lignes
     71 .Pq Sq \en
     72 et les champs par des caractères de tabulation
     73 .Pq Sq \et ,
     74 ces caractères sont échappés par
     75 .Sq \en
     76 et
     77 .Sq \et ,
     78 respectivement.
     79 Le deux-points
     80 et le caractère d’échappement lui-même
     81 doivent être échappés par
     82 .Sq \ed
     83 et
     84 .Sq \ee ,
     85 respectivement.
     86 Il est interdit d’échapper tout autre caractère.
     87 .Sh EXEMPLES
     88 L’exemple suivant
     89 (où des signes de dollar ont été ajoutés
     90 pour marquer la fin de la ligne)\~:
     91 .Bd -literal -offset indent
     92 (	doc	$
     93 (	par	Que veut $
     94 		dire $
     95 ()	it	placoter$
     96 )		 ?$
     97 )		$
     98 .Ed
     99 .Pp
    100 est tout à fait équivalent au document
    101 .Xr aplat 5
    102 suivant\~:
    103 .Bd -literal -offset indent
    104 (doc
    105   (par "Que veut dire " (it "placoter") " ?"))
    106 .Ed
    107 .Sh VOIR AUSSI
    108 .Xr aplat 1 ,
    109 .Xr aplat 5
    110 .Sh HISTORIQUE
    111 .Pp
    112 Le format
    113 .Nm
    114 a changé avec la version 2.0 de l’utilitaire
    115 .Xr aplat 1 .
    116 Avant cette publication,
    117 le champ des drapeaux suivait celui de l’étiquette,
    118 et ce dernier contenait toute la hiérarchie des étiquettes,
    119 du domaine racine au domaine cadet.
    120 .Sh AUTEURS
    121 .An Loïc Daignalut-Pichette <loic@asteride.xyz>