PageRenderTime 31ms CodeModel.GetById 13ms app.highlight 7ms RepoModel.GetById 2ms app.codeStats 0ms

/doc/Catalan/manpage-ca.man

http://txt2tags.googlecode.com/
Unknown | 465 lines | 334 code | 131 blank | 0 comment | 0 complexity | 08f9348a03a50f3da2ef364d0e99a000 MD5 | raw file
  1.TH "TXT2TAGS" 1 "Aug, 2010" ""
  2
  3
  4.SH NOM
  5
  6.P
  7txt2tags \- Eina de formatació i conversió de texte.
  8
  9.SH SINOPSI
 10
 11.P
 12\fBtxt2tags\fR [\fIopcions\fR] [\fIARXIU\fR...]
 13
 14.SH DESCRIPCIÓ
 15
 16.P
 17\fBtxt2tags\fR llegeig un arxiu de texte que ha estat mínimament marcat i el converteix las siguents formats:
 18\fIASCII Art\fR,
 19\fIAsciiDoc\fR,
 20\fICreole\fR,
 21\fIDocBook\fR,
 22\fIDokuWiki\fR,
 23\fIGoogle Code Wiki\fR,
 24\fIHTML\fR,
 25\fILaTeX\fR,
 26\fILout\fR,
 27\fIMagicPoint\fR,
 28\fIMan page\fR,
 29\fIMoinMoin\fR,
 30\fIPageMaker\fR,
 31\fIPlain Text (Texte Plà)\fR,
 32\fIPmWiki\fR,
 33\fISGML\fR,
 34\fIWikipedia\fR 
 35\fIXHTML\fR.
 36
 37.P
 38Aquesta pàgina de manual (Man page) fou creada amb \fBtxt2tags\fR 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.
 39
 40.P
 41UNA única font, MÚLTIPLES formats de sortida \- http://txt2tags.org
 42
 43.SH MARCAT
 44
 45.nf
 46Encapçalaments            Les primeres tres línies de l'arxiu font.
 47Títol                     = texte =
 48Títol numerat             + texte +
 49Comentari                 % comentaris
 50Línia de separació        -----------------------...
 51Línia gruixuda            =======================...
 52Imàgen                    [nom.jpg]
 53Enlaç                     [etiqueta url]
 54
 55Negreta                   **texte**
 56Cursiva                   //texte//
 57ratllat                   __texte__
 58Tatxat                    --texte--
 59Monoespai                 ``texte``
 60Raw                       ""texte""
 61Etiquetat                 ''texte''
 62
 63Paràgraf                  texte
 64Cita                      <TAB>texte
 65Llista                    - texte
 66Llista numerada           + texte
 67Llista de definició       : texte
 68Taula                     | cel.la1 | cel.la2 | cel.la3...
 69
 70Línia verbatim            ``` texte
 71Línia Raw                 """ texte
 72Línia Etiquetada          ''' texte
 73
 74Bloc Verbatim             ```
 75                          línies
 76                          ```
 77Bloc Raw                  """
 78                          línies
 79                          """
 80Bloc etiquetat            '''
 81                          línies
 82                          '''
 83.fi
 84
 85
 86.SH OPCIONS
 87
 88.TP
 89\fB\-C\fR, \fB\-\-config\-file\fR=\fIARXIU\fR
 90Llegeig la configuració (ajusts) especificats a l'arxiu extern   \fIARXIU\fR. La configuració ha d'estar en format   \fI%!keyword:value\fR. Per a més detalls, consultar la secció  AJUSTS.
 91
 92.TP
 93    \fB\-\-css\-sugar\fR
 94Millora 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 :  \fI#header\fR,  \fI#body\fR,  \fI.toc\fR.
 95
 96.TP
 97    \fB\-\-css\-inside\fR
 98Insereix el contingut d'un arxiu CSS dins l'encapçalament  HTML/XHTML. Utilitzar  \-\-style  per especificar l'arxiu CSS que s'ha de llegir.
 99
100.TP
101    \fB\-\-dump\-config\fR
102Mostra tota la configuració (ajusts) i surt.
103
104.TP
105    \fB\-\-dump\-source\fR
106Mostra el document font, amb totes les seves les inclusions  (%!include) expandides.
107
108.TP
109    \fB\-\-encoding\fR=\fICODI\fR
110Estableix la configuració de caràcters que s'utilitzarà a l'arxiu de sortida, utilitzant l'establerta a  \fICODI\fR. Exemples de  \fICODI\fR: UTF\-8 y iso\-8859\-1.
111
112.TP
113    \fB\-\-gui\fR
114Activa la Interfície Gráfica Tk.
115
116.TP
117\fB\-h\fR, \fB\-\-help\fR
118Mostra la informació d'ajut i surt.
119
120.TP
121\fB\-H\fR, \fB\-\-no\-headers\fR
122Elimina els encapçalaments i els peus de pàgina de l'arxiu de sortida. Sols es mostraràn els continguts (cos del document).
123
124.TP
125    \fB\-\-headers\fR
126Mostra els encapçalaments i els peus de pàgina de l'arxiu de sortida. Per defecte: ON.
127
128.TP
129    \fB\-\-height\fR=\fINUM\fR
130Fixa el nombre de línies de l'arxiu de sortida a l'establert a  \fINUM\fR. Aquesta opció s'utilitza sols amb formats de sortida  ASCII Art, quan també s'estigui utilitzant l'opció \-\-slides.
131
132.TP
133\fB\-i\fR, \fB\-\-infile\fR=\fIARXIU\fR
134Pren  \fIARXIU\fR  com l'arxiu font. Utilitzar '\-' per a llegir la font des de STDIN.
135
136.TP
137    \fB\-\-mask\-email\fR
138Oculta els emails als robots de spam. Elimina @ i punts. L'adreça foo@bar.com esdevé <foo (a) bar com>.
139
140.TP
141\fB\-n\fR, \fB\-\-enum\-title\fR
142Activa la numeració automàtica dels títols. Està prefixada a: 1, 1.1, 1.1.1, ...
143
144.TP
145    \fB\-\-no\-dump\-config\fR
146Anul.la  l'acció  \-\-dump\-config.
147
148.TP
149    \fB\-\-no\-dump\-source\fR
150Anul.la  l'acció  \-\-dump\-source.
151
152.TP
153    \fB\-\-no\-encoding\fR
154Anul.la la configuració de caràcters.
155
156.TP
157    \fB\-\-no\-enum\-title\fR
158Desactiva la numeració automàtica dels títols.
159
160.TP
161    \fB\-\-no\-infile\fR
162Anul.la tota anterior declaració   \-\-infile.
163
164.TP
165    \fB\-\-no\-targets\fR
166Anul.la l'acció   \-\-targets.
167
168.TP
169    \fB\-\-no\-mask\-email\fR
170Desactiva l'ocultació dels emails.
171
172.TP
173    \fB\-\-no\-outfile\fR
174Anul.la tota anterior declaració  \-\-outfile.
175
176.TP
177    \fB\-\-no\-quiet\fR
178Mostra els missatges del sistema, desactiva l'opció  \-\-quiet.
179
180.TP
181    \fB\-\-no\-rc\fR
182No llegir a l'arxiu de configuració (ajusts) de l'usuari   ~/.txt2tagsrc.
183
184.TP
185    \fB\-\-no\-slides\fR
186Desactiva  \-\-slides.
187
188.TP
189    \fB\-\-no\-style\fR
190Desactiva tots els ajusts d'estil.
191
192.TP
193    \fB\-\-no\-toc\fR
194Elimina la Taula de Continguts (TOC) a l'arxiu de sortida.
195
196.TP
197    \fB\-\-no\-toc\-only\fR
198Desactiva l'acció  \-\-toc\-only.
199
200.TP
201\fB\-o\fR, \fB\-\-outfile\fR=\fIARXIU\fR
202Pren  \fIARXIU\fR  com a nom per a l'arxiu de sortida. Utilitzar '\-' per a dirigir els resultats a STDOUT.
203
204.TP
205\fB\-q\fR, \fB\-\-quiet\fR
206Mode silenciós. Suprimeix tots els missatges del sistema, excepte els dels errors.
207
208.TP
209    \fB\-\-rc\fR
210Llegeig a l'arxiu de configuració de l'usuari  ~/.txt2tagsrc. Per defecte: ON.
211
212.TP
213    \fB\-\-slides\fR
214Formata l'arxiu de sortida com una presentació de diapositives. Aquesta opció s'utilitza sols amb formats de sortida ASCII Art.
215
216.TP
217    \fB\-\-style\fR=\fIARXIU\fR
218Utilitza  \fIARXIU\fR  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.
219
220.TP
221\fB\-t\fR, \fB\-\-target\fR=\fITIPUS\fR
222Fixa el format del document de sortida a l'establert a  \fITIPUS\fR. Els formats de document mes corrents son: \fIhtml\fR, \fIxhtml\fR, \fItex\fR, \fIman\fR, \fItxt\fR. Utilitzar l'opció  \-\-targets per a consultar els formats disponibles.
223
224.TP
225    \fB\-\-targets\fR
226Mostra els formats de document disponibles per als arxius de sortida i surt.
227
228.TP
229    \fB\-\-toc\fR
230Inclou, 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.
231
232.TP
233    \fB\-\-toc\-level\fR=\fINUM\fR
234Fixa el nivell màxim de la Taula de Continguts (TOC) al número especificat a  \fINUM\fR. Tots els títols inferiors a  \fINUM\fR no serán inclosos a la Taula de Continguts.
235
236.TP
237    \fB\-\-toc\-only\fR
238Mostra la Taula de Continguts (TOC) i surt.
239
240.TP
241\fB\-v\fR, \fB\-\-verbose\fR
242Mostra 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.
243
244.TP
245\fB\-V\fR, \fB\-\-version\fR
246Mostra l'actual versió del programa i surt.
247
248.TP
249    \fB\-\-width\fR=\fINUM\fR 
250Fixa al número especificat a  \fINUM\fR  l'amplada de les columnes de l'arxiu de sortida. Aquesta opció s'utilitza sols amb formats de sortida del tipus ASCII Art.
251
252.SH ARXIU FONT
253
254.P
255Els arxius font acostumen a especificar\-se mitjançant l'extensió  \fI.t2t\fR  (per exemple, arxiu.t2t). Dins d'un arxiu font hi podem considerar tres àrees :
256
257.TP
258\fBEncapçalament\fR (opcional)
259Les 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.
260
261.TP
262\fBAjusts\fR (opcional)
263Començ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.
264Utilitzats per a implementar ajusts (configuracions) en format  %!keyword:value.
265
266.TP
267\fBCos del Document\fR
268Començ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.
269
270.SH AJUSTS
271
272.P
273Els ajusts ens permeten personalitzar  \fBtxt2tags\fR; 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.
274
275.TP
276\fB%!target\fR
277Defineix el format de l'arxiu de sortida, tal com ho faria l'opció  \-\-target. Exemple:
278.nf
279%!target: html
280.fi
281
282
283
284.TP
285\fB%!options(tipo)\fR
286Defineix 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:
287.nf
288%!options(html): --toc --toc-level 3 --css-sugar
289.fi
290
291
292
293.TP
294\fB%!includeconf\fR
295Inclou, a l'arxiu corrent, els ajusts definits a un arxiu extern, tal com ho faria l'opció  \-\-config\-file. Exemple:
296.nf
297%!includeconf: miconfig.t2t
298.fi
299
300
301
302.TP
303\fB%!style\fR 
304Utilitza un arxiu d'estil extern, tal com ho faria l'opció  \-\-style. Es pot utilitzar repetides vegades. Exemple:
305.nf
306%!style: colores.css
307.fi
308
309
310
311.TP
312\fB%!encoding\fR
313Defineix la codificació de caràcters que s'utilitzarà al document convertit, tal com ho faria l'opció  \-\-encoding. Exemple :
314.nf
315%!encoding: UTF-8
316.fi
317
318
319
320.TP
321\fB%!preproc\fR
322Filtre 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:
323.nf
324%!preproc:  "JJS"  "John J. Smith"
325.fi
326
327
328
329.TP
330\fB%!postproc\fR
331Filtre 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:
332.nf
333%!postproc(html):  "<B>"  "<STRONG>"
334.fi
335
336
337
338.P
339Si 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.
340
341.SH ORDRES
342
343.P
344Les Ordres executen tasques durant el procés de conversió. S'han d'emplaçar en el cos del document font.
345
346.TP
347\fB%!csv: arxiu.csv\fR
348Incorpora un arxiu CSV com una tabla.
349
350.TP
351\fB%!include: arxiu.t2t\fR
352Incorpora al document un arxiu txt2tags.
353
354.TP
355\fB%!include: ``arxiu.txt``\fR
356Incorpora al document un arxiu de text (verbatim).
357
358.TP
359\fB%!include: \&''arxiu.html''\fR
360Incorpora al document un arxiu marcat.
361
362.SH MACROS
363
364.P
365Mitjanç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 \fBGuia del Usuario de txt2tags\fR.
366
367.TP
368\fB%%date\fR
369Insereix la data actual. El seu format per defecte es:  %%date(%Y%m%d),  que ens mostrará la data com: AAAAMMDD.
370
371.TP
372\fB%%infile\fR
373Insereix el path de l'arxiu font. El seu format per defecte es:  %%infile(%f).  Útil per a enllaços del tipus: [Veure font %%infile].
374
375.TP
376\fB%%mtime\fR
377Insereix 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.
378
379.TP
380\fB%%outfile\fR
381Insereix el path de l'arxiu final. El seu format per defecte es:  %%outfile(%f). Útil en mencions del tipus: "Aquest es l'arxiu manpage\-ca.man".
382
383.TP
384\fB%%toc\fR
385Amb 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.
386
387.SH EXEMPLES
388
389.TP
390txt2tags \-t html arxiu.t2t
391
392Converteix a HTML, guardant el resultat com arxiu.html.
393
394.TP
395txt2tags \-t html \-o \- arxiu.t2t
396
397Converteix a HTML, mostrant el resultat a STDOUT.
398
399.TP
400txt2tags \-t html \-\-toc arxiu.t2t
401
402Converteix a HTML, generant una Taula de Continguts (TOC) de forma automàtica.
403
404.TP
405txt2tags \-t html \-\-toc \-\-toc\-level 2 \-n archivo.t2t
406
407Converteix a HTML, amb una Taula de Continguts (TOC) a dos nivells i títols numerats.
408
409.TP
410txt2tags \-\-toc\-only arxiu.t2t
411
412Ens mostra sols la Taula de Continguts (TOC), sense realitzar cap mena de conversió en el document font.
413
414.TP
415txt2tags \-t html \-\-css\-sugar \-\-style base.css \-\-style ui.css arxiu.t2t
416
417Converteix 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).
418
419.TP
420txt2tags \-t art \-\-slides \-\-width 80 \-\-height 25 \-o \- arxiu.t2t | more
421
422Crea una presentació de diapositives tipus ASCII Art, apta para a ser visionada amb un terminal pantalla/finestra 80x25.
423
424.TP
425(echo ; echo "**bold**") | txt2tags \-t html \-H \-
426
427Pràctica forma de realitzar comprovacions ràpides utilitzant STDIN.
428
429.TP
430txt2tags \-t html \-o \- arxiu.t2t | tidy > arxiu.html
431
432Envia el resultat a STDOUT, desde on se'l redirigeix a un programa extern (tidy) abans de ser guardat.
433
434.SH ARXIUS
435
436.TP
437~/.txt2tagsrc
438Arxiu de configuració de l'usuari, per defecte.
439
440.SH ENTORN
441
442.TP
443T2TCONFIG
444Si no es nul, defineix el pathname de l'arxiu de configuració de l'usuari per defecte.
445
446.SH AUTOR
447
448.P
449Aurelio Jargas <verde@aurelio.net>
450
451.P
452Traducció al català realitzada per Antoni Serra Devecchi <antoni.serra@gmail.com>
453
454.SH BUGS
455
456.P
457http://bugs.txt2tags.org
458
459.SH COPYRIGHT
460
461.P
462Copyright (C) 2001\-2010 Aurelio Jargas, GNU GPL v2
463
464.\" man code generated by txt2tags 2.6 (http://txt2tags.org)
465.\" cmdline: txt2tags -t man doc/Catalan/manpage-ca.t2t