/doc/Spanish/manpage-es.html
http://txt2tags.googlecode.com/ · HTML · 472 lines · 458 code · 14 blank · 0 comment · 0 complexity · 5fccaaf7a7f48d8fa7f030f083006c99 MD5 · raw file
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
- <HTML>
- <HEAD>
- <STYLE>body{margin:3em;} pre{background:#ffc;}</STYLE>
- <META NAME="generator" CONTENT="http://txt2tags.org">
- <META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
- <TITLE>TXT2TAGS</TITLE>
- </HEAD><BODY BGCOLOR="white" TEXT="black">
- <CENTER>
- <H1>TXT2TAGS</H1>
- <FONT SIZE="4">Aug, 2010</FONT>
- </CENTER>
- <P></P>
- <HR NOSHADE SIZE=1>
- <P></P>
- <UL>
- <LI><A HREF="#name">NOMBRE</A>
- <LI><A HREF="#synopsis">SINOPSIS</A>
- <LI><A HREF="#description">DESCRIPCIÓN</A>
- <LI><A HREF="#markup">MARCADO</A>
- <LI><A HREF="#options">OPCIONES</A>
- <LI><A HREF="#source">ARCHIVO FUENTE</A>
- <LI><A HREF="#settings">AJUSTES</A>
- <LI><A HREF="#commands">COMANDOS</A>
- <LI><A HREF="#macros">MACROS</A>
- <LI><A HREF="#examples">EJEMPLOS</A>
- <LI><A HREF="#files">ARCHIVOS</A>
- <LI><A HREF="#environment">ENTORNO</A>
- <LI><A HREF="#author">AUTOR</A>
- <LI><A HREF="#bugs">BUGS</A>
- <LI><A HREF="#copyright">COPYRIGHT</A>
- </UL>
- <P></P>
- <HR NOSHADE SIZE=1>
- <P></P>
- <A NAME="name"></A>
- <H1>NOMBRE</H1>
- <P>
- txt2tags - Herramienta de formateo y conversión de texto.
- </P>
- <A NAME="synopsis"></A>
- <H1>SINOPSIS</H1>
- <P>
- <B>txt2tags</B> [<I>opciones</I>] [<I>ARCHIVO</I>...]
- </P>
- <A NAME="description"></A>
- <H1>DESCRIPCIÓN</H1>
- <P>
- <B>txt2tags</B> lee un archivo de texto que ha sido mínimamente marcado y lo convierte a los siguientes formatos:
- <I>ASCII Art</I>,
- <I>AsciiDoc</I>,
- <I>Creole</I>,
- <I>DocBook</I>,
- <I>DokuWiki</I>,
- <I>Google Code Wiki</I>,
- <I>HTML</I>,
- <I>LaTeX</I>,
- <I>Lout</I>,
- <I>MagicPoint</I>,
- <I>Man page</I>,
- <I>MoinMoin</I>,
- <I>PageMaker</I>,
- <I>Plain Text (Texto Plano)</I>,
- <I>PmWiki</I>,
- <I>SGML</I>,
- <I>Wikipedia</I> and
- <I>XHTML</I>.
- </P>
- <P>
- Esta 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.
- </P>
- <P>
- UNA única fuente, MÚLTIPLES formatos de salida - <A HREF="http://txt2tags.org">http://txt2tags.org</A>
- </P>
- <A NAME="markup"></A>
- <H1>MARCADO</H1>
- <PRE>
- Encabezado Las primeras tres líneas del archivo fuente.
- Título = texto =
- Título numerado + texto +
- Comentario % comentarios
- Línea de separación -----------------------...
- Línea gruesa =======================...
- Imagen [nombre.jpg]
- Enlace [etiqueta url]
-
- Negrita **texto**
- Cursiva //texto//
- Subrayado __texto__
- Tachado --texto--
- Monoespacio ``texto``
- Raw ""texto""
- Etiquetado ''texto''
-
- Párrafo texto
- Cita <TAB>texto
- Lista - texto
- Lista numerada + texto
- Lista de definición : texto
- Tabla | celda1 | celda2 | celda3...
-
- Línea verbatim ``` texto
- Línea Raw """ texto
- Línea Etiquetada ''' texto
-
- Bloque Verbatim ```
- líneas
- ```
- Bloque Raw """
- líneas
- """
- Bloque etiquetado '''
- líneas
- '''
- </PRE>
- <A NAME="options"></A>
- <H1>OPCIONES</H1>
- <DL>
- <DT><B>-C</B>, <B>--config-file</B>=<I>ARCHIVO</I></DT><DD>
- Lee 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>.
- <P></P>
- <DT> <B>--css-sugar</B></DT><DD>
- Mejora 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>.
- <P></P>
- <DT> <B>--css-inside</B></DT><DD>
- Inserta el contenido de un archivo CSS en el encabezado HTML/XHTML. Usar <CODE>--style</CODE> para especificar el archivo CSS que debe leerse.
- <P></P>
- <DT> <B>--dump-config</B></DT><DD>
- Muestra toda la configuración encontrada y sale.
- <P></P>
- <DT> <B>--dump-source</B></DT><DD>
- Muestra el documento fuente, con todas sus inclusiones (<CODE>%!include</CODE>) expandidas.
- <P></P>
- <DT> <B>--encoding</B>=<I>CÓDIGO</I></DT><DD>
- Establece 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.
- <P></P>
- <DT> <B>--gui</B></DT><DD>
- Llama la Interfaz Gráfica Tk.
- <P></P>
- <DT><B>-h</B>, <B>--help</B></DT><DD>
- Muestra la información de ayuda y sale.
- <P></P>
- <DT><B>-H</B>, <B>--no-headers</B></DT><DD>
- Elimina los encabezados y los piés de página del archivo de salida. Solo se mostrarán los contenidos (cuerpo del documento).
- <P></P>
- <DT> <B>--headers</B></DT><DD>
- Muestra los encabezados y piés de página del archivo de salida. Por defecto: ON.
- <P></P>
- <DT> <B>--height</B>=<I>NUM</I></DT><DD>
- Fija 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>.
- <P></P>
- <DT><B>-i</B>, <B>--infile</B>=<I>ARCHIVO</I></DT><DD>
- Toma <I>ARCHIVO</I> como archivo fuente. Usar '-' para leer la fuente desde STDIN.
- <P></P>
- <DT> <B>--mask-email</B></DT><DD>
- Oculta los emails a los robots de spam. Elimina @ y puntos. La dirección foo@bar.com se convierte en <foo (a) bar com>.
- <P></P>
- <DT><B>-n</B>, <B>--enum-title</B></DT><DD>
- Activa la numeración automática de los títulos. Está prefijada en: 1, 1.1, 1.1.1, ...
- <P></P>
- <DT> <B>--no-dump-config</B></DT><DD>
- Cancela la acción <CODE>--dump-config</CODE>.
- <P></P>
- <DT> <B>--no-dump-source</B></DT><DD>
- Cancela la acción <CODE>--dump-source</CODE>.
- <P></P>
- <DT> <B>--no-encoding</B></DT><DD>
- Elimina la configuración de caracteres.
- <P></P>
- <DT> <B>--no-enum-title</B></DT><DD>
- Desactiva la numeración automática de los títulos.
- <P></P>
- <DT> <B>--no-infile</B></DT><DD>
- Elimina toda anterior declaración <CODE>--infile</CODE>.
- <P></P>
- <DT> <B>--no-targets</B></DT><DD>
- Elimina la acción <CODE>--targets</CODE>.
- <P></P>
- <DT> <B>--no-mask-email</B></DT><DD>
- Desactiva la ocultación de emails.
- <P></P>
- <DT> <B>--no-outfile</B></DT><DD>
- Elimina toda anterior declaración <CODE>--outfile</CODE>.
- <P></P>
- <DT> <B>--no-quiet</B></DT><DD>
- Muestra los mensajes, desactiva la opción <CODE>--quiet</CODE>.
- <P></P>
- <DT> <B>--no-rc</B></DT><DD>
- No leer en el archivo de configuración del usuario ~/.txt2tagsrc.
- <P></P>
- <DT> <B>--no-slides</B></DT><DD>
- Desactiva <CODE>--slides</CODE>.
- <P></P>
- <DT> <B>--no-style</B></DT><DD>
- Elimina todos los ajustes de estilo.
- <P></P>
- <DT> <B>--no-toc</B></DT><DD>
- Elimina la Tabla de Contenidos (TOC) en el archivo de salida.
- <P></P>
- <DT> <B>--no-toc-only</B></DT><DD>
- Desactiva la acción <CODE>--toc-only</CODE>.
- <P></P>
- <DT><B>-o</B>, <B>--outfile</B>=<I>ARCHIVO</I> </DT><DD>
- Toma <I>ARCHIVO</I> como nombre del archivo de salida. Usar '-' para dirigir los resultados a STDOUT.
- <P></P>
- <DT><B>-q</B>, <B>--quiet</B></DT><DD>
- Modo silencioso. Suprime todos los mensajes del sistema, excepto los de error.
- <P></P>
- <DT> <B>--rc</B></DT><DD>
- Lee el archivo de configuración (ajustes) del usuario ~/.txt2tagsrc. Por defecto: ON.
- <P></P>
- <DT> <B>--slides</B></DT><DD>
- Formatea el archivo de salida como una presentación de diapositivas. Esta opción se usa solo en formatos de salida ASCII Art.
- <P></P>
- <DT> <B>--style</B>=<I>ARCHIVO</I></DT><DD>
- Usa <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.
- <P></P>
- <DT><B>-t</B>, <B>--target</B>=<I>TIPO</I></DT><DD>
- Fija 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.
- <P></P>
- <DT> <B>--targets</B></DT><DD>
- Muestra los formatos disponibles para los archivos de salida y sale.
- <P></P>
- <DT> <B>--toc</B></DT><DD>
- Incluye, 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>.
- <P></P>
- <DT> <B>--toc-level</B>=<I>NUM</I></DT><DD>
- Fija 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.
- <P></P>
- <DT> <B>--toc-only</B></DT><DD>
- Muestra la Tabla de Contenidos (TOC) y sale.
- <P></P>
- <DT><B>-v</B>, <B>--verbose</B></DT><DD>
- Muestra 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.
- <P></P>
- <DT><B>-V</B>, <B>--version</B></DT><DD>
- Muestra la versión del programa y sale.
- <P></P>
- <DT> <B>--width</B>=<I>NUM</I></DT><DD>
- Fija 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.
- </DL>
- <A NAME="source"></A>
- <H1>ARCHIVO FUENTE</H1>
- <P>
- Los 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:
- </P>
- <DL>
- <DT><B>Encabezado</B> (opcional)</DT><DD>
- Las 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.
- <P></P>
- <DT><B>Ajustes</B> (opcional)</DT><DD>
- Comienzan 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..
- Usados para para implementar ajustes (configuraciones) en formato <CODE>%!keyword:value</CODE>.
- <P></P>
- <DT><B>Cuerpo del Documento</B></DT><DD>
- Comienza 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.
- </DL>
- <A NAME="settings"></A>
- <H1>AJUSTES</H1>
- <P>
- Los 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>.
- </P>
- <DL>
- <DT><B>%!target</B></DT><DD>
- Define el formato del archivo de salida, tal como lo haria la opción <CODE>--target</CODE>. Ejemplo:
- <PRE>
- %!target: html
- </PRE>
- <P></P>
- <DT><B>%!options(tipo)</B></DT><DD>
- Define 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:
- <PRE>
- %!options(html): --toc --toc-level 3 --css-sugar
- </PRE>
- <P></P>
- <DT><B>%!includeconf</B></DT><DD>
- Incluye, en el archivo en uso, las configuraciones definidas en un archivo externo, tal como lo haria la opción <CODE>--config-file</CODE>. Ejemplo:
- <PRE>
- %!includeconf: miconfig.t2t
- </PRE>
- <P></P>
- <DT><B>%!style</B></DT><DD>
- Utiliza 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:
- <PRE>
- %!style: colores.css
- </PRE>
- <P></P>
- <DT><B>%!encoding</B></DT><DD>
- Define la codificación de caracteres que se utilizará en el documento convertido, tal como lo haria la opción <CODE>--encoding</CODE>. Ejemplo :
- <PRE>
- %!encoding: UTF-8
- </PRE>
- <P></P>
- <DT><B>%!preproc</B></DT><DD>
- Filtro 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:
- <PRE>
- %!preproc: "JJS" "John J. Smith"
- </PRE>
- <P></P>
- <DT><B>%!postproc</B></DT><DD>
- Filtro 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:
- <PRE>
- %!postproc(html): "<B>" "<STRONG>"
- </PRE>
- </DL>
- <P>
- Si 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>.
- </P>
- <A NAME="commands"></A>
- <H1>COMANDOS</H1>
- <P>
- Los Comandos ejecutan tareas durante el proceso de conversión. Deben emplazarse en el cuerpo del documento fuente.
- </P>
- <DL>
- <DT><B>%!csv: archivo.csv</B></DT><DD>
- Incorpora un archivo CSV como una tabla.
- <P></P>
- <DT><B>%!include: archivo.t2t</B></DT><DD>
- Incorpora al documento un archivo txt2tags.
- <P></P>
- <DT><B>%!include: ``archivo.txt``</B></DT><DD>
- Incorpora en el documento un archivo de texto (verbatim).
- <P></P>
- <DT><B>%!include: ''archivo.html''</B></DT><DD>
- Incorpora al documento un archivo etiquetado.
- </DL>
- <A NAME="macros"></A>
- <H1>MACROS</H1>
- <P>
- Mediante 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>.
- </P>
- <DL>
- <DT><B>%%date</B></DT><DD>
- Inserta la fecha actual. Su formato por defecto es: <CODE>%%date(%Y%m%d)</CODE>, que nos mostrará la fecha como: AAAAMMDD.
- <P></P>
- <DT><B>%%infile</B></DT><DD>
- Inserta la ruta del archivo fuente. Su formato por defecto es: <CODE>%%infile(%f)</CODE>. Útil para enlaces del tipo: <CODE>[Ver fuente %%infile]</CODE>.
- <P></P>
- <DT><B>%%mtime</B></DT><DD>
- Inserta 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.
- <P></P>
- <DT><B>%%outfile</B></DT><DD>
- Inserta 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".
- <P></P>
- <DT><B>%%toc</B></DT><DD>
- Con 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>.
- </DL>
- <A NAME="examples"></A>
- <H1>EJEMPLOS</H1>
- <DL>
- <DT><CODE>txt2tags -t html archivo.t2t</CODE></DT><DD>
- <P></P>
- Convierte a HTML, guardando el resultado como archivo.html.
- <P></P>
- <DT><CODE>txt2tags -t html -o - archivo.t2t</CODE></DT><DD>
- <P></P>
- Convierte a HTML, mostrando el resultado en STDOUT.
- <P></P>
- <DT><CODE>txt2tags -t html --toc archivo.t2t</CODE></DT><DD>
- <P></P>
- Convierte a HTML, generando una Tabla de Contenidos (TOC) de forma automática.
- <P></P>
- <DT><CODE>txt2tags -t html --toc --toc-level 2 -n archivo.t2t</CODE></DT><DD>
- <P></P>
- Convierte a HTML, con una Tabla de Contenidos (TOC) a dos niveles y títulos numerados.
- <P></P>
- <DT><CODE>txt2tags --toc-only archivo.t2t</CODE></DT><DD>
- <P></P>
- Solo nos muestra la Tabla de Contenidos (TOC), sin realizar conversión alguna en el documento fuente.
- <P></P>
- <DT><CODE>txt2tags -t html --css-sugar --style base.css --style ui.css archivo.t2t</CODE></DT><DD>
- <P></P>
- Convierte 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).
- <P></P>
- <DT><CODE>txt2tags -t art --slides --width 80 --height 25 -o - archivo.t2t | more</CODE></DT><DD>
- <P></P>
- Crea una presentación de diapositivas tipo ASCII Art, apta para ser visionada en un terminal pantalla/ventana 80x25.
- <P></P>
- <DT><CODE>(echo ; echo "**bold**") | txt2tags -t html -H -</CODE></DT><DD>
- <P></P>
- Práctica forma de realizar comprobaciones rápidas usando STDIN.
- <P></P>
- <DT><CODE>txt2tags -t html -o - archivo.t2t | tidy > archivo.html</CODE></DT><DD>
- <P></P>
- Envia el resultado a STDOUT, desde donde se le redirige a un programa externo (tidy) antes de ser guardado.
- </DL>
- <A NAME="files"></A>
- <H1>ARCHIVOS</H1>
- <DL>
- <DT>~/.txt2tagsrc</DT><DD>
- Archivo de configuración del usuario, por defecto.
- </DL>
- <A NAME="environment"></A>
- <H1>ENTORNO</H1>
- <DL>
- <DT>T2TCONFIG</DT><DD>
- Si no es nulo, define el pathname completo para el archivo de configuración del usuario por defecto.
- </DL>
- <A NAME="author"></A>
- <H1>AUTOR</H1>
- <P>
- Aurelio Jargas <<verde (a) aurelio net>>
- </P>
- <P>
- Traducción al español realizada por Antoni Serra Devecchi <<antoni serra (a) gmail com>>
- </P>
- <A NAME="bugs"></A>
- <H1>BUGS</H1>
- <P>
- <A HREF="http://bugs.txt2tags.org">http://bugs.txt2tags.org</A>
- </P>
- <A NAME="copyright"></A>
- <H1>COPYRIGHT</H1>
- <P>
- Copyright (C) 2001-2010 Aurelio Jargas, GNU GPL v2
- </P>
- <!-- html code generated by txt2tags 2.6 (http://txt2tags.org) -->
- <!-- cmdline: txt2tags -t html doc/Spanish/manpage-es.t2t -->
- </BODY></HTML>