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 (2982B)


      1 .Dd 5 d’abril de 2024
      2 .Dt PLAT 5
      3 .Os
      4 .Sh NOM
      5 .Nm plat
      6 .Nd Format de document estructurat de manera jeràrquica per a Unix
      7 .Sh DESCRIPCIÓ
      8 .Nm plat
      9 és un format de document organitzat en línies i en camps
     10 que permet representar estructures jeràrquiques.
     11 Les utilitats de processament de text
     12 concebudes per funcionar bé
     13 dins un environment Unix
     14 són,
     15 doncs,
     16 amb una mica d’ajuda,
     17 perfectament capaces de manipular-lo.
     18 .Pp
     19 El format es presenta com un seguit de línies,
     20 cadascuna separada en tres camps:
     21 el de les
     22 .Em banderes ,
     23 el de l’\c
     24 .Em etiqueta
     25 i el del
     26 .Em contigut .
     27 Els camps són separats per caràcters de tabulació
     28 .Pq Sq \et .
     29 .Pp
     30 Un
     31 .Em domini
     32 divideix un document
     33 .Nm .
     34 Els límits de cada domini es troben
     35 dins del
     36 .Em "domini pare"
     37 immediat.
     38 El
     39 .Em "domini arrel" ,
     40 domini absolutament superior pel fet que no té pare
     41 i que conté tots els altres dominis,
     42 és una excepció de la regla.
     43 El
     44 .Em "domini buderol"
     45 és el domini més encastat en un lloc donat del document.
     46 Cada domini apareix com a mínim una vegada en posició de domini buderol,
     47 i això encara que sigui buit.
     48 .Pp
     49 Una
     50 .Em bandera
     51 permet identificar els límits d’un domini.
     52 El parèntesi obert
     53 .Pq Sq \(
     54 indica que la línia és la primera d’un domini donat;
     55 el parèntesi tancat
     56 .Pq Sq )\&
     57 indica que la línia és l’última d’un domini donat.
     58 .Pp
     59 Una
     60 .Em etiqueta
     61 anomena un domini.
     62 L’etiqueta de cada domini es mostra una sola vegada,
     63 al principi del domini corresponent.
     64 .Pp
     65 Els camps
     66 .Em contingut
     67 que es segueixen
     68 i que pertanyen a un mateix
     69 .Em "domaini buderol"
     70 són concatenats.
     71 .Pp
     72 Com que les línies són separades per línies noves
     73 .Pq Sq \en
     74 i com que els camps són separats per caràcters de tabulació
     75 .Pq Sq \et ,
     76 aquests caràcters han de ser escapats amb
     77 .Sq \en
     78 i
     79 .Sq \et ,
     80 respectivament.
     81 El dos punts
     82 i el el mateix caràcter d’escapament
     83 han de ser escapat amb
     84 .Sq \ed
     85 i
     86 .Sq\ee ,
     87 respectivament.
     88 No és possible escapar els altres caràcters.
     89 .Sh EXEMPLES
     90 L’exemple següent
     91 (en el qual uns símbols de dòlar han estat afegits
     92 per significar la fi d’una línia):
     93 .Bd -literal -offset indent
     94 (	doc	$
     95 (	par	Què vol $
     96 		dir $
     97 ()	it	fer el barret$
     98 )		?$
     99 )		$
    100 .Ed
    101 .Pp
    102 és perfectament equivalent al document
    103 .Xr aplat 5
    104 següent:
    105 .Bd -literal -offset indent
    106 (doc
    107   (par "Què vol dir " (it "fer el barret") "?"))
    108 .Ed
    109 .Sh VEGUEU TAMBÉ
    110 .Xr aplat 1 ,
    111 .Xr aplat 5
    112 .Sh HISTÒRIA
    113 .Pp
    114 El format
    115 .Nm
    116 va canviar amb la versió 2.0 de la utilitat
    117 .Xr aplat 1 .
    118 Abans d’aquesta publicació,
    119 el camp de les banderes seguia el de l’etiqueta,
    120 i aquest últim contenia tota la jeràrquia de les etiquetes,
    121 del domini arrel al domini buderol.
    122 .Sh AUTORS
    123 .An Loïc Daignault-Pichette <loic@asteride.xyz>
    124 .Sh TRADUCCIÓ
    125 Aquesta pàgina del manuel
    126 va ser traduïda
    127 per primera vegada
    128 de la seva versió original en francès
    129 per
    130 .An Loïc Daignault-Pichette <loic@asteride.xyz>
    131 al mes d’abril de 2024
    132 i està actualitzada amb la versió 2.0-ε/1 de la utilitat.