PageRenderTime 42ms CodeModel.GetById 19ms RepoModel.GetById 1ms app.codeStats 0ms

/doc/Spanish/userguide-es/userguide-es.t2t

http://txt2tags.googlecode.com/
Unknown | 1927 lines | 1271 code | 656 blank | 0 comment | 0 complexity | 873c13a688e736773604a60bc5c4c5c7 MD5 | raw file
Possible License(s): GPL-2.0, GPL-3.0, WTFPL

Large files files are truncated, but you can click here to view the full file

  1. Txt2tags: Guia del Usuario de Txt2tags
  2. Aurelio, %%mtime(%c)
  3. Traducción al espańol: Antoni Serra Devecchi
  4. %!target: html
  5. %!options: --toc --toc-level 2 --css-sugar
  6. %%!options: -o ../../../web/userguide/userguide.html
  7. % TRANSLATOR:
  8. % - Don't worry about the PDF cover page
  9. % - Don't worry about PDF at all, translate and check on HTML
  10. % - Don't worry about the images
  11. % TRANSLATOR uncomment the next line
  12. %%!options: -o userguide.html
  13. % TRANSLATOR uncomment the next line to use images on the same folder
  14. %!preproc: IMGPATH .
  15. % TRANSLATOR:
  16. % You can take new screenshots and make new images for the program
  17. % interface and "first conversion" section. Remember to send them
  18. % to the author!
  19. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  20. %%% activate those lines when converting to HTML for PDF generation
  21. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  22. %%% htmldoc does TOC
  23. %!options(html): --no-toc --no-css-sugar -o userguide-pdf.html
  24. %%% mask the 'nopdf' marks so they will not be removed
  25. %!preproc(html): ^%nopdf %yespdf
  26. %%% removing first header, htmldoc ignores all until next <H1> (cool!)
  27. %!postproc(html): '<H1>Txt2tags: .*</H1>' ''
  28. %%% imagens are in the same dir
  29. %!preproc: IMGPATH .
  30. %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  31. % easy way to change all image locations once, when changing file location
  32. %!preproc: IMGPATH ../img
  33. % normalizing common text
  34. %%!preproc: CONFAREA Config Area
  35. %%!preproc: HEADAREA Header Area
  36. %%!preproc: BODYAREA Body Area
  37. %%!preproc: MARKPROP **Properties:**
  38. %%!preproc: MARKCONT **Contains:**
  39. %%!preproc: MARKDESC **Description:**
  40. %%!preproc: MARKSYN **Syntax:**
  41. %%!preproc: MARKDET **Details:**
  42. %%!preproc: NOMARKS Marks are NOT interpreted
  43. %%!preproc: NOMACRO Macros are NOT interpreted
  44. %!preproc: URLMARKUP http://txt2tags.org/markup.html
  45. % activate the areas disabled on the PDF version
  46. %!preproc(html): ^%nopdf ''
  47. % remove separator lines and strong lines
  48. %!preproc(html): '^ *--------*' ''
  49. %!preproc(html): '^ *========*' ''
  50. % highlight NEW topic on TOC
  51. %%!postproc(html): '(<LI>.*Mastering Macros</A>)$' '\1 <b>[NEW!]</b>'
  52. %%% Little clean up for less large tables
  53. %!postproc: /pessoal/sourceforge.net ''
  54. % border for all images
  55. %!postproc: '(<IMG [^>]*BORDER)="0"' '\1="1"'
  56. %%% Embedded CSS code (ugly not?)
  57. %
  58. %!postproc(html): ^<HEAD>$ '<HEAD>\n<STYLE TYPE="text/css">\n@#@'
  59. %!postproc(html): (@#@)$ 'body {background-color:#ddeeff; color:black; \n\1'
  60. %!postproc(html): (@#@)$ ' margin:3em; text-align:justify;} \n\1'
  61. %!postproc(html): (@#@)$ '#header {text-align:center;} \n\1'
  62. %!postproc(html): (@#@)$ '.toc {border:1px solid black;padding:9px;\n\1'
  63. %!postproc(html): (@#@)$ ' background-color:white;} \n\1'
  64. %!postproc(html): (@#@)$ '.toc li{list-style-type: none;} \n\1'
  65. %!postproc(html): (@#@)$ 'a {text-decoration:none;}\na:hover {color:red;}\n\1'
  66. %!postproc(html): (@#@)$ 'a:visited {color:purple;}\ndl {margin:1em;} \n\1'
  67. %!postproc(html): (@#@)$ '#body h1 {text-align:center; color:white; \n\1'
  68. %!postproc(html): (@#@)$ ' background-color:blue; padding:8px;} \n\1'
  69. %!postproc(html): (@#@)$ 'h2 {padding-top:20px;}\nhr {border-style:none;}\n\1'
  70. %!postproc(html): (@#@)$ 'code {background-color:lightblue;} \n\1'
  71. %!postproc(html): (@#@)$ 'blockquote {border:1px solid black;padding:9px;\n\1'
  72. %!postproc(html): (@#@)$ ' background-color:white;} \n\1'
  73. %!postproc(html): (@#@)$ 'table {border-style:solid; border-color:black;}\n\1'
  74. %!postproc(html): (@#@)$ 'th {background-color:lightblue; padding:.5em;} \n\1'
  75. %!postproc(html): (@#@)$ 'td {border-style:none; background-color:white;}\n\1'
  76. %!postproc(html): (@#@)$ 'pre {border-style:solid; border-width:1px 1px; \n\1'
  77. %!postproc(html): (@#@)$ ' background-color:lightblue; padding:8px; \n\1'
  78. %!postproc(html): (@#@)$ ' border-color:black;} \n\1'
  79. %!postproc(html): @#@$ </STYLE>
  80. % 26/Nov/2003: revised by anamimts
  81. % 26/Jun/2004: updated to v2, new embedded CSS
  82. % 17/Jul/2004: revised by anamimts
  83. % 01/Nov/2004: updated to v2.0 and 2.1, new chapters, PDF version
  84. % TODO Mastering Options [option-help], [option-css-sugar], ...
  85. ========================================================================
  86. %nopdf "ĄHola! Čsto es la Guia del Usuario de Txt2tags. Aquí podrás encontrar
  87. %nopdf toda la información disponible sobre la herramienta de conversión de textos txt2tags.
  88. %nopdf Puedes encontrar la última versión en http://txt2tags.org/userguide/.
  89. %nopdf Para más información, visita la
  90. %nopdf [web de txt2tags http://txt2tags.org]. ĄQue disfrutes!"
  91. %nopdf
  92. %%nopdf [Download PDF version http://txt2tags.org/userguide/userguide.pdf]
  93. ========================================================================
  94. %nopdf%**This Guide Contains:**
  95. %%toc
  96. ========================================================================
  97. = Parte I - Introducción a Txt2tags =[intro]
  98. == Tus Primeras Preguntas ==[1st-questions]
  99. Este capítulo presenta txt2tags, introduciendo a las funcionalidades y objetivos del programa.
  100. ------------------------------------------------------------------------
  101. === żQue és Txt2tags? ===
  102. Txt2tags es una herramienta de formateo y conversión de texto.
  103. Txt2tags convierte un archivo de texto con algunas marcas a uno de los siguientes tipos de archivo:
  104. - Documento HTML
  105. - Documento XHTML
  106. - Documento SGML
  107. - Documento LaTeX
  108. - Página man de UNIX
  109. - Presentación Magic Point
  110. - Página MoinMoin
  111. - Documento PageMaker 6.0
  112. - Texto plano (sin marcas)
  113. ------------------------------------------------------------------------
  114. === żPor Qué Debo Usar Txt2tags? ===
  115. Encontarás txt2tags muy útil si:
  116. - precisas publicar documentos en diferentes formatos
  117. - precisas mantener documentos actualizados en diferentes formatos
  118. - escribes manuales o documentos técnicos
  119. - no sabes como escribir un documento en un formato específico
  120. - no posees un editor específico para cierto formato
  121. - quieres usar un editor de texto simple para actualizar tus documentos
  122. Pero la motivación principal es:
  123. - economizar tiempo,escribiendo **contenido** sin preocuparse del **formato**
  124. ------------------------------------------------------------------------
  125. === żQué ventajas ofrece, comparado con otras herramientas? ===
  126. Txt2tags se encuentra en constante crecimiento, siguiendo una serie de conceptos basicos:
  127. | //Archivo fuente legible// | Las marcas de txt2tags son muy simples, casi naturales
  128. | //Documento destino legible// | Como el archivo fuente, el código del documento generado es también legible
  129. | //Consistencia en las marcas// | Las marcas txt2tags son únicas, atendiendo todos los tipos de documentos, sin ser confundidas con el contenido
  130. | //Reglas consistentes// | De la misma manera que las marcas, las reglas a ellas aplicadas son uniformes, sin excepciones ni casos especiales..
  131. | //Estructuras simples// | Todas las estructuras soportadas son simples, sin opciones extras o modificadores complejos del comportamiento. Una marca es solo una marca, sin opciones adicionales.
  132. | //Facil de apreder// | Con marcas simples y código fuente legible, presenta una curva de aprendizaje muy amigable.
  133. | //Buenos ejemplos// | Los **archivos de ejemplos** incluidos en el paquete están basados en documentos reales, son simples, bién estructurados y están escritos en formato txt2tags.
  134. | //Herramientas valiosas// | Los **archivos de sintaxis**, incluidos en el paquete ( para los editores Vim, Emacs, Nano y Kate) ayudan a escribir documentos sin errores sintácticos.
  135. | //Tres interfaces de usuario// | Tiene una **interfaz Gráfica Tk**, una **interfaz Web**, que permite usar el programa remotamente o através de una intranet, y una **interfaz en línea de comandos** para usuarios avanzados y scripts.
  136. | //Soporta scripts// | Con el modo completo de línea de comandos, un usuario avanzado puede automatizar tareas y efectuar post-ediciones en los archivos convertidos.
  137. | //Descargar y Ejecutar / Multiplataforma// | txt2tags es un **script Python**. No hay necesidad de compilarlo o cargar módulos extra.Puede ser ejecutado sin problemas en máquinas UNIX, Linux,Windows y Macintosh .
  138. | //Actualizaciones Frecuentes// | El programa posee una lísta de discusión con usuarios activos que suguieren correcciones y mejoras. El propio autor es un usuario "intensivo" en casa y en su trabajo, por lo que es difícil que el desarrollo pare.
  139. ------------------------------------------------------------------------
  140. === ż Cuanto cuesta ? ===
  141. || ĄABSOLUTAMENTE NADA! |
  142. Txt2tags es un programa gratuito,GLP,open source,dominio público,etc...
  143. %//<put-your-favorite-buzzword-here>//.
  144. Puedes copiarlo,usarlo,modificarlo,venderlo.. etc. Las polítcas de software y copyright no se encuentran entre las mayores preocupaciones del autor.
  145. ------------------------------------------------------------------------
  146. == Estructuras de Formato Soportadas por txt2tags ==[structures]
  147. - Encabezamiento (Cabeceras) ( título del documento, nombre de autor,fecha)
  148. - Títulos de secciones (numeradas o no)
  149. - Parráfos
  150. - Modificadores de fuentes
  151. - Negrita (bold)
  152. - Itálica
  153. - Subrayada
  154. - Fuente no proporcional (Monoespaciada/Verbatim)
  155. - Monoespaciada en un párafo
  156. - Línea monoespaciada
  157. - Zona en monoespaciado (multilínea)
  158. - Cítas
  159. - Enlaces
  160. - URL/ enlaces internet
  161. - enlaces e-mail
  162. - enlaces locales
  163. - enlaces nombrados
  164. - Listas
  165. - listas marcadas
  166. - listas numeradas
  167. - listas de definicion
  168. - Líneas de separación horizontal
  169. - Imágenes (con un alineamiento adecuado)
  170. - Tablas (con o sin borde,con alineamiento , con expansión de columna)
  171. - Marcas especiales para texto raw ( que no debe ser tratado)
  172. - Macro especial para la fecha actual (con formato flexible)
  173. - Comentarios (para notas,TODO,FIXME,etc)
  174. ------------------------------------------------------------------------
  175. == Formatos de salida soportados ==[targets]
  176. : **HTML**
  177. Todos sabemos lo que es HTML.
  178. Txt2tag genera documentos HTML límpios, con una buena presentación y cuyo código fuente es legible. No utiliza javascript, frames u otras técnicas fútiles,frecuentemente innecesarias en el formateo de documentos técnicos. Pero, si se desea, puede utilizarse un archivo CSS externo.
  179. Txt2tag genera código "//HTML 4.0 Transitional//".
  180. Desde la versión 2.0 de txt2tags el código HTML generado es aprobado al 100%
  181. por el [ validador w3c http://validator.w3.org/].
  182. : **XHTML**
  183. Es la nueva generación de HTML con reglas mas estrictas, como la de tener que cerrar todas las marcas que se abran. De esta manera se consigue un código más fácil de tratar y de entender. Para propósitos generales, se puede considerar como HTML.
  184. Txt2tag genera código "XHTML 1.0 Transitional".
  185. Desde la versión 2.0 de txt2tags el código XHTML generado es aprobado al 100%
  186. por el [ validador w3c http://validator.w3.org/].
  187. : **SGML**
  188. Es un formato de documento común que posee aplicaciones de conversiňn, como
  189. [sgmltools http://www.sgmltools.org]. A partir de un archivo SGML se pueden generar documentos html, pdf, info, latex, lynx, rtf y xml. Las herramientas como sgml2* también crean índices (TOC) automaticamente, dividiéndolos en secciones y subpáginas (sgml2html)
  190. Txt2tag genera archivos SGML válidos para DTD linuxdoc, listos para ser convertidos mediante una herramienta sgml2* sin archivo de catŕlogo extra u otras incomodas exigencias de SGML.
  191. : **LATEX**
  192. Es uno de los formatos de documento preferido en los medios académicos y es un formato más potente de lo que uno, de entrada, se imagina. Libros completos,fórmulas complicadas o cualquier texto complejo puede ser escrito en LaTeX. Pero si intentas escribir a mano las marcas requeridas, prepárate para la desesperación.
  193. Txt2tag genera archivos LaTeX listos para usar,realizando todo el complejo trabajo que requiere este formateo, con todas las excepciones. El escritor debe preocuparse sólo por el contenido.
  194. : **LOUT**
  195. Muy parecido a LaTeX, pero con una sintaxis mas fácil, utilizando "@" en lugar de "\" . Su proximidad a la idea de que "todo-es-objeto" da lugar a un marcado mas "sano".
  196. Txt2tag genera archivos Lout listos para su uso, que pueden ser convertidos a PS o PDF utilizando la orden "lout".
  197. : **MAN**
  198. Las páginas man de UNIX resisten el paso del tiempo. Los formatos de documentos vienen y van, pero ellas siguen aquí, inamovibles.
  199. Hay otras herramientas para generar páginas man, pero txt2tag tiene una ventaja: una fuente, múltiples formatos de destino. Así, el contenido de una misma página man puede ser convertido en una página HTML, una presentacion Magic Point, etc.
  200. : **MGP (Magic Point)**
  201. [Magic Point http://www.mew.org/mgp] es una herramienta de presentación bastante útil (tipo: Microsoft PowerPoint), que utiliza un lenguaje de marcado para definir todas las teclas. De esta forma puedes crear presentaciones complejas con vi/emacs/notepad.
  202. Txt2tag genera un archivo .mgp lísto para ser utilizado, definiendo todos los encabezamientos necesarios para las definiciones de fuentes y apariencia, así como el soporte a los carácteres acentuados (código ISO-8859).
  203. **Observación 1 :** los archivos .mgp creados por txt2tag usan las fuentes Type1 de Xfree86. De esta forma no es necesario incluir fuentes TrueType a su presentación.
  204. **Observación 2 ::** las definiciones de colores para las fuentes son límpias de forma que, incluso con una paleta de colores de sistema pobre, (cómo ``startx -- -bpp 8``),la presentación va a tener una buena apariencia.
  205. La clave es : Convierte y Usa. Sin necesidad de posteriores u otros requisitos.
  206. : **MOIN**
  207. ż No sabes lo que és [MoinMoin http://moin.sourceforge.net]?
  208. ĄEs un [WikiWiki http://www.c2.com/cgi/wiki]!
  209. La sintaxis de Moin es un poco liada: tienes que escribir cosas cómo
  210. ``{{{'''''adding braces and quotes'''''}}}``.Pero txt2tag viene con marcadores simplificados y una solución unificada: una fuente, múltiples formatos destino.
  211. : **PM6**
  212. żSabías que Adobe PageMaker 6.0 tiene su propio lenguaje de marcado?. Estilos, tablas de colores, modificadores de fuente y la mayor parte de las funcionalidades accesibles via 'clic' de ratón, también están disponibles en su lenguaje de marcado. Sólo tienes que acceder al menú "Import tagget text", aunque sea sólo por curiosidad, y podrás ver que es un lenguaje de marcas semejante al HTML.
  213. Txt2tag genera todas las marcas y define un encabezamiento extenso y funcional, configurando los estilos de párrafo y formatos.
  214. **ĄAtención!:** Sin saltos de linea. Cada párrafo debe ser una sola linea.
  215. Nota del Autor:
  216. //Todo mi libro sobre [expresiones regulares http://guia-er.sf.net]//
  217. //fue escrito con Vi, convertido al formato PageMaker con txt2tag//
  218. //y enviado a la imprenta.//
  219. : **TXT**
  220. TXT es texto. El único tipo de formato verdadero.
  221. A pesar que las marcas de txt2tag son intuitivas y discretas, puedes eliminarlas convirtiendo el archivo al formato TXT puro.
  222. Los títulos estaran subrayados y el texto es, basicamente, conservado cómo estaba en el archivo fuente.
  223. ------------------------------------------------------------------------
  224. == Estructuras Soportadas en los Archivos finales ==[struct-support]
  225. || Estructura | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
  226. | cabeceras | S | S | S | S | S | S | S | N | N | S |
  227. | sección título | S | S | S | S | S | S | S | S | S | S |
  228. | párrafos | S | S | S | S | S | S | S | S | S | S |
  229. | negrita | S | S | S | S | S | S | S | S | S | - |
  230. | itálica | S | S | S | S | S | S | S | S | S | - |
  231. | subrayado | S | S | - | S | S | - | S | S | S | - |
  232. | f.monoespacio | S | S | S | S | S | - | S | S | S | - |
  233. | línea verbatim | S | S | S | S | S | S | S | S | S | - |
  234. | área verbatim | S | S | S | S | S | S | S | S | S | - |
  235. | área de cita | S | S | S | S | S | S | S | S | S | S |
  236. | links internet | S | S | S | - | - | - | - | S | - | - |
  237. | links e-mail | S | S | S | - | - | - | - | S | - | - |
  238. | links locales | S | S | S | N | N | - | - | S | - | - |
  239. | links nombrados | S | S | S | - | - | - | - | S | - | - |
  240. | listas marcadas | S | S | S | S | S | S | S | S | S | S |
  241. | listas numeradas | S | S | S | S | S | S | S | S | S | S |
  242. | listas definición | S | S | S | S | S | S | N | N | N | S |
  243. | línea horizontal | S | S | - | S | S | - | S | S | N | S |
  244. | imágen | S | S | S | S | S | - | S | S | N | - |
  245. | tabla | S | S | S | S | N | S | N | S | N | N |
  246. || Extras | html | xhtml | sgml | tex | lout | man | mgp | moin | pm6 | txt |
  247. | alineación imágen | S | S | N | N | Y | - | S | N | N | - |
  248. | alin celdas tb | S | S | S | S | N | Y | N | S | N | N |
  249. | span columna tb | S | S | N | N | N | N | N | N | N | N |
  250. || | Significados
  251. | **S** | //Soportado//
  252. | **N** | //No soportado (tal vez en futuras versiones....)//
  253. | **-** | //No soportado (no es posible en este tipo de archivo final)//
  254. % | **?** | //not supported (not sure if it can be done or not)//
  255. ------------------------------------------------------------------------
  256. == Las tres interfaces de usuario: GUI, Web y Línea de Comandos ==[interfaces]
  257. Considerando que distintos usuarios pueden tener distintas necesidades y/o disponer de entornos diversos, txt2tags flexibiliza su forma de utilización, presentándose en tres posibles interfaces de usuario, cada una de ellas con sus propias peculiaridades y funcionalidades.
  258. - **Gui**: Escrita en Tk. Aporta a txt2tags un entorno de ventanas y la facilidad del "clic" de ratón.
  259. - **Web**: Escrita en PHP, permite operar remotamente con txt2tags, mediante un navegador, sin necesidad de instalación local
  260. - **Línea de Comandos**: Escrita en Phyton, es el núcleo del programa. Todas las funcionalidades y opciones del programa son accesibles desde la Línea de Comandos.
  261. ------------------------------------------------------------------------
  262. === Interfaz Gráfica Tk ===[gui]
  263. Desde su versión 1.0, txt2tags dispone de una interfaz gráfica que funciona en Linux, Mac, Windows y otros sistemas operativos.
  264. Al invocar txt2tags (desde la línea de comandos), el programa detecta automaticamente si el sistema soporta la interfaz gráfica y, en caso afirmativo, la lanza sin necesidad de órdenes adicionales. Se puede forzar el lanzamiento de la interfaz gráfica mediante la opción --gui. Si se detectara la falta de algún componente para el funcionamiento de la interfaz gráfica, el programa nos lo advertirá.
  265. **Nota:** Se necesita el módulo Tkinter. Forma parte de la distribución estandar de Python. De tener instalado éste,deberia disponerse del citado módulo.
  266. La interfaz es simple e intuitiva:
  267. [IMGPATH/gui.png]
  268. + Localizar el archivo fuente .t2t en el disco.
  269. + Elegir un tipo de documento de salida.
  270. + A continuación podran elegirse una serie de opciones, aunque ninguna de ellas es imprescindible.
  271. + Finalmente, activando "Convert!", se realiza la conversión del documento.
  272. Una de las opciones cuya activación puede ser útil es "//Dump to screen//", (Visualización en pantalla), que nos permite ver el código generado en una ventana distinta a la de trabajo sin que, por el momento, se guarde ningún archivo. Si el código se considera correcto, desactivamos la opción y la conversión se realizará normalmente.
  273. Los colores que vienen por defecto pueden cambiarse en el archivo ``~/.txt2tagsrc``
  274. usando los ajustes ``%!guicolors`` Por ejemplo:
  275. ```
  276. % set my own colors for the graphical interface (bg1, fg1, bg2, fg2)
  277. %!guicolors: blue white brown yellow
  278. ```
  279. ------------------------------------------------------------------------
  280. === Interfaz Web ===
  281. La interfaz web se encuentra disponible en: http://txt2tags.org/online.php . Allí puedes usar y probar el programa sin necesidad de instalarlo localmente.
  282. [IMGPATH/web.png]
  283. También puede instalarse esta interfaz en la intranet local, evitando así tener que proceder a la instalación de txt2tags en cada una de las computadoras.
  284. ------------------------------------------------------------------------
  285. === Interfaz de Línea de Comandos (Cónsola) ===[cmdline]
  286. A los usuarios de esta interfaz, la opción --help les debe proporcionar salida en pantalla parecida a čsta:
  287. ```
  288. Usage: txt2tags [OPTIONS] [infile.t2t ...]
  289. -t, --target set target document type. currently supported:
  290. html, xhtml, sgml, tex, lout, man, mgp, moin, pm6, txt
  291. -i, --infile=FILE set FILE as the input file name ('-' for STDIN)
  292. -o, --outfile=FILE set FILE as the output file name ('-' for STDOUT)
  293. -n, --enum-title enumerate all title lines as 1, 1.1, 1.1.1, etc
  294. -H, --no-headers suppress header, title and footer contents
  295. --headers show header, title and footer contents (default ON)
  296. --encoding set target file encoding (utf-8, iso-8859-1, etc)
  297. --style=FILE use FILE as the document style (like HTML CSS)
  298. --css-sugar insert CSS-friendly tags for HTML and XHTML targets
  299. --css-inside insert CSS file contents inside HTML/XHTML headers
  300. --mask-email hide email from spam robots. x@y.z turns <x (a) y z>
  301. --toc add TOC (Table of Contents) to target document
  302. --toc-only print document TOC and exit
  303. --toc-level=N set maximum TOC level (depth) to N
  304. --rc read user config file ~/.txt2tagsrc (default ON)
  305. --gui invoke Graphical Tk Interface
  306. -q, --quiet quiet mode, suppress all output (except errors)
  307. -v, --verbose print informative messages during conversion
  308. -h, --help print this help information and exit
  309. -V, --version print program version and exit
  310. --dump-config print all the config found and exit
  311. Turn OFF options:
  312. --no-outfile, --no-infile, --no-style, --no-encoding, --no-headers
  313. --no-toc, --no-toc-only, --no-mask-email, --no-enum-title, --no-rc
  314. --no-css-sugar, --no-css-inside, --no-quiet
  315. Example:
  316. txt2tags -t html --toc myfile.t2t
  317. By default, converted output is saved to 'infile.<target>'.
  318. Use --outfile to force an output file name.
  319. If input file is '-', reads from STDIN.
  320. If output file is '-', dumps output to STDOUT.
  321. ```
  322. ==== Ejemplos: ====
  323. Suponiendo que se haya creado un archivo marcado,denominado ``file.t2t``, veamos varias opciones de conversión:
  324. | **Convertir a HTML** | ``$ txt2tags -t html file.t2t``
  325. | **Usando redireccionamiento** | ``$ txt2tags -t html -o - file.t2t > file.html``
  326. | | .
  327. | **Con Índice de Contenidos** | ``$ txt2tags -t html --toc file.t2t``
  328. | **Con Títulos Numerados** | ``$ txt2tags -t html --toc --enum-title file.t2t``
  329. | | .
  330. | **Vista rápida del Índice** | ``$ txt2tags --toc-only file.t2t``
  331. | **żÍndice numerado? ĄSi!** | ``$ txt2tags --toc-only --enum-title file.t2t``
  332. | | .
  333. | **...... desde STDIN** | ``$ echo -e "\n**bold**" | txt2tags -t html --no-headers -``
  334. | **Enmascarando los e-mails** | ``$ echo -e "\njohn.wayne@farwest.com" | txt2tags -t txt --mask-email --no-headers -``
  335. | **Edición post-conversión** | ``$ txt2tags -t html -o- file.t2t | sed "s/<BODY .*/<BODY BGCOLOR=green>/" > file.html``
  336. : //Nota//
  337. Desde la versión 1.6 es posible realizar un tratamiento pre y post conversión mediante los filtros
  338. ``%!preproc`` y ``%!postproc`` .
  339. ========================================================================
  340. = Parte II: - OK!, Quiero utilizar el programa. żQue debo hacer ? =[install]
  341. Sencillamente, descargar el programa y hacer que corra en tu máquina :-).Veamos como hacerlo.
  342. == Obtener e instalar Python ==[download-python]
  343. En primer lugar, deberemos instalar el interprete Python en nuestro sistema. Si ya lo tenemos instalado, podemos saltarnos este apartado.
  344. Python es uno de los mejores lenguajes de programación. Funciona en Linux, Mac, Windows y otros Sistemas Operativos. Puede descargarse del la web de [Python http://www.python.org]. Las instrucciones para su instalación se encuentran disponibles en este mismo site. Txt2tags funciona mejor con versiones de Python 1.5 o superiores.
  345. Si no estais seguros de tener Python instalado en vuestro sistema, abrid una consola ( tty, xterm, MSDOS..) y lanzad el comando ``python``. Si no está instalado, vuestro sistema os lo advertirá
  346. == Obtener Txt2tags ==[download-txt2tags]
  347. El sitio oficial de la distribución de txt2tags es: http://txt2tags.org/src .
  348. Todos los archivos son del tipo "tarball" (tar.gz,.tgz), que pueden ser descomprimidos por la mayoria de los programas de descompresión (incluido Winzip).
  349. Debemos procurar obtener la **última versión** (la mas reciente o el número de versión mas alto). Las versiones precedentes se conservan el el repositorio por razones puramente históricas.
  350. == Instalar txt2tags ==[install-txt2tags]
  351. Como todos los scripts Python, txt2tags apenas precisa de instalación.
  352. El único archivo necesario para el programa es el script txt2tags. Los demás archivos tar.gz (.tgz) son la documentación, las utilidades y los archivos de ejemplo.
  353. El medio mas seguro de iniciar txt2tags es "llamarlo" desde Python.
  354. ``` prompt$ python txt2tags
  355. Si deseais instalar txt2tags como programa en vuestro sistema, copiad (o cread un enlace) el script txt2tags en un directorio referenciado por la variable $PATH y aseguraos de que el sistema pueda lanzar el programa.
  356. : **UNIX/Linux**
  357. Asegurémosnos de que el script es ejecutable : ``chmod +x txt2tags`` y, seguidamente lo copiamos en un directorio referenciado por $PATH:
  358. ``cp txt2tags /usr/local/bin``
  359. : **Windows**
  360. Renombrar el script ańadiéndole la extensión .py :
  361. ``ren txt2tags txt2tags.py`` y copiarlo en un directorio referenciado en $PATH:
  362. ``copy txt2tags.py C:\WINNT``
  363. Después de esto, si deseais utilizar el entorno gráfico, podreis crear un icono en vuestro escritorio.
  364. === Paquetes especiales para los usuarios de Windows ===
  365. Existen dos distribuciones .EXE de txt2tags, que instalan el programa en maquinás Windows con solo unos cuantos "clics":
  366. - La primera es el simple script txt2tags para los que tengan instalado Python.
  367. - La segunda de estas dos distribuciones es la "versión completa", con la cuál no se precisa tener instalado Python en el sistema (Incluye una versión "ligera" de Python).
  368. Se pueden obnener en //Txt2tags-Win//: http://txt2tags-win.sf.net
  369. == Instalación de los Archivos de Sintaxis para los Editores de Texto ==[editor-syntax]
  370. Con txt2tags se proporcionan una serie de archivos de sintaxis prácticos, utilizables con los siguientes editores:
  371. - Vim (www.vim.org)
  372. - Emacs (www.emacs.org)
  373. - Nano (www.nano-editor.org)
  374. - Kate (http://kate.kde.org)
  375. Estos archivos sintácticos contienen todas las reglas y marcas que utiliza txt2tags, ayudándo al usuario a escribir los documentos sintacticamente correctos. Las marcas se visualizan en color, así podremos darnos cuenta de si escribimos correctamente.
  376. | [IMGPATH/vim.png] |
  377. | Ejemplo de archivo editado en Vim
  378. Cada editor tiene un procedimiento de instalación específico. Consulta el encabezamiento del archivo de sintaxis y la documentación del editor.
  379. ========================================================================
  380. = Parte III - Escribiendo y convirtiendo vuestro primer documento. =[your-1st-doc]
  381. == Probar las herramientas ==
  382. Para poder hacer vuestra primera conversión necesitareis tres cosas: txt2tags, un editor y un navegador web.
  383. + Comprobad que txt2tags funciona correctamente en vuestra máquina.
  384. - **Interfaz de Línea de Comandos:** Lanzad el comando txt2tags desde la línea de comandos. Deberá generarse una salida con un mensage similar a "Missing input file". Si no ocurre eso, probad con: "pyton /ruta/hacia/txt2tags" o con: "/ruta/hacia/python /ruta/hacia/txt2tags" en el caso de que python no esté en vuestro PATH.
  385. - **Interfaz GUI:** Si lanzamos txt2tags desde la línea de comandos, se iniciará con el sistema gráfico. En el caso de que hayamos creado un icono en el escritorio, "clicar" en el.
  386. + Abrid un editor de texto que conozcais bién, puede ser cualquiera, desde Vim a MSWord u Openoffice. Cread un nuevo documento, que será vuestro primer documento txt2tags.
  387. + Lanzad vuestro browser preferido para poder ver los resultados de la conversión en una pagina HTML.
  388. ------------------------------------------------------------------------
  389. == Escribir el encabezamiento del documento ==
  390. + Id al editor de texto y teclead una primera línea , por ejemplo: //Mi Primer Documento//
  391. + En una segunda línea teclead un sub-título, por ejemplo://txt2tags//
  392. + Después, en una tercera línea teclead, por ejemplo, una fecha: //Domingo 17 Julio 2005//
  393. Así, dispondremos de un documento con el siguiente contenido:
  394. ```
  395. Mi primer documento
  396. txt2tags
  397. Domingo 17 Julio 2005
  398. ```
  399. Aunque ésto sea sólo una parte del documento, podemos convertirlo y comprobar el resultado.
  400. Guardad el documento con el nombre ``test.txt`` en un directorio desde donde, más tarde, podamos recuperarlo (en los siguientes ejemplos el documento se ha guardado en el directorio /tmp).
  401. ------------------------------------------------------------------------
  402. == La Primera Conversión : La Interfaz Gráfica. ==
  403. Si utilizais la interfaz de línea de comandos, pasad a la siguiente sección.
  404. Si utilizais la interfaz gráfica, proceded tal como a continuación se indica:
  405. [IMGPATH/firstdoc.png]
  406. + Clicar en el botón "Browser", navegad hasta el directorio en el que guardasteis el documento test.tx y seleccionarlo.
  407. + En el apartado "Choose the target document type" (Elija el tipo de documento de salida) escoged : "HTML page"
  408. + Clicar el boton "Convert!" (Convertir)
  409. [IMGPATH/firstdoc-done.png]
  410. Aparecerá un diálogo que nos informa que la conversión se ha realizado con éxito. Notad que el archivo HTML generado ha sido guardado en el mismo directorio que el archivo test.txt, pero con la extensión .html
  411. ------------------------------------------------------------------------
  412. == La Primera Conversión: Interface en Línea de Comandos ==
  413. Si utilizais la interfaz gráfica, id a la sección anterior.
  414. Si utilizais la interfaz de Línea de Comandos, id al directorio en el que está guardado test.txt y teclead el siguiente comando:
  415. ``` txt2tags --target html test.txt
  416. Observad que hay un espacio en blanco entre cada una de las partes del comando, pero no en --target. Dicha opción es seguida por html, que indica al programa el formato al que deseamos convertir el archivo de texto. La última parte de la orden es el nombre del archivo de texto que deseamos convertir.
  417. Si la conversión se realiza con éxito, el resultado es guardado como ``test.html``
  418. y el programa nos dará un mensaje del tipo: "//txt2tags wrote test.html//" . En caso contrario ,os indicará el error cometido. Verificadlo con atención.
  419. Esto es una muestra de lo que podeis ver en la pantalla:
  420. ```
  421. prompt$ txt2tags --target html test.txt
  422. txt2tags wrote test.html
  423. prompt$
  424. ```
  425. ------------------------------------------------------------------------
  426. == Comprobar el resultado ==
  427. Abrir el archivo ``test.html`` con el navegador y comprobar el resultado de la conversiňn.
  428. [IMGPATH/firstdoc-html.png]
  429. Ą Bién ! Os habeis limitado a teclear tres simples líneas de texto y txt2tags ha realizado todo el trabajo necesario para configurar el encabezamiento de la pagina HTML. El alineamiento del texto, los márgenes, los espaciados, la apariencia, etc. Podemos observar como el título principal del documento aparece también en el borde superior del navegador (o en el título de la pestańa, en el caso de que usemos uno que aporte esta función).
  430. || Vosotros escribis el texto, txt2tags hace el resto :-) |
  431. Truco: podeis utilizar CSS en las páginas HTML generadas por txt2tags. De esta forma la apariencia de la página es configurable al 100%.
  432. ------------------------------------------------------------------------
  433. == Escribir el cuerpo del documento ==
  434. Volvamos al editor de texto, ya que la siguiente etapa consistirá en escribir el cuerpo del documento. Podeis escribirlo en texto plano, el mismo que usais en los e-mail. Podreis observar como txt2tags reconoce automaticamente los párrafos y las listas de elementos, sin necesidad de "marcarlos".
  435. Guardad de nuevo el documento y proceded a su conversión, tal como se indicó en la anterior sección. Comprobad el resultado. Éste es el ciclo de desarrollo de documentos con txt2tags. No necesitais más que centraros en el contenido del documento, obteniendo el documento final mas rápidamente que con otros editores. Sin interminables "clics" de ratón, ni menús, ni ventanas ni distracciones.
  436. Observad el contenido del archivo de texto plano ``test.txt`` y comparémoslo con el archivo HTML generado:
  437. ```
  438. Mi primer documento
  439. txt2tags
  440. Domingo 17 Julio 2005
  441. Bueno, vamos a probar txt2tags.
  442. No se me ocurre nada que escribir. Probemos con una lista.
  443. Necesitaria:
  444. - Ducharme
  445. - Comer una pizza
  446. - Dormir
  447. ```
  448. [IMGPATH/firstdoc-fullhtml.png]
  449. Con txt2tags es posible escribir una página web entera sin ningún conocimiento de HTML. No necesitareis intertar ninguna marca. Además, el mismo archivo de texto plano puede convertirse en cada uno de los demás formatos soportados por txt2tags.
  450. Además del texto plano, txt2tags proporciona una serie de marcas muy simples que pueden utilizarse cuando se tenga necesidad de otros formatos o estructuras, como puede ser el texto en negrita, cursiva o itálica, los títulos, las imágenes, las tablas y otros. Un ejemplo rapido:
  451. ``**comienza en negrita**`` y ``== los signos igual para el título ==``.
  452. Para aprender a utilizar estas marcas consultad el archivo [Txt2tags Markup Demo http://txt2tags.org/markup.html].
  453. =======================================================================
  454. = Parte IV - Dominando los Conceptos de Txt2tags =[concepts]
  455. == Las Áreas de un Documento .t2t ==[areas]
  456. Los archivos marcados por txt2tags se dividen en 3 áreas. Cada una de estas tres áreas tiene sus propias reglas y finalidades. Estas áreas son:
  457. : //ENCABEZAMIENTO//
  458. Lugar para el título del documento, nombre del autor, versión y fecha. (opcional)
  459. : //CONFIGURACIÓN//
  460. Lugar para la configuración general del documento. (opcional)
  461. : //CUERPO//
  462. Lugar en el que se coloca el contenido del documento. (obligatoria)
  463. Como se ha podido observar, solo el área del //CUERPO//
  464. es obligaroria.
  465. Cada área esta regulada por reglas específicas, que se detallarán en el siguiente capítulo. Por ahora, vamos a quedarnos con una representación gráfica de las áreas de un documento txt2tags:
  466. ```
  467. _________________
  468. | |
  469. | ENCABEZAMIENTO | 1. En primer lugar,los Encabezamientos
  470. | |
  471. | CONFIGURACIÓN | 2. Después,las Configuraciones
  472. | |
  473. | CUERPO | 3. Finalmente,el Cuerpo del documento,
  474. | |
  475. | ... | el cual abarca hasta el final
  476. | ... |
  477. |_________________|
  478. ```
  479. En resumen, así es como se definen las tres áreas:
  480. | **Encabezamiento** | Las primeras 3 líneas del archivo. O la primera línea en blanco, cuando no se quiere un Encabezamiento.
  481. | **Configuración** | Desde la 4Ş linea (o desde la 2Ş , en el caso que no se contemple Encabezamiento) hasta donde comience el Cuerpo del Documento..
  482. | **Cuerpo** | Comienza con la primera línea de texto válido (no "comentado" o que no sea una configuración) después del Encabezamiento.
  483. === Veamos un ejemplo: ===
  484. ```
  485. My nice doc Title
  486. Mr. John Doe
  487. Last Updated: %%mtime(%c)
  488. %! Target : html
  489. %! Style : fancy.css
  490. %! Encoding: iso-8859-1
  491. %! Options : --toc --enum-title
  492. Hi! This is my test document.
  493. Its content will end here.
  494. ```
  495. ------------------------------------------------------------------------
  496. == Área de Encabezamiento ==[headers-area]
  497. Localización:
  498. - Posicion fija: Las **tres pimeras líneas** de un archivo. Eso es todo :-)
  499. - Posicion fija: La **primera línea** de un archivo, si se trata de una línea en blanco. Esto signfica "Encabezamiento vacio".
  500. El Área de Encabezamiento es la única que tiene una posición fija, determinada por líneas. Se encuentra siempre en las tres primeras líneas del archivo fuente.
  501. El contenido de estas líneas no esta regulado, es libre, aunque se recomienda que se siga la siguiente pauta:
  502. - //línea 1//: título del documento
  503. - //línea 2//: nombre del autor y/o email
  504. - //línea 3//: fecha del documento y/o versión (un buén lugar para ``%%date``)
  505. Retengamos que las tres primeras líneas del documento fuente serán las tres primeras líneas del documento final, separadas y diferenciadas del resto del contenido del documento ( p.e.,carácteres mas grandes, en negrita). Si es posible la paginación, encontraremos el encabezamiento sólo y centrado en la primera página.
  506. ==== Menos (o Ninguna) líneas de Encabezamiento ====
  507. Tal vez deseemos menos líneas de encabezamiento. Por ejemplo, solo deseamos especificar el título y la fecha.
  508. Para ello bastara con dejar la 2Ş y/o la 3Ş línea en blanco. Esta/s líneas en blanco no serán incluidas en el documento final. Pero no debemos olvidar que, aún en blanco, estas líneas forman parte del Área de Encabezamiento del documento y que el Cuerpo del mismo comenzará **a partir de** la tercera línea.
  509. La primera línea (normalmente, el título) es la unica línea requerida en el Área de Encabezamiento. Recordemos que la primera línea en blanco indica **Encabezamiento vacio**, lo que origina que el //Área de Encabezamiento// se inicie a partir de la 2Ş línea.
  510. No configurar un encabezamiento puede sernos de utilidad en el caso de querer insertar un encabezamiento personalizado después de la conversión. Para éste tipo de operación generalmente se requiere la opción de línea de comandos ``--no-headers``.
  511. %==== Straight to the point ====
  512. || En resumen: Los Encabezamientos son posiciones, no contenidos. |
  513. Si colocamos un texto en la primera línea del archivo fuente, aparecerá en la primera línea del documento convertido. Lo mismo para las 2Ş y 3Ş líneas.
  514. ------------------------------------------------------------------------
  515. == Area de Configuración ==[config-area]
  516. Localización:
  517. - Comienza justo despues del Área de Encabezamiento
  518. - Comienza a partir de la 4Ş línea si se especifican encabezamientos
  519. - Comienza a partir de la 2Ş línea en el caso de **Encabezamiento vacio**.
  520. - Finaliza donde comienza el Área del Cuerpo del documento
  521. - Finaliza en una línea en blanco, en una línea que sea un comentario o en una línea que no sea de ajuste/configuración.
  522. El Área de Configuración es opcional. Cualquiera puede generar documentos txt2tags sin siquiera conocer la existencia de dicha área, pero el usuario experimentado dificilmente podra prescindir de la ventaja y el control que dicha área le proporcionará.
  523. El Área de Configuración nos servirá para definir en ella configuraciones que afecten al comportamiento del programa, evitando asi tener que escribir dichas opciones en la línea de comandos en el momento de ralizar la conversión.
  524. Para mas información, consultar la Sección:[Configuraciones (Settings section) #settings-overview].
  525. ----------------------------------------------------------------
  526. == Área del Cuerpo del Documento ==[body-area]
  527. Localización:
  528. - Comienza con la primera línea válida de texto del archivo.
  529. - Las líneas que contienen ajustes o comentarios y las líneas en blanco no se consideran líneas válidas de texto
  530. - Finaliza al final del archivo (EOF)
  531. Consideraremos Cuerpo todo lo que no sea ni Encabezamiento ni Configuración.
  532. El Cuerpo está constituido por el contenido del documento y todas aquellas estructuras y formatos que txt2tags puede reconocer.
  533. En el Cuerpo pueden incluirse comentarios para los //TODOs// y notas personales.
  534. Puede utilizarse la opción en línea de comandos ``--no-headers`` para convertir solo el Cuerpo del documento, suprimiendo los Encabezamientos. Esto es práctico cuando se tienen Encabezamientos personalizados en un archivos aparte, que se concatenará seguidamente con el documento que estemos procesando.
  535. ----------------------------------------------------------------
  536. == Configuraciones: żCómo Configurar algo?. żCuál es la sintaxis? ==[settings-overview]
  537. Las líneas de configuración son líneas de comentario especiales, situadas en el Área de Configuración, que afectan al proceso de conversión. Su sintaxis, tan simple como la atribución de valor a una variable, está compuesta por una palabra-clave y un valor, separados la una del otro por el separador canonico dos-puntos **":"** . Su sintaxis es:
  538. || %! palabra-clave : valor |
  539. Lista de claves válidas:
  540. || Clave | Descripción |
  541. | Target | Define el formato al cuál debe ser convertido el documento.
  542. | Options | Es útil para especificar las opciones de línea de comando para el archivo fuente. El formato de las opciones es el mismo que el utilizado en la línea de comandos. Usando esta opción junto con %!target permite convertir el documento simplemente con la orden: txt2tags file.t2t
  543. | Style | Sólo es soprtado por el documento destino HTML, para definir una hoja de estilo (CSS)
  544. | Encoding | Es una configuración importante en documentos que contienen acentos y carácteres no ASCII, ya que permite personalizar el Conjunto de Carácteres (Codificación de Carácteres).
  545. | PreProc | Es un filtro. Define reglas del tipo "busca y sustituye" que serán aplicadas al archivo original antes de cualquier análisis por parte de txt2tags.
  546. | PostProc | Es un filtro. Define reglas del tipo "busca y sustituye" que serán aplicadas al archivo destino después de todo el procesamiento por parte de txt2tags.
  547. Ejemplo:
  548. ```
  549. %! Target : html
  550. %! Options : --toc --toc-level 3
  551. %! Style : fancy.css
  552. %! Encoding: iso-8859-1
  553. %! PreProc : "AMJ" "Aurelio Marinho Jargas"
  554. %! PostProc: '<BODY.*?>' '<BODY bgcolor="yellow">'
  555. ```
  556. -----------------------------------------------------------------------
  557. === Algunas reglas sobre las Configuraciones ===
  558. - Las configuraciones son válidas solo dentro del Area de Configuración. Serán tratadas como comentarios simples si se encuentran en el Cuerpo del documento.
  559. - Si la misma palabra-clave aparece más de una vez en el Area de Configuración, solo se utilizara la última. Excepciones: Options, PreProc y PostProc, que son acumulativas.
  560. - Una línea de configuración con una palabra-clave inválida será considerada un comentario.
  561. - Las opciones de configuración situadas en el Área de Configuración tienen preferencia dentro del archivo txt2tags, pero no sobre las opciones en Línea de Comando.
  562. == Opciones en Línea de Comando ==[options]
  563. El modo más rápido de cambiar el comportamiento por defecto es utilizando las opciones de la línea de comando. Esto es sólo posible cuando se utiliza la citada interfaz, no cuando se utilizan las interfaces Web o GUI.
  564. El programa acepta un juego de opciones predefinidas. Una opción es un guión ("-") seguido de una letra o dos guiones ("--") seguidos de una o mas palabras, como ``-t`` y ``--target``.
  565. A propósito de la opción "target": resulta ser la única opción obligatoria. Todas las demás opciones son eso, opcionales. :-)
  566. Las opciones más utilizadas son ``--outfile`` para activar la generación automática de índices de materias y
  567. ``--encoding`` que nos permite escoger el tipo de codificación de caracteres. La mayoria de las opciones pueden ser desactivadas precediéndolas de "no-" , por ejemplo:
  568. ``--no-encoding`` and ``--no-toc``.
  569. Pueden configurarse las opciones que se deseen utilizar en un determinado archivo origen, en el Ärea de Configuración del mismo archivo, mediante la regla de configuración ``%!options`` . Esto nos evita el tecleado de las opciones en la línea de comando.
  570. Por ejemplo: ``%!options: --toc -o mydoc.html``.
  571. La excepción es la especificacion del formato del archivo final, que tiene su propia sintaxis: ``%!target: html``.
  572. La opción ``--help`` nos proporcionará una lista completa de las opciones disponibles.
  573. -----------------------------------------------------------------------
  574. == Archivo de Configuracion del Usuario (RC) ==[rc]
  575. El archivo de configuración del usuario (llamado también archivo RC) es el lugar donde se guardan las reglas de las configuraciones que pueden ser compartidas por TODOS los archivos. Si utilizas las mismas reglas de configuración en todos los archivos .t2t que escribais, incluidlas en el archivo RC y podrán ser utilizadas globalmente, tanto por los existentes como por futuros archivos fuente.
  576. El emplazamiento por defecto de este archivo depende del sistema que se esté utilizando. De todas maneras, dicho emplazamiento puede ser modificado por el usuario utilizando una variable de entorno.
  577. || | RC file location |
  578. | Windows: | ``%HOMEPATH%\_t2trc``
  579. | Linux y otros: | ``$HOME/.txt2tagsrc``
  580. | Definidod por usuario: | ``T2TCONFIG`` env var
  581. El formato de las reglas de configuración es exactamente el mismo que el utilizado en el Área de Configuración de los archivos .t2t. Podemos encontrar un ejemplo de archivo RC en el "tarball"
  582. ``doc/txt2tagsrc``
  583. Ejemplo:
  584. ```
  585. % my configs
  586. %%% Always use CSS-friendly tags in HTML
  587. %!options(html): --css-sugar
  588. %%% Change the default TOC depth for all targets
  589. %!options: --toc-level 4
  590. %%% Set the default encoding for all documents
  591. %!options: --encoding iso-8859-1
  592. ```
  593. Toda línea no vacia, un comentario o una línea de configuración vŕlida puede generar un error durante la ejecución de txt2tags. Sed muy cautelosos a la hora de editar el archivo RC.
  594. Txt2tags aplica automaticamente el archivo RC a todo archivo fuente que convierta. Si se desea desactivar el comportamiento para un determinado archivo, utilizad la opción ``--no-rc``.
  595. == Orden de Aplicación de las Configuraciones y Precedencia ==[config-loading]
  596. Hay tres formas de indicar a txt2tags cuales opciones y configuraciones utilizar y el orden que debe aplicarlas:
  597. + El archivo de usuario RC ( .txt2tagsrc)
  598. + Una Área de Configuración en el documento fuente
  599. + Las opciones de línea de comando
  600. En primer lugar, el programa lee las configuraciones del archivo RC. Si no encuentra otras, las aplica. Si encuentra configuraciones en el Área de Configuración del documento fuente, las lee, sobrescribiendo las configuraciones de RC. Finalmente, si encuentra opciones en la línea de comando,las lee, sobreescribiento a cualquiera de las otras dos anteriones.
  601. Asi, si el "encoding" del documento fuera definido en las tres opciones, se aplicarian las opciones definidas en la linea de comando.
  602. -----------------------------------------------------------------------
  603. == El Comando %!include ==[include]
  604. Desde la versión 1.7, es posible la utilización del comando ``include`` para insertar el contenido de un archivo externo en el Cuerpo del documento original.
  605. ``include`` es un comando, no una configuración. Es solo válido cuando se incluye en el //Área del Cuerpo del documento//.
  606. ``include`` es útil para dividir un documento grande en varios archivos menores ( p.e. en capítulos) o para incluir todo el contenido de un archivo externo cualquiera en el documento fuente.
  607. Ejemplo:
  608. ```
  609. My first book
  610. Dr. John Doe
  611. 1st Edition
  612. %!include: intro.t2t
  613. %!include: chapter1.t2t
  614. %!include: chapter2.t2t
  615. ...
  616. %!include: chapter9.t2t
  617. %!include: ending.t2t
  618. ```
  619. Como puede verse, basta con indicar el nombre del archivo después del comando ``include``. Las especificaciones opcionales del archivo final tambien són soportadas por el comando:
  620. ``` %!include(html): file.t2t
  621. Debemos tener presente que ``include`` insertará en el Área del Cuerpo el archivo .t2t, ignorando su encabezamiento y sus configuraciones. Esto nos permitirá convertir el documento incluido, separada o conjuntamente con el documento principal.
  622. Podemos considerar tres variantes de inclusión:
  623. - Verbatim
  624. - Raw
  625. - Tagged
  626. **Verbatim** : El texto es incluido preservando sus espacios y formato original, como si estuviese marcado por VERB. Para incluir un archivo de esta manera, basta con incluir su nombre entre (```):
  627. ``` %!include: ``/etc/fstab``
  628. **Raw** : El texto es incluido "como esta". No busca las marcas txt2tags, ni las interpreta. Es como si el texto estuviese entre marcadores (" ") de área protegida.
  629. Para incluir un archivo de esta menera basta con colocar su nombre entre dobles-comillas (" " ):
  630. ``` %!include: ""boom_text.txt""
  631. **Tagged** : El texto es pasado directamente al documento resultante, sin ningún tratamiento por parte de txt2tags. Mediante este procedimiento podemos in

Large files files are truncated, but you can click here to view the full file