texdi.te 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. #Texdi
  2. ##Introducción
  3. Este manual documenta como usar además de las ventajas e incompatibilidades del conversor Texdi.
  4. Es recomendable leer antes la referencia del lenguaje porque ayuda a comprender mejor este documento.
  5. ##Lenguajes de etiquetado soportados
  6. Texdi es un acrónimo entre texto y tedi. Esto significa que este programa pretende dar soporte a todos los lenguajes de etiquetado posibles. Se han buscado de cada tipo un representante mayoritario.
  7. Los conversores se hacen de manera independiente en bibliotecas cómodas. Sus nombres en el código surgen de la forma tedi2LENG donde LENG es el lenguaje al que se convierte.
  8. __
  9. -- HTML: tedi2html
  10. -- Latex: tedi2tex
  11. -- Asciidoc: tedi2ad
  12. -- Markdown: tedi2md
  13. ,,
  14. ##Parámetros de consola
  15. Texdi solo permite parámetros que cambien la interacción del usuario. Un parámetro no modifica el proceso de conversión. Normalmente sirven para definir valores por defecto por comodidad del usuario. Abajo se muestra una lista con una descripción de lo que realiza cada opción.
  16. <--latex
  17. Convierte el documento a latex sin autor.
  18. <--html
  19. Convierte el documento a HTML. Los estilos son predeterminados.
  20. <--asciidoc
  21. Convierte el documento a AsciiDoc.
  22. <--markdown
  23. Convierte el documento a Markdown.
  24. <--output ARCHIVO
  25. <-o ARCHIVO
  26. Permite elegir el nombre del archivo de salida de la conversión.
  27. <--own-styles
  28. Añade un enlace a styles.css, permite usar estilos propios en el documento HTML.
  29. <--help
  30. Muestra una lista con todas las opciones anteriores.
  31. ##Implementación referencia
  32. Este programa supone la implementación referencia de Tedi, ya que no hay otra. La referencia de Tedi no aporta gran cantidad de información sobre la manera más correcta de implementar un conversión de Tedi a otro lenguaje. De ahí que sea tan importante la implementación referencia. Las bibliotecas que conforman Texdi son muy parecidas pero no son iguales. La biblioteca referencia de Tedi es tedi2html.
  33. tedi2html cumple un orden secuencial que acaba generando una jerarquía. Antes de toda conversión, el paso de prepocesado se encarga de cargar los documentos que aparecen en el documento cumpliendo así la etiqueta inserta.
  34. ##Etiquetas de control
  35. Solo las tres primeras etiquetas de control (Comentarios, metaetiqueta y código incrustado)
  36. se encuentran en el apartado de control de la librería tedi2html. Esto se debe a que estas cuatro etiquetas coinciden en el primer carácter '<'.
  37. Al estar pensadas para la primera posición, son fáciles de detectar y no hace es necesario un algoritmo muy complejo.
  38. ###Comentarios
  39. La primera etiqueta que se comprueba en el código es el comentario. La línea no pasará al documento de salida pero permite documentar el texto.
  40. ###Código incrustado
  41. La implementación al detectar esta etiqueta, elimina la etiqueta y mantiene la línea sin modificar. Tal cual expresa la referencia debe permitir que el lenguaje al que se convierte detecta esa línea como etiquetas del propio lenguaje.
  42. ###Metaetiqueta
  43. Esta etiqueta difiere de la referencia.
  44. "La mayoría de lenguajes de etiqueta tiene una etiqueta conocida como "verbose"."
  45. Esto es significativo en la implementación de Latex más que en HTML.
  46. ##Título
  47. Hay límites de nivel de títulos. Cada almohadilla en el título expresa un nivel. Los títulos abarcan del nivel 1 hasta nivel 6. Si el usuario introduce un título de más de 6 niveles, mantendrá nivel 6.
  48. ##Listas
  49. Hay tres comprobaciones por cada etiqueta propia de la lista (comienzo, elemento y fin).
  50. En HTML permite etiquetas dentro de etiquetas pero en otros lenguajes no funcionan de la manera correcta y pueden dar incompatibilidades. Por ahora, se permite el uso de listas anidadas, a pesar de su posible incompatibilidad (todavía no se ha encontrado).
  51. ##Comillas
  52. Otra etiqueta de control que determina si se convierten los enlaces, las imágenes y los contenedores. Si una apertura de comillas en el primer carácter de la línea y otra de finalización en el último carácter, no se convertirán las etiquetas anteriores.
  53. ##Contenedores
  54. Los contenedores tienen el mismo comportamiento de un div de HTML. Entonces su conversión es casi equivalente pero con la sintaxis de HTML.
  55. Un contenedor es una parte de texto (que puede incluir etiquetas) que se separa del resto de texto. Es muy útil para subdividir regiones del texto completo.
  56. ##Imágenes
  57. Las imágenes tienen el mismo comportamiento de un img de HTML. Entonces su conversión es casi equivalente pero con la sintaxis de HTML.
  58. ##Enlaces
  59. Los enlaces tienen el mismo comportamiento de un link de HTML. Entonces su conversión es casi equivalente pero con la sintaxis de HTML pero muy simplificada.
  60. ##Tablas
  61. La última conversión que hace el código es transformar las tablas de tedi a tablas del propio lenguaje. Esta parte es la única del código que necesita conocer de las líneas anteriores para funcionar correctamente ya que una línea de tabla condiciona la siguiente.
  62. ##Consideraciones
  63. Las recomendaciones de estilo se mantienen para esta implementación y es recomendable que la recomendación sobre nivel de títulos se mantenga.