/doc/Catalan/manpage-ca.t2t
Unknown | 370 lines | 248 code | 122 blank | 0 comment | 0 complexity | 771fe4458910429e7e4f5c6814ed6ada MD5 | raw file
Possible License(s): GPL-2.0, GPL-3.0, WTFPL
1TXT2TAGS 2 3Aug, 2010 4 5%!target: man 6%!encoding: UTF-8 7 8%!postproc(man): ' \(#\w+\)' '' 9 10%!options(html): --mask-email --toc 11%!postproc(html): <HEAD> '<HEAD>\n<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>' 12 13 14= NOM =[name] 15 16txt2tags - Eina de formatació i conversió de texte. 17 18= SINOPSI =[synopsis] 19 20**txt2tags** [//opcions//] [//ARXIU//...] 21 22= DESCRIPCIÓ =[description] 23 24**txt2tags** llegeig un arxiu de texte que ha estat mínimament marcat i el converteix las siguents formats: 25//ASCII Art//, 26//AsciiDoc//, 27//Creole//, 28//DocBook//, 29//DokuWiki//, 30//Google Code Wiki//, 31//HTML//, 32//LaTeX//, 33//Lout//, 34//MagicPoint//, 35//Man page//, 36//MoinMoin//, 37//PageMaker//, 38//Plain Text (Texte Plà)//, 39//PmWiki//, 40//SGML//, 41//Wikipedia// 42//XHTML//. 43% TRANSLATOR: please keep the alphabetical order of this list. 44 45 46Aquesta pàgina de manual (Man page) fou creada amb **txt2tags** a partir d'un arxiu de texte plà. El mateix arxiu de texte plà fou tambè convertit a HTML per a la versió online d'aquest manual. 47 48UNA única font, MÚLTIPLES formats de sortida - http://txt2tags.org 49 50 51= MARCAT =[markup] 52 53``` 54Encapçalaments Les primeres tres línies de l'arxiu font. 55Títol = texte = 56Títol numerat + texte + 57Comentari % comentaris 58Línia de separació -----------------------... 59Línia gruixuda =======================... 60Imàgen [nom.jpg] 61Enlaç [etiqueta url] 62 63Negreta **texte** 64Cursiva //texte// 65ratllat __texte__ 66Tatxat --texte-- 67Monoespai ``texte`` 68Raw ""texte"" 69Etiquetat ''texte'' 70 71Paràgraf texte 72Cita <TAB>texte 73Llista - texte 74Llista numerada + texte 75Llista de definició : texte 76Taula | cel.la1 | cel.la2 | cel.la3... 77 78Línia verbatim ``` texte 79Línia Raw """ texte 80Línia Etiquetada ''' texte 81 82Bloc Verbatim ``` 83 línies 84 ``` 85Bloc Raw """ 86 línies 87 """ 88Bloc etiquetat ''' 89 línies 90 ''' 91``` 92 93= OPCIONS =[options] 94 95: **-C**, **--config-file**=//ARXIU// 96Llegeig la configuració (ajusts) especificats a l'arxiu extern //ARXIU//. La configuració ha d'estar en format //%!keyword:value//. Per a més detalls, consultar la secció [AJUSTS #settings]. 97 98: **--css-sugar** 99Millora el codi HTML/XHTML generat per a fi de poder utilitzar CSS. S'eliminen els atributs de les etiquetes, s'ignòren les etiquetes de presentació, les capçaleres es generen amb etiquetes H1, H2 i H3 i es creen noves DIVs : //#header//, //#body//, //.toc//. 100 101: **--css-inside** 102Insereix el contingut d'un arxiu CSS dins l'encapçalament HTML/XHTML. Utilitzar ``--style`` per especificar l'arxiu CSS que s'ha de llegir. 103 104: **--dump-config** 105Mostra tota la configuració (ajusts) i surt. 106 107: **--dump-source** 108Mostra el document font, amb totes les seves les inclusions (``%!include``) expandides. 109 110: **--encoding**=//CODI// 111Estableix la configuració de caràcters que s'utilitzarà a l'arxiu de sortida, utilitzant l'establerta a //CODI//. Exemples de //CODI//: UTF-8 y iso-8859-1. 112 113: **--gui** 114Activa la Interfície Gráfica Tk. 115 116: **-h**, **--help** 117Mostra la informació d'ajut i surt. 118 119: **-H**, **--no-headers** 120Elimina els encapçalaments i els peus de pàgina de l'arxiu de sortida. Sols es mostraràn els continguts (cos del document). 121 122: **--headers** 123Mostra els encapçalaments i els peus de pàgina de l'arxiu de sortida. Per defecte: ON. 124 125: **--height**=//NUM// 126Fixa el nombre de línies de l'arxiu de sortida a l'establert a //NUM//. Aquesta opció s'utilitza sols amb formats de sortida ASCII Art, quan també s'estigui utilitzant l'opció ``--slides``. 127 128: **-i**, **--infile**=//ARXIU// 129Pren //ARXIU// com l'arxiu font. Utilitzar '-' per a llegir la font des de STDIN. 130 131: **--mask-email** 132Oculta els emails als robots de spam. Elimina @ i punts. L'adreça ""foo@bar.com"" esdevé <foo (a) bar com>. 133 134: **-n**, **--enum-title** 135Activa la numeració automàtica dels títols. Està prefixada a: 1, 1.1, 1.1.1, ... 136 137: **--no-dump-config** 138Anul.la l'acció ``--dump-config``. 139 140: **--no-dump-source** 141Anul.la l'acció ``--dump-source``. 142 143: **--no-encoding** 144Anul.la la configuració de caràcters. 145 146: **--no-enum-title** 147Desactiva la numeració automàtica dels títols. 148 149: **--no-infile** 150Anul.la tota anterior declaració ``--infile``. 151 152: **--no-targets** 153Anul.la l'acció ``--targets``. 154 155: **--no-mask-email** 156Desactiva l'ocultació dels emails. 157 158: **--no-outfile** 159Anul.la tota anterior declaració ``--outfile``. 160 161: **--no-quiet** 162Mostra els missatges del sistema, desactiva l'opció ``--quiet``. 163 164: **--no-rc** 165No llegir a l'arxiu de configuració (ajusts) de l'usuari ~/.txt2tagsrc. 166 167: **--no-slides** 168Desactiva ``--slides``. 169 170: **--no-style** 171Desactiva tots els ajusts d'estil. 172 173: **--no-toc** 174Elimina la Taula de Continguts (TOC) a l'arxiu de sortida. 175 176: **--no-toc-only** 177Desactiva l'acció ``--toc-only``. 178 179: **-o**, **--outfile**=//ARXIU// 180Pren //ARXIU// com a nom per a l'arxiu de sortida. Utilitzar '-' per a dirigir els resultats a STDOUT. 181 182: **-q**, **--quiet** 183Mode silenciós. Suprimeix tots els missatges del sistema, excepte els dels errors. 184 185: **--rc** 186Llegeig a l'arxiu de configuració de l'usuari ~/.txt2tagsrc. Per defecte: ON. 187 188: **--slides** 189Formata l'arxiu de sortida com una presentació de diapositives. Aquesta opció s'utilitza sols amb formats de sortida ASCII Art. 190 191: **--style**=//ARXIU// 192Utilitza //ARXIU// como l'arxiu que conté l'estil del document. Utilitzat per a definir arxius CSS en documents HTML/XHTML i ´´mòduls´´ LaTeX. Aquesta opció es pot utilitzar repetides vegades amb la finalitat d'incloure múltiples arxius d'estil. 193 194: **-t**, **--target**=//TIPUS// 195Fixa el format del document de sortida a l'establert a //TIPUS//. Els formats de document mes corrents son: //html//, //xhtml//, //tex//, //man//, //txt//. Utilitzar l'opció ``--targets`` per a consultar els formats disponibles. 196 197: **--targets** 198Mostra els formats de document disponibles per als arxius de sortida i surt. 199 200: **--toc** 201Inclou, automaticament, una Taula de Continguts (TOC) a l'arxiu de sortida, entre la capçalera (HEADER) i el cos del document (BODY). Es possible especificar la posició de la TOC utilitzant la macro ``%%TOC``. 202 203: **--toc-level**=//NUM// 204Fixa el nivell màxim de la Taula de Continguts (TOC) al número especificat a //NUM//. Tots els títols inferiors a //NUM// no serán inclosos a la Taula de Continguts. 205 206: **--toc-only** 207Mostra la Taula de Continguts (TOC) i surt. 208 209: **-v**, **--verbose** 210Mostra els missatges del sistema durant el procés de conversió. Aquesta opció es pot utilitzar repetides vegades per a incrementar el nombre de missatges a mostrar. 211 212: **-V**, **--version** 213Mostra l'actual versió del programa i surt. 214 215: **--width**=//NUM// 216Fixa al número especificat a //NUM// l'amplada de les columnes de l'arxiu de sortida. Aquesta opció s'utilitza sols amb formats de sortida del tipus ASCII Art. 217: 218 219= ARXIU FONT =[source] 220 221Els arxius font acostumen a especificar-se mitjançant l'extensió //.t2t// (per exemple, ``arxiu.t2t``). Dins d'un arxiu font hi podem considerar tres àrees : 222 223: **Encapçalament** (opcional) 224Les tres primeres línies de l'arxiu. Si no es necessita encapçalament, deixar en blanc la primera línia. S'acostuma a utilitzar aquesta àrea per a posar-hi el títol del document i la informació sobre el autor, la versió, la data etc. 225 226: **Ajusts** (opcional) 227Comença tot just després de l'Encapçalament (4ª línia, o 2ª línia en el càs d'ometre l'encapçalament) i finalitza al començament de l'àrea del Cos del Document. 228Utilitzats per a implementar ajusts (configuracions) en format ``%!keyword:value``. 229 230: **Cos del Document** 231Comença amb la primera línia de text vàlid (que no sigui comentari o ajust) després de l'Encapçalament i s'estén fins al final del document. A aquesta àrea es a on hi trobarém el contingut del document. 232: 233 234= AJUSTS =[settings] 235 236Els ajusts ens permeten personalitzar **txt2tags**; son similars a les opcions. Poden emplaçar-se a: l'área d'Ajusts del document font, a l'arxiu ``~/.txt2tagsrc`` o a un arxiu extern que s'invocarà mitjançant l'opció ``--config-file``. 237 238: **%!target** 239Defineix el format de l'arxiu de sortida, tal com ho faria l'opció ``--target``. Exemple: 240``` %!target: html 241 242: **%!options(tipo)** 243Defineix les opcions per defecte per a cada tipus d'arxiu de sortida. S'han d'utilitzar les opcions amb versió línia d'ordres (la que comença amb '--'). Exemple: 244``` %!options(html): --toc --toc-level 3 --css-sugar 245 246: **%!includeconf** 247Inclou, a l'arxiu corrent, els ajusts definits a un arxiu extern, tal com ho faria l'opció ``--config-file``. Exemple: 248``` %!includeconf: miconfig.t2t 249 250: **%!style** 251Utilitza un arxiu d'estil extern, tal com ho faria l'opció ``--style``. Es pot utilitzar repetides vegades. Exemple: 252``` %!style: colores.css 253 254: **%!encoding** 255Defineix la codificació de caràcters que s'utilitzarà al document convertit, tal com ho faria l'opció ``--encoding``. Exemple : 256``` %!encoding: UTF-8 257 258: **%!preproc** 259Filtre input de cercar/reemplaçar utilitzat per a realitzar canvis en el cos del document font ABANS que txt2tags realitzi qualsevol acció. La cerca utilitza expresions regulars de Python. Exemple: 260``` %!preproc: "JJS" "John J. Smith" 261 262: **%!postproc** 263Filtre output de cercar/reemplaçar utilitzat per a realitzar canvis en el document generat DESPRÉS del complet processament per txt2tags de l'arxiu font. La cerca utilitza exresions regulars de Python. Exemple: 264``` %!postproc(html): "<B>" "<STRONG>" 265: 266 267Si la mateixa paraula clau apareix més d'una vegada, l'ùltima trobada será que s'utilitzarà (excepcions: opcions, preproc i postproc, que son acumulatives). Les paraules claus invàlides seràn ignorades. L'odre de processament es: ``~/.txt2tagsrc``, àrea de Ajusts del document font, opció ``--config-file``. 268 269 270= ORDRES =[commands] 271 272Les Ordres executen tasques durant el procés de conversió. S'han d'emplaçar en el cos del document font. 273 274: **%!csv: arxiu.csv** 275Incorpora un arxiu CSV com una tabla. 276 277: **%!include: arxiu.t2t** 278Incorpora al document un arxiu txt2tags. 279 280: **%!include: ""``arxiu.txt``""** 281Incorpora al document un arxiu de text (verbatim). 282 283: **%!include: ""''arxiu.html''""** 284Incorpora al document un arxiu marcat. 285: 286 287= MACROS =[macros] 288 289Mitjançant les Macros podrem inserir, d'una forma fàcil, continguts dinàmics en el document convertit. S'han de definir en el cos del document font. Amb l'excepció de ``%%toc`` , totes les macros poden ser personalitzades amb directives especials, como ``%Y`` i ``%f``. Per més detalls, consulteu la **Guia del Usuario de txt2tags**. 290 291: **""%%date""** 292Insereix la data actual. El seu format per defecte es: ``%%date(%Y%m%d)``, que ens mostrará la data com: AAAAMMDD. 293 294: **""%%infile""** 295Insereix el path de l'arxiu font. El seu format per defecte es: ``%%infile(%f)``. Útil per a enllaços del tipus: ``[Veure font %%infile]``. 296 297: **""%%mtime""** 298Insereix la data de l'última modificació de l'arxiu font. El seu format per defecte es: ``%%date(%Y%m%d)``, que ens mostrarà la data com: AAAAMMDD. 299 300: **""%%outfile""** 301Insereix el path de l'arxiu final. El seu format per defecte es: ``%%outfile(%f)``. Útil en mencions del tipus: "Aquest es l'arxiu %%outfile". 302 303: **""%%toc""** 304Amb aquesta macro l'usuari pot fixar l'emplaçament de la Taula de Continguts (TOC). Es pot utilitzar repetides vegades. S'ha d'utilitzar conjuntament amb l'opció ``--toc``. 305: 306 307= EXEMPLES =[examples] 308 309: ``txt2tags -t html arxiu.t2t`` 310 311Converteix a HTML, guardant el resultat com arxiu.html. 312 313: ``txt2tags -t html -o - arxiu.t2t`` 314 315Converteix a HTML, mostrant el resultat a STDOUT. 316 317: ``txt2tags -t html --toc arxiu.t2t`` 318 319Converteix a HTML, generant una Taula de Continguts (TOC) de forma automàtica. 320 321: ``txt2tags -t html --toc --toc-level 2 -n archivo.t2t`` 322 323Converteix a HTML, amb una Taula de Continguts (TOC) a dos nivells i títols numerats. 324 325: ``txt2tags --toc-only arxiu.t2t`` 326 327Ens mostra sols la Taula de Continguts (TOC), sense realitzar cap mena de conversió en el document font. 328 329: ``txt2tags -t html --css-sugar --style base.css --style ui.css arxiu.t2t`` 330 331Converteix a HTML, preparant el codi resultat per a poder utilitzar CSS, incloent-hi també una crida a dos arxius CSS externs (base.css y ui.css). 332 333: ``txt2tags -t art --slides --width 80 --height 25 -o - arxiu.t2t | more`` 334 335Crea una presentació de diapositives tipus ASCII Art, apta para a ser visionada amb un terminal pantalla/finestra 80x25. 336 337: ``(echo ; echo "**bold**") | txt2tags -t html -H -`` 338 339Pràctica forma de realitzar comprovacions ràpides utilitzant STDIN. 340 341: ``txt2tags -t html -o - arxiu.t2t | tidy > arxiu.html`` 342 343Envia el resultat a STDOUT, desde on se'l redirigeix a un programa extern (tidy) abans de ser guardat. 344: 345 346= ARXIUS =[files] 347 348: ~/.txt2tagsrc 349Arxiu de configuració de l'usuari, per defecte. 350: 351 352= ENTORN =[environment] 353 354: T2TCONFIG 355Si no es nul, defineix el pathname de l'arxiu de configuració de l'usuari per defecte. 356: 357 358= AUTOR =[author] 359 360Aurelio Jargas <verde@aurelio.net> 361 362Traducció al català realitzada per Antoni Serra Devecchi <antoni.serra@gmail.com> 363 364= BUGS =[bugs] 365 366http://bugs.txt2tags.org 367 368= COPYRIGHT =[copyright] 369 370Copyright (C) 2001-%%date(%Y) Aurelio Jargas, GNU GPL v2