halibut
Sistema de formato de texto diseñado principalmente para la redacción de documentación de software. Se centra en la capacidad de generar una amplia variedad de formatos de salida [Text, HTML, WinHelp [Ayuda de Windows], Man Pages [páginas de manual], Info de GNU, PostScript o PDF] desde una única fuente. La idea central de Halibut es escribir el contenido una sola vez en un formato de texto plano y simple, y luego se encarga de convertirlo en el formato final que se necesite, ya sea visualización en web, como manual o para imprimir.
Halibut utiliza un conjunto de directivas o comandos de formato dentro del archivo fuente para estructurar el contenido. Algunas de las más comunes incluyen:
\chapter{Título del Capítulo} --> Define un nuevo capítulo.
\section{Título de la Sección} --> Define una nueva sección.
\subsection{Título de la Subsección}--> Define una nueva subsección.
\paragraph{Título del Párrafo} --> Define un nuevo párrafo.
\item{Texto del Ítem} --> Crea un elemento en una lista.
\code{Código} --> Formatea texto como código.
\url{URL} --> Inserta una URL.
\li{Texto de la lista} --> Similar a `\item`, para elementos de lista.
\i{Texto en cursiva} --> Formatea texto en cursiva.
\b{Texto en negrita} --> Formatea texto en negrita.
1.-
Ejemplo de uso con un archivo fuente simple
$ nano manual.txt
\chapter{Mi Primer Manual con Halibut}
Este es un ejemplo sencillo de un manual escrito usando Halibut.
\section{Introducción}
Bienvenidos a este pequeño manual. Aquí exploraremos las capacidades básicas de Halibut.
\paragraph{Un Poco de Historia}
Halibut fue creado por Simon Tatham, el mismo autor de la famosa herramienta PuTTY.
Su diseño se centra en la simplicidad y la eficiencia.
\section{Características Principales}
Halibut ofrece varias características útiles:
\li Generación de múltiples formatos de salida.
\li Sintaxis de marcado simple y fácil de aprender.
\li Soporte para referencias cruzadas y tablas de contenido.
\subsection{Ejemplo de Código}
Aquí tienes un ejemplo de cómo se puede formatear código:
\code{
#include <stdio.h>
int main() {
printf("¡Hola, Halibut!\n");
return 0;
}
}
\section{Enlaces Útiles}
Puedes encontrar más información sobre Halibut en su sitio web oficial:
\url{https://www.chiark.greenend.org.uk/~sgtatham/halibut/}
\end{document}
$ halibut --text manual.txt > manual.txt.out
$ halibut --html manual.txt > manual.html
$ halibut --man manual.txt > manual.man
$ halibut --ps manual.txt > manual.ps