Documentación FirebirdDocumentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird
Firebird home Firebird home Anterior: Documentación para escritores de FirebirdInicio: Documentación FirebirdSubir: Documentación para escritores de FirebirdSiguiente: Obtener el módulo Firebird manual de SourceForge

Cómo obtener y construir el módulo "manual" de Firebird

Paul Vinkenoog

Traducción al castellano: Ernesto Cullen


Tabla de contenidos

Introducción: propósito de esta guía - A quién se dirige
Obtener el módulo Firebird manual de SourceForge
Construir los documentos de Firebird
Mantener su módulo manual actualizado
Si las cosas salen mal

Introducción: propósito de esta guía - A quién se dirige

Esta guía explica, paso a paso, como puede descargar y generar el módulo manual desde el proyecto Firebird en SourceForge.

En definitiva, ¿qué es este "módulo manual"?

El módulo manual es parte del Proyecto Firebird en SourceForge. Es un esfuerzo colectivo, dirigido a producir documentación precisa y comprensible sobre el RDBMS (Relational Database Management System, Sistema de Administración de Bases de Datos Relacionales) Firebird.

Es importante entender que el módulo manual contiene la documentación en formato fuente -para ser más preciso: en formato Docbook XML. Estos fuentes necesitan ser procesados (construidos o generados) para obtener documentos fáciles de leer, que pueden ser publicados en Internet.

¿Además del módulo "manual", hay alguna otra documentación de Firebird?

¡Si! Al momento de escribir estas líneas, prácticamente toda la documentación útil de Firebird ha sido producida fuera del módulo manual. Estamos todavía en las primeras etapas de llenar el módulo con documentación. De hecho, una de las razones para escribir esta guía fue la certeza de que podria ayudar a los potenciales escritores a superar sus primeros escollos.

Si Ud. está buscando documentación ya terminada sobre Firebird, cantidades de ella, su mejor punto de inicio en este momento es:

¿Realmente tengo que generar los documentos yo mismo? ¿No hay una forma más sencilla?

Claro que hay una forma más sencilla. Tan pronto como una parte de la documentación alcanza un cierto nivel de madurez, así como después de actualizaciones significativas, es publicado - como PDF y/o HTML - en el sitio de Firebird. Ud. puede encontrar todos los documentos que hemos publicado a través de la página del Subproyecto Documentación:

Debería descargar el módulo manual y generar los documentos por su cuenta si y sólo si:

  • Desea consultar los documentos en su estado más actual (no obstante, sea consciente que una de las razones de que una versión no haya sido publicada todavía puede ser el que la misma contenga errores)

  • Desea ayudar escribiendo documentación usted mismo.

  • Está interesado en aprender como funciona todo esto de la construcción de los documentos, y/o piensa que DIY es más divertido que una simple descarga de archivos.

Si alguno de los puntos anteriores aplica a su situación, esta guía es para Ud.

Anterior: Documentación para escritores de FirebirdInicio: Documentación FirebirdSubir: Documentación para escritores de FirebirdSiguiente: Obtener el módulo Firebird manual de SourceForge
Documentación FirebirdDocumentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird