Hispanopedia WikiMakeDoc es un lenguaje de marcado ligero creado en 2000 por Carl Sassenrath para crear documentación y páginas web mediante notaciones de texto sencillas. [ 1 ] Este lenguaje se utiliza ampliamente en la comunidad REBOL para documentación, sitios web y wikis.
Descripción general
MakeDoc fue diseñado originalmente para permitir a los autores crear documentación formateada sin necesidad de un procesador de textos. [ 2 ] Se puede utilizar cualquier editor de texto común, incluidos los formularios de entrada web, para la entrada, y la salida puede ser HTML , PDF o texto normal. [ 2 ]
Otro objetivo de MakeDoc era que el formato de entrada de texto fuera legible, sin las anotaciones de marcado que suelen encontrarse en lenguajes de marcado basados en SGML , como HTML y XML . Esto se hizo para facilitar la distribución de la documentación de paquetes de software, donde a menudo estos documentos se visualizan (o incluso se crean) en consolas de comandos de solo texto.
Formato básico
El formato de MakeDoc está pensado para la introducción y edición desde cualquier editor de texto, incluidos los que se utilizan habitualmente en entornos de línea de comandos, como vi y Emacs .
Títulos, encabezados y párrafos
Título del documento Placa base opcional Tales como el nombre del autor, la fecha, etc. === Encabezados principales Este es un párrafo de ejemplo. Todo este texto permanecerá en El mismo párrafo hasta llegar a una línea en blanco. Este es un párrafo aparte. --- Subtítulo El texto continúa desde aquí...
Líneas de comando
Las viñetas, las listas numéricas, las definiciones y otros formatos especiales de documentos se indican comenzando la línea con un carácter especial.
Por ejemplo:
*Elemento con viñeta *Otro #Artículo numerado #Otro artículo numerado
Otras líneas de comando comienzan con un signo igual (=) seguido del comando en sí.
Por ejemplo, para incluir una imagen:
=image nyc.jpg
También se proporcionan muchos otros comandos. Consulte los enlaces de referencia a continuación.
Órdenes especiales
El lenguaje también permite evaluar (ejecutar) secciones de código para obtener resultados, como por ejemplo, imágenes de salida. Esto posibilita la generación precisa de secciones de código con resultados exactos.
Por ejemplo, si el comando:
=vista
Tras seguir un ejemplo de código, el procesador generará automáticamente una imagen de lo que sea que el código muestre en su ventana.
Procesamiento del lenguaje
El lenguaje MakeDoc se procesa utilizando un script gratuito bajo una licencia BSD abierta . [ 3 ] Su código fuente está escrito en el lenguaje REBOL y ocupa solo unos 17 KB.
El procesador se divide en un analizador léxico de entrada de texto y un generador de salida. La salida del analizador está en formato de bloque REBOL y puede introducirse en uno de varios formateadores de salida.
El generador de salida para HTML está incluido en el script estándar de MakeDoc. Los generadores de salida para PDF son independientes.
Referencias
Véase también
- Lenguaje de marcado ligero
- MakeDoc Pro (extensiones gratuitas para MakeDoc)
- Lenguajes de marcado ligeros
