aplat

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

aplat.5 (4098B)


      1 .Dd 8 de juny de 2024
      2 .Dt APLAT 5
      3 .Os
      4 .Sh NOM
      5 .Nm aplat
      6 .Nd Format de document estructurat de manera jeràrquica.
      7 .Sh DESCRIPCIÓ
      8 .Nm aplat
      9 és un format de document estructurat de manera jeràquica concebut per ser
     10 fàcil d’escriure i de manipular pels humans.
     11 És equivalent al format
     12 .Xr plat 5 .
     13 .Pp
     14 És el format de l’entrada de la utilitat
     15 .Xr aplat 1 .
     16 .Pp
     17 El format
     18 .Nm aplat
     19 es compon de quatre tipus d’objecte\~:
     20 .Em domini ,
     21 .Em àtom ,
     22 .Em etiqueta
     23 i
     24 .Em contigut .
     25 .Pp
     26 Un
     27 .Em domini
     28 divideix un document.
     29 Els seus límits són notats per parèntesis\~:
     30 els parèntesis oberts
     31 .Pq Sq \(
     32 i tancats
     33 .Pq Sq )\&
     34 en marquen l’inici i el final, respectivament.
     35 Els límits d’un domini
     36 (o de manera més general, d’un objecte)
     37 han de trobar-se dins del
     38 .Em "domini pare"
     39 immediat.
     40 El
     41 .Em "domini arrel" ,
     42 domini asbolutament superior pel fet que no té pare
     43 i que conté tots els altres dominis, és una excepció de la regla.
     44 Cada parèntesi obert ha de tenir un parèntesi tancat corresponent.
     45 .Pp
     46 Una
     47 .Em etiqueta
     48 anomena un domini.
     49 Aquest nom correspon al primer
     50 .Em àtom
     51 del domini.
     52 La seva llargària
     53 no pot superar
     54 els 127 octets.
     55 .Pp
     56 El
     57 .Em contigut
     58 d’un domini correspon a la concatenació de tots els àtoms que conté,
     59 llevat del primer,
     60 que conté l’\c
     61 .Em etiqueta .
     62 .Pp
     63 En fi,
     64 un
     65 .Em àtom
     66 és una cadena de caràcters separats per parèntesis o blancs.
     67 Són tractats com a blancs els caràcters següents\~:
     68 l’espai normal
     69 .Pq Sq \  ,
     70 la línia nova
     71 .Pq Sq \en
     72 i el caràcter de tabulació
     73 .Pq Sq \et .
     74 .Pp
     75 Existeixen tres maneres d’escapar caràcters\~:
     76 la utilització de la barra obliqua inversa
     77 .Pq Sq \e\e ,
     78 l’emmarcació entre cometes rectes dobles
     79 .Pq Sq \(dq
     80 i l’emmarcació entre
     81 signes d’igualtat
     82 col·locats a l’inici d’una línia
     83 .Pq Sq \en= .
     84 .Pp
     85 El caràcter d’escapament
     86 .Pq Sq \e
     87 canvia la interpretació dels caràcters especials.
     88 El seu efecte varia segons el caràcter escapat.
     89 Una línia nova escapada és ignorada.
     90 Els altres caràcters escapats,
     91 incloent-hi
     92 els parèntesis,
     93 els espais normals,
     94 els caràcters de tabulació,
     95 les cometes
     96 et els mateixos caràcters d’escapament,
     97 reben una interpretació literal.
     98 .Pp
     99 Quan una cadena de caràcters és emmarcada entre cometes rectes dobles
    100 .Pq Sq \(dq ,
    101 els blancs
    102 i els parèntesis
    103 reben les seves interpretacions literals.
    104 El comportament del caràcter d’escapament
    105 és el mateix a dins i a fora
    106 de les cometes.
    107 Les cometes no han de trobar-se
    108 a les extremitats dels àtoms,
    109 sinò que funcionen més aviat com a commutadors
    110 que canvien el mode d’interpretació.
    111 En això,
    112 s’assemblen a les cometes dels intèrprets d’ordres de Unix.
    113 .Pp
    114 L’última estratègia d’escapament recorre a un
    115 .Em bloc .
    116 Un bloc és delimitat
    117 per un parell de signes d’igualtat
    118 col·locats a l’inici d’una línia.
    119 .Pq Sq \en= .
    120 Els caràcters que es troben
    121 en les mateixes línies
    122 que aquests signes d’igualtat
    123 són ignorats.
    124 Així,
    125 poden servir per
    126 transmettre algunes informacions
    127 a uns preprocessors eventuals.
    128 El text que es troba dins d’un bloc és interpretat
    129 .Em verbatim .
    130 Els separators de blocs
    131 sempre són interpretats com a tals,
    132 i els mecanismes d’escapament normals
    133 no tenen cap efecte sobre ells.
    134 Una construcció especial permet incloure-hi
    135 signes d’igualtat
    136 a l’inici d’una línia.
    137 Només cal afegir-hi un signe d’exclamació
    138 .Pq Sq !\&
    139 Un bloc pot ser encastat
    140 entre un parell de cometes.
    141 .Pp
    142 Així doncs, les dues construccions següents són equivalents:
    143 .Bd -literal -offset indent
    144 (doc
    145   (par "La línia següent comença per un signe d’igualtat\~:
    146 =!"))
    147 .Ed
    148 .Bd -literal -offset indent
    149 (doc
    150   (par
    151 = tipus:text
    152 La línia següent comença per un signe d’igualtat\~:
    153 =!
    154 =
    155 ))
    156 .Ed
    157 .Sh VEGEU TAMBÉ
    158 .Xr aplat 1 ,
    159 .Xr plat 5
    160 .Sh AUTORS
    161 .An Loïc Daignault-Pichette <loic@asteride.xyz>
    162 .Sh TRADUCCIÓ
    163 Aquesta pàgina del manual
    164 va ser traduïda
    165 per primera vegada
    166 de la seva versió original en francès
    167 per
    168 .An Loïc Daignault-Pichette <loic@asteride.xyz>
    169 al mes d’abril de 2024
    170 i està actualitzada amb la versió 2.0-ε/1 de la utilitat.