/doc/Spanish/manpage-es.html
HTML | 472 lines | 458 code | 14 blank | 0 comment | 0 complexity | 5fccaaf7a7f48d8fa7f030f083006c99 MD5 | raw file
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 2<HTML> 3<HEAD> 4<STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE> 5<META NAME="generator" CONTENT="http://txt2tags.org"> 6<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8"> 7<TITLE>TXT2TAGS</TITLE> 8</HEAD><BODY BGCOLOR="white" TEXT="black"> 9<CENTER> 10<H1>TXT2TAGS</H1> 11<FONT SIZE="4">Aug, 2010</FONT> 12</CENTER> 13 14<P></P> 15<HR NOSHADE SIZE=1> 16<P></P> 17 18 <UL> 19 <LI><A HREF="#name">NOMBRE</A> 20 <LI><A HREF="#synopsis">SINOPSIS</A> 21 <LI><A HREF="#description">DESCRIPCIÓN</A> 22 <LI><A HREF="#markup">MARCADO</A> 23 <LI><A HREF="#options">OPCIONES</A> 24 <LI><A HREF="#source">ARCHIVO FUENTE</A> 25 <LI><A HREF="#settings">AJUSTES</A> 26 <LI><A HREF="#commands">COMANDOS</A> 27 <LI><A HREF="#macros">MACROS</A> 28 <LI><A HREF="#examples">EJEMPLOS</A> 29 <LI><A HREF="#files">ARCHIVOS</A> 30 <LI><A HREF="#environment">ENTORNO</A> 31 <LI><A HREF="#author">AUTOR</A> 32 <LI><A HREF="#bugs">BUGS</A> 33 <LI><A HREF="#copyright">COPYRIGHT</A> 34 </UL> 35 36<P></P> 37<HR NOSHADE SIZE=1> 38<P></P> 39 40<A NAME="name"></A> 41<H1>NOMBRE</H1> 42 43<P> 44txt2tags - Herramienta de formateo y conversión de texto. 45</P> 46 47<A NAME="synopsis"></A> 48<H1>SINOPSIS</H1> 49 50<P> 51<B>txt2tags</B> [<I>opciones</I>] [<I>ARCHIVO</I>...] 52</P> 53 54<A NAME="description"></A> 55<H1>DESCRIPCIÓN</H1> 56 57<P> 58<B>txt2tags</B> lee un archivo de texto que ha sido mínimamente marcado y lo convierte a los siguientes formatos: 59<I>ASCII Art</I>, 60<I>AsciiDoc</I>, 61<I>Creole</I>, 62<I>DocBook</I>, 63<I>DokuWiki</I>, 64<I>Google Code Wiki</I>, 65<I>HTML</I>, 66<I>LaTeX</I>, 67<I>Lout</I>, 68<I>MagicPoint</I>, 69<I>Man page</I>, 70<I>MoinMoin</I>, 71<I>PageMaker</I>, 72<I>Plain Text (Texto Plano)</I>, 73<I>PmWiki</I>, 74<I>SGML</I>, 75<I>Wikipedia</I> and 76<I>XHTML</I>. 77</P> 78<P> 79Esta página de manual (Man page) fué creada con <B>txt2tags</B> a partir de un archivo de texto plano. El mismo archivo de texto fué también convertido en un archivo HTML para generar la versión online de este manual. 80</P> 81<P> 82UNA única fuente, MÚLTIPLES formatos de salida - <A HREF="http://txt2tags.org">http://txt2tags.org</A> 83</P> 84 85<A NAME="markup"></A> 86<H1>MARCADO</H1> 87 88<PRE> 89 Encabezado Las primeras tres líneas del archivo fuente. 90 Título = texto = 91 Título numerado + texto + 92 Comentario % comentarios 93 Línea de separación -----------------------... 94 Línea gruesa =======================... 95 Imagen [nombre.jpg] 96 Enlace [etiqueta url] 97 98 Negrita **texto** 99 Cursiva //texto// 100 Subrayado __texto__ 101 Tachado --texto-- 102 Monoespacio ``texto`` 103 Raw ""texto"" 104 Etiquetado ''texto'' 105 106 Párrafo texto 107 Cita <TAB>texto 108 Lista - texto 109 Lista numerada + texto 110 Lista de definición : texto 111 Tabla | celda1 | celda2 | celda3... 112 113 Línea verbatim ``` texto 114 Línea Raw """ texto 115 Línea Etiquetada ''' texto 116 117 Bloque Verbatim ``` 118 líneas 119 ``` 120 Bloque Raw """ 121 líneas 122 """ 123 Bloque etiquetado ''' 124 líneas 125 ''' 126</PRE> 127 128<A NAME="options"></A> 129<H1>OPCIONES</H1> 130 131<DL> 132<DT><B>-C</B>, <B>--config-file</B>=<I>ARCHIVO</I></DT><DD> 133Lee la configuración desde el archivo externo especificado en <I>ARCHIVO</I>. La configuración debe estar en formato <I>%!keyword:value</I> . Para mas detalles, véase la sección <A HREF="#settings">AJUSTES</A>. 134<P></P> 135<DT> <B>--css-sugar</B></DT><DD> 136Mejora el código HTML/XHTML generado para poder usar archivos CSS. Se eliminan los atributos de las etiquetas, se ignoran las etiquetas de presentación, los encabezados se generan con etiquetas H1, H2 y H3 y se crean nuevas DIVs : <I>#header</I>, <I>#body</I>, <I>.toc</I>. 137<P></P> 138<DT> <B>--css-inside</B></DT><DD> 139Inserta el contenido de un archivo CSS en el encabezado HTML/XHTML. Usar <CODE>--style</CODE> para especificar el archivo CSS que debe leerse. 140<P></P> 141<DT> <B>--dump-config</B></DT><DD> 142Muestra toda la configuración encontrada y sale. 143<P></P> 144<DT> <B>--dump-source</B></DT><DD> 145Muestra el documento fuente, con todas sus inclusiones (<CODE>%!include</CODE>) expandidas. 146<P></P> 147<DT> <B>--encoding</B>=<I>CÓDIGO</I></DT><DD> 148Establece la configuración de caracteres del archivo de salida usando la establecida en <I>CÓDIGO</I>. Ejemplos de <I>CÓDIGO</I>: UTF-8 y iso-8859-1. 149<P></P> 150<DT> <B>--gui</B></DT><DD> 151Llama la Interfaz Gráfica Tk. 152<P></P> 153<DT><B>-h</B>, <B>--help</B></DT><DD> 154Muestra la información de ayuda y sale. 155<P></P> 156<DT><B>-H</B>, <B>--no-headers</B></DT><DD> 157Elimina los encabezados y los piés de página del archivo de salida. Solo se mostrarán los contenidos (cuerpo del documento). 158<P></P> 159<DT> <B>--headers</B></DT><DD> 160Muestra los encabezados y piés de página del archivo de salida. Por defecto: ON. 161<P></P> 162<DT> <B>--height</B>=<I>NUM</I></DT><DD> 163Fija el número de líneas del archivo de salida al señalado en <I>NUM</I>. Esta opción solo se usa en formatos de salida ASCII Art, cuando también se esté usando <CODE>--slides</CODE>. 164<P></P> 165<DT><B>-i</B>, <B>--infile</B>=<I>ARCHIVO</I></DT><DD> 166Toma <I>ARCHIVO</I> como archivo fuente. Usar '-' para leer la fuente desde STDIN. 167<P></P> 168<DT> <B>--mask-email</B></DT><DD> 169Oculta los emails a los robots de spam. Elimina @ y puntos. La dirección foo@bar.com se convierte en <foo (a) bar com>. 170<P></P> 171<DT><B>-n</B>, <B>--enum-title</B></DT><DD> 172Activa la numeración automática de los títulos. Está prefijada en: 1, 1.1, 1.1.1, ... 173<P></P> 174<DT> <B>--no-dump-config</B></DT><DD> 175Cancela la acción <CODE>--dump-config</CODE>. 176<P></P> 177<DT> <B>--no-dump-source</B></DT><DD> 178Cancela la acción <CODE>--dump-source</CODE>. 179<P></P> 180<DT> <B>--no-encoding</B></DT><DD> 181Elimina la configuración de caracteres. 182<P></P> 183<DT> <B>--no-enum-title</B></DT><DD> 184Desactiva la numeración automática de los títulos. 185<P></P> 186<DT> <B>--no-infile</B></DT><DD> 187Elimina toda anterior declaración <CODE>--infile</CODE>. 188<P></P> 189<DT> <B>--no-targets</B></DT><DD> 190Elimina la acción <CODE>--targets</CODE>. 191<P></P> 192<DT> <B>--no-mask-email</B></DT><DD> 193Desactiva la ocultación de emails. 194<P></P> 195<DT> <B>--no-outfile</B></DT><DD> 196Elimina toda anterior declaración <CODE>--outfile</CODE>. 197<P></P> 198<DT> <B>--no-quiet</B></DT><DD> 199Muestra los mensajes, desactiva la opción <CODE>--quiet</CODE>. 200<P></P> 201<DT> <B>--no-rc</B></DT><DD> 202No leer en el archivo de configuración del usuario ~/.txt2tagsrc. 203<P></P> 204<DT> <B>--no-slides</B></DT><DD> 205Desactiva <CODE>--slides</CODE>. 206<P></P> 207<DT> <B>--no-style</B></DT><DD> 208Elimina todos los ajustes de estilo. 209<P></P> 210<DT> <B>--no-toc</B></DT><DD> 211Elimina la Tabla de Contenidos (TOC) en el archivo de salida. 212<P></P> 213<DT> <B>--no-toc-only</B></DT><DD> 214Desactiva la acción <CODE>--toc-only</CODE>. 215<P></P> 216<DT><B>-o</B>, <B>--outfile</B>=<I>ARCHIVO</I> </DT><DD> 217Toma <I>ARCHIVO</I> como nombre del archivo de salida. Usar '-' para dirigir los resultados a STDOUT. 218<P></P> 219<DT><B>-q</B>, <B>--quiet</B></DT><DD> 220Modo silencioso. Suprime todos los mensajes del sistema, excepto los de error. 221<P></P> 222<DT> <B>--rc</B></DT><DD> 223Lee el archivo de configuración (ajustes) del usuario ~/.txt2tagsrc. Por defecto: ON. 224<P></P> 225<DT> <B>--slides</B></DT><DD> 226Formatea el archivo de salida como una presentación de diapositivas. Esta opción se usa solo en formatos de salida ASCII Art. 227<P></P> 228<DT> <B>--style</B>=<I>ARCHIVO</I></DT><DD> 229Usa <I>ARCHIVO</I> como el archivo que contiene el estilo del documento. Usado para definir archivos CSS en documentos HTML/XHTML y ´´módulos´´ para LaTeX. Esta opción puede usarse múltiples veces para incluir múltiples archivos de estilo. 230<P></P> 231<DT><B>-t</B>, <B>--target</B>=<I>TIPO</I></DT><DD> 232Fija el formato de documento de salida al establecido en <I>TIPO</I>. Los formatos de documento mas corrientes son: <I>html</I>, <I>xhtml</I>, <I>tex</I>, <I>man</I>, <I>txt</I>. Usar la opción <CODE>--targets</CODE> para ver los formatos disponibles. 233<P></P> 234<DT> <B>--targets</B></DT><DD> 235Muestra los formatos disponibles para los archivos de salida y sale. 236<P></P> 237<DT> <B>--toc</B></DT><DD> 238Incluye, automaticamente, una Tabla de Contenidos (TOC) en el archivo de salida, entre el encabezado (HEADER) y el cuerpo del documento (BODY). El usuario puede especificar la posición de la TOC usando el macro <CODE>%%TOC</CODE>. 239<P></P> 240<DT> <B>--toc-level</B>=<I>NUM</I></DT><DD> 241Fija el nivel máximo de la Tabla de Contenidos (TOC) al número especificado en <I>NUM</I>. Los niveles inferiores a <I>NUM</I> no serán incluidos en la tabla de contenidos. 242<P></P> 243<DT> <B>--toc-only</B></DT><DD> 244Muestra la Tabla de Contenidos (TOC) y sale. 245<P></P> 246<DT><B>-v</B>, <B>--verbose</B></DT><DD> 247Muestra los mensajes del sistema durante la conversión. Esta opción puede usarse múltiples veces para incrementar el número de mensajes a mostrar. 248<P></P> 249<DT><B>-V</B>, <B>--version</B></DT><DD> 250Muestra la versión del programa y sale. 251<P></P> 252<DT> <B>--width</B>=<I>NUM</I></DT><DD> 253Fija al número especificado en <I>NUM</I> la anchura de las columnas del archivo de salida. Esta opción se usa solo con archivos de salida en formato ASCII Art. 254</DL> 255 256<A NAME="source"></A> 257<H1>ARCHIVO FUENTE</H1> 258 259<P> 260Los archivos fuente suelen identificarse por la extensión <I>.t2t</I> (por ejemplo, <CODE>miarchivo.t2t</CODE>). En un archivo fuente podemos considerar tres áreas: 261</P> 262 263<DL> 264<DT><B>Encabezado</B> (opcional)</DT><DD> 265Las tres primeras líneas del archivo. Si no se necesitara encabezado, dejar la primera línea en blanco. Esta área suele utilizarse para emplazar el título del documento y la información sobre el autor, la versión y la fecha. 266<P></P> 267<DT><B>Ajustes</B> (opcional)</DT><DD> 268Comienzan justo después del Encabezado (4ª línea, o 2ª línea en el caso de omitir el encabezado) y finalizan al comienzo del área de Cuerpo del Documento.. 269Usados para para implementar ajustes (configuraciones) en formato <CODE>%!keyword:value</CODE>. 270<P></P> 271<DT><B>Cuerpo del Documento</B></DT><DD> 272Comienza con la primera línea de texto válido (que no sea comentario o ajustes) después del Encabezado y se extiende hasta el final del documeno. En esta área es en la que se encuentra el contenido del documento. 273</DL> 274 275<A NAME="settings"></A> 276<H1>AJUSTES</H1> 277 278<P> 279Los Ajustes nos permiten personalizar <B>txt2tags</B>; son similares a las opciones. Pueden emplazarse: en el área de Ajustes del documento fuente, en el archivo <CODE>~/.txt2tagsrc</CODE> o en un archivo externo que se invoca mediante la opción <CODE>--config-file</CODE>. 280</P> 281 282<DL> 283<DT><B>%!target</B></DT><DD> 284Define el formato del archivo de salida, tal como lo haria la opción <CODE>--target</CODE>. Ejemplo: 285 286<PRE> 287 %!target: html 288</PRE> 289 290<P></P> 291<DT><B>%!options(tipo)</B></DT><DD> 292Define las opciones por defecto para cada tipo de archivo de salida. Deben usarse las opciones de línea de comandos (las que empiezan por -- ). Ejemplo: 293 294<PRE> 295 %!options(html): --toc --toc-level 3 --css-sugar 296</PRE> 297 298<P></P> 299<DT><B>%!includeconf</B></DT><DD> 300Incluye, en el archivo en uso, las configuraciones definidas en un archivo externo, tal como lo haria la opción <CODE>--config-file</CODE>. Ejemplo: 301 302<PRE> 303 %!includeconf: miconfig.t2t 304</PRE> 305 306<P></P> 307<DT><B>%!style</B></DT><DD> 308Utiliza un archivo de estilo externo en el documento en uso, tal como lo haria la opción <CODE>--style</CODE>. Puede utilizarse múltiples veces. Ejemplo: 309 310<PRE> 311 %!style: colores.css 312</PRE> 313 314<P></P> 315<DT><B>%!encoding</B></DT><DD> 316Define la codificación de caracteres que se utilizará en el documento convertido, tal como lo haria la opción <CODE>--encoding</CODE>. Ejemplo : 317 318<PRE> 319 %!encoding: UTF-8 320</PRE> 321 322<P></P> 323<DT><B>%!preproc</B></DT><DD> 324Filtro input de buscar/reemplazar utilizado para realizar cambios en el cuerpo del documento fuente ANTES de que txt2tags realice cualquier acción. La búsqueda utiliza expresiones regulares de Python. Ejemplo: 325 326<PRE> 327 %!preproc: "JJS" "John J. Smith" 328</PRE> 329 330<P></P> 331<DT><B>%!postproc</B></DT><DD> 332Filtro output de buscar/reemplazar utilizado para realizar cambios en el documento generado DESPUÉS del completo procesamiento del archivo fuente por txt2tags. La búsqueda utiliza expresiones regulares de Python. Ejemplo: 333 334<PRE> 335 %!postproc(html): "<B>" "<STRONG>" 336</PRE> 337 338</DL> 339 340<P> 341Si la misma palabra clave aparece mas de una vez, la última encontrada será que se utilizará (excepciones: opciones, preproc y postproc, que son acumulativas). Las palabras clave inválidas serán ignoradas. El orden de procesamiento es: <CODE>~/.txt2tagsrc</CODE>, area de Ajustes del documento fuente, opción <CODE>--config-file</CODE>. 342</P> 343 344<A NAME="commands"></A> 345<H1>COMANDOS</H1> 346 347<P> 348Los Comandos ejecutan tareas durante el proceso de conversión. Deben emplazarse en el cuerpo del documento fuente. 349</P> 350 351<DL> 352<DT><B>%!csv: archivo.csv</B></DT><DD> 353Incorpora un archivo CSV como una tabla. 354<P></P> 355<DT><B>%!include: archivo.t2t</B></DT><DD> 356Incorpora al documento un archivo txt2tags. 357<P></P> 358<DT><B>%!include: ``archivo.txt``</B></DT><DD> 359Incorpora en el documento un archivo de texto (verbatim). 360<P></P> 361<DT><B>%!include: ''archivo.html''</B></DT><DD> 362Incorpora al documento un archivo etiquetado. 363</DL> 364 365<A NAME="macros"></A> 366<H1>MACROS</H1> 367 368<P> 369Mediante las Macros podremos insertar, de una forma fácil, contenidos dinámicos en el documento convertido. Deben definirse en el cuerpo del documento fuente. Con la excepción de <CODE>%%toc</CODE>, todos las macros pueden ser personalizadas con directivas especiales, tales como <CODE>%Y</CODE> y <CODE>%f</CODE>. Para mas detalles, consultar la <B>Guia del Usuario de txt2tags</B>. 370</P> 371 372<DL> 373<DT><B>%%date</B></DT><DD> 374Inserta la fecha actual. Su formato por defecto es: <CODE>%%date(%Y%m%d)</CODE>, que nos mostrará la fecha como: AAAAMMDD. 375<P></P> 376<DT><B>%%infile</B></DT><DD> 377Inserta la ruta del archivo fuente. Su formato por defecto es: <CODE>%%infile(%f)</CODE>. Útil para enlaces del tipo: <CODE>[Ver fuente %%infile]</CODE>. 378<P></P> 379<DT><B>%%mtime</B></DT><DD> 380Inserta la fecha de modificación del archivo fuente. Su formato por defecto es: <CODE>%%date(%Y%m%d)</CODE>, que nos mostrará la fecha como AAAAMMDD. 381<P></P> 382<DT><B>%%outfile</B></DT><DD> 383Inserta la ruta del archivo final. Su formato por defecto es: <CODE>%%outfile(%f)</CODE>. Útil en menciones del tipo: "Este es el archivo manpage-es.html". 384<P></P> 385<DT><B>%%toc</B></DT><DD> 386Con ella el usuario puede especificar la ubicación de la Tabla de Contenidos (TOC). Puede utilizarse repetidas veces. Debe utilizarse conjuntamente con la opción <CODE>--toc</CODE>. 387</DL> 388 389<A NAME="examples"></A> 390<H1>EJEMPLOS</H1> 391 392<DL> 393<DT><CODE>txt2tags -t html archivo.t2t</CODE></DT><DD> 394<P></P> 395Convierte a HTML, guardando el resultado como archivo.html. 396<P></P> 397<DT><CODE>txt2tags -t html -o - archivo.t2t</CODE></DT><DD> 398<P></P> 399Convierte a HTML, mostrando el resultado en STDOUT. 400<P></P> 401<DT><CODE>txt2tags -t html --toc archivo.t2t</CODE></DT><DD> 402<P></P> 403Convierte a HTML, generando una Tabla de Contenidos (TOC) de forma automática. 404<P></P> 405<DT><CODE>txt2tags -t html --toc --toc-level 2 -n archivo.t2t</CODE></DT><DD> 406<P></P> 407Convierte a HTML, con una Tabla de Contenidos (TOC) a dos niveles y títulos numerados. 408<P></P> 409<DT><CODE>txt2tags --toc-only archivo.t2t</CODE></DT><DD> 410<P></P> 411Solo nos muestra la Tabla de Contenidos (TOC), sin realizar conversión alguna en el documento fuente. 412<P></P> 413<DT><CODE>txt2tags -t html --css-sugar --style base.css --style ui.css archivo.t2t</CODE></DT><DD> 414<P></P> 415Convierte a HTML, preparando el código resultante para poder utilizar CSS, incluyendo también una llamada a dos archivos CSS externos (base.css y ui.css). 416<P></P> 417<DT><CODE>txt2tags -t art --slides --width 80 --height 25 -o - archivo.t2t | more</CODE></DT><DD> 418<P></P> 419Crea una presentación de diapositivas tipo ASCII Art, apta para ser visionada en un terminal pantalla/ventana 80x25. 420<P></P> 421<DT><CODE>(echo ; echo "**bold**") | txt2tags -t html -H -</CODE></DT><DD> 422<P></P> 423Práctica forma de realizar comprobaciones rápidas usando STDIN. 424<P></P> 425<DT><CODE>txt2tags -t html -o - archivo.t2t | tidy > archivo.html</CODE></DT><DD> 426<P></P> 427Envia el resultado a STDOUT, desde donde se le redirige a un programa externo (tidy) antes de ser guardado. 428</DL> 429 430<A NAME="files"></A> 431<H1>ARCHIVOS</H1> 432 433<DL> 434<DT>~/.txt2tagsrc</DT><DD> 435Archivo de configuración del usuario, por defecto. 436</DL> 437 438<A NAME="environment"></A> 439<H1>ENTORNO</H1> 440 441<DL> 442<DT>T2TCONFIG</DT><DD> 443Si no es nulo, define el pathname completo para el archivo de configuración del usuario por defecto. 444</DL> 445 446<A NAME="author"></A> 447<H1>AUTOR</H1> 448 449<P> 450Aurelio Jargas <<verde (a) aurelio net>> 451</P> 452<P> 453Traducción al español realizada por Antoni Serra Devecchi <<antoni serra (a) gmail com>> 454</P> 455 456<A NAME="bugs"></A> 457<H1>BUGS</H1> 458 459<P> 460<A HREF="http://bugs.txt2tags.org">http://bugs.txt2tags.org</A> 461</P> 462 463<A NAME="copyright"></A> 464<H1>COPYRIGHT</H1> 465 466<P> 467Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2 468</P> 469 470<!-- html code generated by txt2tags 2.6 (http://txt2tags.org) --> 471<!-- cmdline: txt2tags -t html doc/Spanish/manpage-es.t2t --> 472</BODY></HTML>