MakeDoc es un lenguaje de marcado ligero creado en 2000 por Carl Sassenrath para crear documentación y páginas web utilizando notaciones de texto simples. [1] El lenguaje se utiliza ampliamente en la comunidad REBOL para documentación, sitios web y wikis.
MakeDoc se diseñó originalmente para permitir a los autores crear documentación formateada sin la necesidad de un software de procesamiento de textos. [2] Para la entrada se puede utilizar cualquier editor de texto normal, incluidos los formularios de entrada web, y la salida puede ser HTML , PDF o texto normal. [2]
Un objetivo adicional de MakeDoc era que el formato de entrada de texto en sí fuera legible, libre de notaciones de marcado que se encuentran comúnmente en los lenguajes de marcado basados en SGML , como HTML y XML . Esto se hizo para permitir la distribución de documentación para paquetes de software, donde a menudo dichos documentos se ven (o incluso se crean) en shells de comandos de solo texto.
El formato de MakeDoc está pensado para la entrada y edición desde cualquier editor de texto, incluidos los que se utilizan a menudo en entornos de shell, como vi y Emacs .
Título del documento Placa de caldera opcional Como nombre del autor, fecha, etc.=== Encabezados primariosEste es un párrafo de ejemplo. Todo este texto quedará enel mismo párrafo hasta llegar a una línea en blanco.Este es un párrafo aparte.--- SubtítuloEl texto continúa desde aquí...
Las viñetas, listas numéricas, definiciones y otros formatos de documentos especiales se anotan comenzando una línea con un carácter especial.
Por ejemplo:
*Artículo de bala*Otro#Artículo numerado#Otro artículo numerado
Otras líneas de comando comienzan con un igual (=) seguido del comando en sí.
Por ejemplo, para incluir una imagen:
=imagen nyc.jpg
También se proporcionan muchos otros comandos. Consulte los enlaces de referencia a continuación.
El lenguaje también permite la evaluación (ejecución) de secciones de código para producir resultados, por ejemplo, o imágenes de salida. Esto hace posible generar con precisión secciones de código que contienen resultados precisos.
Por ejemplo, si el comando:
=ver
sigue un ejemplo de código, el procesador generará automáticamente una imagen de cualquier código que se muestre en su ventana.
El lenguaje MakeDoc se procesa mediante un script gratuito bajo una licencia BSD abierta . [3] Su código fuente está escrito en el lenguaje REBOL y pesa solo unos 17 KB.
El procesador se divide en un escáner de entrada de texto y un generador de salida. La salida del escáner está en formato de bloque REBOL y se puede ingresar en uno de varios formateadores de salida.
El generador de resultados para HTML está incluido en el script estándar de MakeDoc. Los generadores de salida para PDF están separados.