6
¿Qué herramientas OSS (o gratuitas) están disponibles para redactar una única fuente de documentación que se puede utilizar para generar manuales? En concreto, en los siguientes formatos:Herramienta de documentación de fuente única
- página web HTML
- documento PDF
- Embedded (dentro de una aplicación, posiblemente HTML)
- texto (opcional)
- páginas Man (opcional)
Requisitos adicionales:
- La herramienta es adecuada para escritores técnicos (no necesita ser WYSIWYG).
- XML/fuente SGML
- alta calidad de salida PDF (comparable a TEX)
- multi-plataforma
Ampliado Requisito
La misma aplicación de línea de comandos está escrito en dos idiomas (C y Java). Al usar XML para describir las opciones de línea de comandos (algunas de las cuales son específicas de un idioma u otro), es sencillo transformar el XML en una clase Java, o una función C, que escribe ayuda para la salida estándar. Esto asegura que la ayuda se puede integrar en el binario sin tener que depender de archivos externos.
Parece que AsciiDoc no tiene esta capacidad. ¿Hay otra opción?
AsciiDoc se ve excelente. ¿Cómo lo integraría con una aplicación de línea de comandos? –
Un enfoque podría ser el uso de un archivo de origen XML que describe las opciones de línea de comandos para su aplicación, a continuación, ejecutar que a través de una transformación que genera la fuente AsciiDoc para una configuración particular de su aplicación (C o Java, seleccionando solamente las partes apropiadas) . No parece que AsciiDoc sea la herramienta adecuada para generar el código fuente C/Java real; Usaría una herramienta diferente para eso. Pero sin duda tener una fuente XML común para todas las representaciones de su línea de comando ayuda suena como algo bueno. –