/doc/Spanish/manpage-es.t2t
Unknown | 370 lines | 248 code | 122 blank | 0 comment | 0 complexity | bb7118d6d6c358255248a9d43cd494d7 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= NOMBRE =[name] 15 16txt2tags - Herramienta de formateo y conversión de texto. 17 18= SINOPSIS =[synopsis] 19 20**txt2tags** [//opciones//] [//ARCHIVO//...] 21 22= DESCRIPCIÓN =[description] 23 24**txt2tags** lee un archivo de texto que ha sido mínimamente marcado y lo convierte a los siguientes formatos: 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 (Texto Plano)//, 39//PmWiki//, 40//SGML//, 41//Wikipedia// and 42//XHTML//. 43% TRANSLATOR: please keep the alphabetical order of this list. 44 45 46Esta página de manual (Man page) fué creada con **txt2tags** 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. 47 48UNA única fuente, MÚLTIPLES formatos de salida - http://txt2tags.org 49 50 51= MARCADO =[markup] 52 53``` 54Encabezado Las primeras tres líneas del archivo fuente. 55Título = texto = 56Título numerado + texto + 57Comentario % comentarios 58Línea de separación -----------------------... 59Línea gruesa =======================... 60Imagen [nombre.jpg] 61Enlace [etiqueta url] 62 63Negrita **texto** 64Cursiva //texto// 65Subrayado __texto__ 66Tachado --texto-- 67Monoespacio ``texto`` 68Raw ""texto"" 69Etiquetado ''texto'' 70 71Párrafo texto 72Cita <TAB>texto 73Lista - texto 74Lista numerada + texto 75Lista de definición : texto 76Tabla | celda1 | celda2 | celda3... 77 78Línea verbatim ``` texto 79Línea Raw """ texto 80Línea Etiquetada ''' texto 81 82Bloque Verbatim ``` 83 líneas 84 ``` 85Bloque Raw """ 86 líneas 87 """ 88Bloque etiquetado ''' 89 líneas 90 ''' 91``` 92 93= OPCIONES =[options] 94 95: **-C**, **--config-file**=//ARCHIVO// 96Lee la configuración desde el archivo externo especificado en //ARCHIVO//. La configuración debe estar en formato //%!keyword:value// . Para mas detalles, véase la sección [AJUSTES #settings]. 97 98: **--css-sugar** 99Mejora 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 : //#header//, //#body//, //.toc//. 100 101: **--css-inside** 102Inserta el contenido de un archivo CSS en el encabezado HTML/XHTML. Usar ``--style`` para especificar el archivo CSS que debe leerse. 103 104: **--dump-config** 105Muestra toda la configuración encontrada y sale. 106 107: **--dump-source** 108Muestra el documento fuente, con todas sus inclusiones (``%!include``) expandidas. 109 110: **--encoding**=//CÓDIGO// 111Establece la configuración de caracteres del archivo de salida usando la establecida en //CÓDIGO//. Ejemplos de //CÓDIGO//: UTF-8 y iso-8859-1. 112 113: **--gui** 114Llama la Interfaz Gráfica Tk. 115 116: **-h**, **--help** 117Muestra la información de ayuda y sale. 118 119: **-H**, **--no-headers** 120Elimina los encabezados y los piés de página del archivo de salida. Solo se mostrarán los contenidos (cuerpo del documento). 121 122: **--headers** 123Muestra los encabezados y piés de página del archivo de salida. Por defecto: ON. 124 125: **--height**=//NUM// 126Fija el número de líneas del archivo de salida al señalado en //NUM//. Esta opción solo se usa en formatos de salida ASCII Art, cuando también se esté usando ``--slides``. 127 128: **-i**, **--infile**=//ARCHIVO// 129Toma //ARCHIVO// como archivo fuente. Usar '-' para leer la fuente desde STDIN. 130 131: **--mask-email** 132Oculta los emails a los robots de spam. Elimina @ y puntos. La dirección ""foo@bar.com"" se convierte en <foo (a) bar com>. 133 134: **-n**, **--enum-title** 135Activa la numeración automática de los títulos. Está prefijada en: 1, 1.1, 1.1.1, ... 136 137: **--no-dump-config** 138Cancela la acción ``--dump-config``. 139 140: **--no-dump-source** 141Cancela la acción ``--dump-source``. 142 143: **--no-encoding** 144Elimina la configuración de caracteres. 145 146: **--no-enum-title** 147Desactiva la numeración automática de los títulos. 148 149: **--no-infile** 150Elimina toda anterior declaración ``--infile``. 151 152: **--no-targets** 153Elimina la acción ``--targets``. 154 155: **--no-mask-email** 156Desactiva la ocultación de emails. 157 158: **--no-outfile** 159Elimina toda anterior declaración ``--outfile``. 160 161: **--no-quiet** 162Muestra los mensajes, desactiva la opción ``--quiet``. 163 164: **--no-rc** 165No leer en el archivo de configuración del usuario ~/.txt2tagsrc. 166 167: **--no-slides** 168Desactiva ``--slides``. 169 170: **--no-style** 171Elimina todos los ajustes de estilo. 172 173: **--no-toc** 174Elimina la Tabla de Contenidos (TOC) en el archivo de salida. 175 176: **--no-toc-only** 177Desactiva la acción ``--toc-only``. 178 179: **-o**, **--outfile**=//ARCHIVO// 180Toma //ARCHIVO// como nombre del archivo de salida. Usar '-' para dirigir los resultados a STDOUT. 181 182: **-q**, **--quiet** 183Modo silencioso. Suprime todos los mensajes del sistema, excepto los de error. 184 185: **--rc** 186Lee el archivo de configuración (ajustes) del usuario ~/.txt2tagsrc. Por defecto: ON. 187 188: **--slides** 189Formatea el archivo de salida como una presentación de diapositivas. Esta opción se usa solo en formatos de salida ASCII Art. 190 191: **--style**=//ARCHIVO// 192Usa //ARCHIVO// 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. 193 194: **-t**, **--target**=//TIPO// 195Fija el formato de documento de salida al establecido en //TIPO//. Los formatos de documento mas corrientes son: //html//, //xhtml//, //tex//, //man//, //txt//. Usar la opción ``--targets`` para ver los formatos disponibles. 196 197: **--targets** 198Muestra los formatos disponibles para los archivos de salida y sale. 199 200: **--toc** 201Incluye, 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 ``%%TOC``. 202 203: **--toc-level**=//NUM// 204Fija el nivel máximo de la Tabla de Contenidos (TOC) al número especificado en //NUM//. Los niveles inferiores a //NUM// no serán incluidos en la tabla de contenidos. 205 206: **--toc-only** 207Muestra la Tabla de Contenidos (TOC) y sale. 208 209: **-v**, **--verbose** 210Muestra 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. 211 212: **-V**, **--version** 213Muestra la versión del programa y sale. 214 215: **--width**=//NUM// 216Fija al número especificado en //NUM// la anchura de las columnas del archivo de salida. Esta opción se usa solo con archivos de salida en formato ASCII Art. 217: 218 219= ARCHIVO FUENTE =[source] 220 221Los archivos fuente suelen identificarse por la extensión //.t2t// (por ejemplo, ``miarchivo.t2t``). En un archivo fuente podemos considerar tres áreas: 222 223: **Encabezado** (opcional) 224Las 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. 225 226: **Ajustes** (opcional) 227Comienzan 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.. 228Usados para para implementar ajustes (configuraciones) en formato ``%!keyword:value``. 229 230: **Cuerpo del Documento** 231Comienza 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. 232: 233 234= AJUSTES =[settings] 235 236Los Ajustes nos permiten personalizar **txt2tags**; son similares a las opciones. Pueden emplazarse: en el área de Ajustes del documento fuente, en el archivo ``~/.txt2tagsrc`` o en un archivo externo que se invoca mediante la opción ``--config-file``. 237 238: **%!target** 239Define el formato del archivo de salida, tal como lo haria la opción ``--target``. Ejemplo: 240``` %!target: html 241 242: **%!options(tipo)** 243Define 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: 244``` %!options(html): --toc --toc-level 3 --css-sugar 245 246: **%!includeconf** 247Incluye, en el archivo en uso, las configuraciones definidas en un archivo externo, tal como lo haria la opción ``--config-file``. Ejemplo: 248``` %!includeconf: miconfig.t2t 249 250: **%!style** 251Utiliza un archivo de estilo externo en el documento en uso, tal como lo haria la opción ``--style``. Puede utilizarse múltiples veces. Ejemplo: 252``` %!style: colores.css 253 254: **%!encoding** 255Define la codificación de caracteres que se utilizará en el documento convertido, tal como lo haria la opción ``--encoding``. Ejemplo : 256``` %!encoding: UTF-8 257 258: **%!preproc** 259Filtro 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: 260``` %!preproc: "JJS" "John J. Smith" 261 262: **%!postproc** 263Filtro 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: 264``` %!postproc(html): "<B>" "<STRONG>" 265: 266 267Si 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: ``~/.txt2tagsrc``, area de Ajustes del documento fuente, opción ``--config-file``. 268 269 270= COMANDOS =[commands] 271 272Los Comandos ejecutan tareas durante el proceso de conversión. Deben emplazarse en el cuerpo del documento fuente. 273 274: **%!csv: archivo.csv** 275Incorpora un archivo CSV como una tabla. 276 277: **%!include: archivo.t2t** 278Incorpora al documento un archivo txt2tags. 279 280: **%!include: ""``archivo.txt``""** 281Incorpora en el documento un archivo de texto (verbatim). 282 283: **%!include: ""''archivo.html''""** 284Incorpora al documento un archivo etiquetado. 285: 286 287= MACROS =[macros] 288 289Mediante 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 ``%%toc``, todos las macros pueden ser personalizadas con directivas especiales, tales como ``%Y`` y ``%f``. Para mas detalles, consultar la **Guia del Usuario de txt2tags**. 290 291: **""%%date""** 292Inserta la fecha actual. Su formato por defecto es: ``%%date(%Y%m%d)``, que nos mostrará la fecha como: AAAAMMDD. 293 294: **""%%infile""** 295Inserta la ruta del archivo fuente. Su formato por defecto es: ``%%infile(%f)``. Útil para enlaces del tipo: ``[Ver fuente %%infile]``. 296 297: **""%%mtime""** 298Inserta la fecha de modificación del archivo fuente. Su formato por defecto es: ``%%date(%Y%m%d)``, que nos mostrará la fecha como AAAAMMDD. 299 300: **""%%outfile""** 301Inserta la ruta del archivo final. Su formato por defecto es: ``%%outfile(%f)``. Útil en menciones del tipo: "Este es el archivo %%outfile". 302 303: **""%%toc""** 304Con 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 ``--toc``. 305: 306 307= EJEMPLOS =[examples] 308 309: ``txt2tags -t html archivo.t2t`` 310 311Convierte a HTML, guardando el resultado como archivo.html. 312 313: ``txt2tags -t html -o - archivo.t2t`` 314 315Convierte a HTML, mostrando el resultado en STDOUT. 316 317: ``txt2tags -t html --toc archivo.t2t`` 318 319Convierte a HTML, generando una Tabla de Contenidos (TOC) de forma automática. 320 321: ``txt2tags -t html --toc --toc-level 2 -n archivo.t2t`` 322 323Convierte a HTML, con una Tabla de Contenidos (TOC) a dos niveles y títulos numerados. 324 325: ``txt2tags --toc-only archivo.t2t`` 326 327Solo nos muestra la Tabla de Contenidos (TOC), sin realizar conversión alguna en el documento fuente. 328 329: ``txt2tags -t html --css-sugar --style base.css --style ui.css archivo.t2t`` 330 331Convierte 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). 332 333: ``txt2tags -t art --slides --width 80 --height 25 -o - archivo.t2t | more`` 334 335Crea una presentación de diapositivas tipo ASCII Art, apta para ser visionada en un terminal pantalla/ventana 80x25. 336 337: ``(echo ; echo "**bold**") | txt2tags -t html -H -`` 338 339Práctica forma de realizar comprobaciones rápidas usando STDIN. 340 341: ``txt2tags -t html -o - archivo.t2t | tidy > archivo.html`` 342 343Envia el resultado a STDOUT, desde donde se le redirige a un programa externo (tidy) antes de ser guardado. 344: 345 346= ARCHIVOS =[files] 347 348: ~/.txt2tagsrc 349Archivo de configuración del usuario, por defecto. 350: 351 352= ENTORNO =[environment] 353 354: T2TCONFIG 355Si no es nulo, define el pathname completo para el archivo de configuración del usuario por defecto. 356: 357 358= AUTOR =[author] 359 360Aurelio Jargas <verde@aurelio.net> 361 362Traducción al español realizada por 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