| Documentación Firebird → Documentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird → Construir los documentos de Firebird |
|
|
|
El módulo manual viene con una herramienta de construcción llamada Ant para producir los documentos HTML y PDF desde el fuente DocBook XML. Ant es una herramienta Java; necesita una versión reciente de Java 2 instalada en su sistema.
En las siguientes subsecciones le mostraremos:
Adónde obtener Java 2
Cómo configurar un entorno para el proceso de construcción
Cómo generar los documentos HTML y PDF
Si Ud. ya tiene instalada una versión reciente de Java 2, puede omitir el primer paso.
Descargue e instale sólo uno de los siguientes:
Java 2 Runtime Environment, Standard Edition (Entorno de ejecución Java 2, edición estándar) - frecuentemente abreviada como J2RE SE.
Navegue a http://www.java.com/ y siga los enlaces a las páginas de descarga. Obtenga la versión que corresponda a su SO. Pinchar en los enlaces "Download" (Descargar) o "Get it now" (Obténgalo ahora) puede hacer que aparezca una nueva ventana, preguntando si está bien que Sun Microsystems instale cosas en su computadora. Si Ud. está de acuerdo, prácticamente todo será instalado automáticamente. Si eso le hace sentir incómodo, puede descargar el programa de instalación manualmente y ejecutarlo por su cuenta.
Java 2 Software Development Kit, Standard Edition (paquete de desarrollo de software, edición estándar) - o J2SDK SE.
Este es un paquete mucho más grande, y también contiene el J2RE SE. Si lo que desea es el SDK, vaya a http://java.sun.com/j2se/ y obtenga la última versión estable. Cuando tenga que elegir entre JRE y SDK, seleccione el SDK (si, también puede obtener el J2RE de aquí, pero puede hacerlo más fácil y rápido desde el enlace de la primera opción). Descargue el programa de instalación y ejecútelo.
Si Ud. no entiende la diferencia entre los dos, seleccione la primera opción: Java 2 Runtime Environment. No necesita el SDK para generar los documentos de Firebird.
Los scripts de construcción necesitan una variable de entorno JAVA_HOME apuntando al directorio de instalación de Java 2.
En Windows, típicamente se trata de algo de la forma C:\Archivos de programa\Java\j2re1.4.2_01. Para estar seguro, verifique si hay un directorio llamado bin dentro de él, y si este subdirectorio bin contiene el archivo java.exe
En Linux, puede ser /usr/lib/java/jre or /usr/java/j2sdk, o... bueno, puede tomar un montón de formas diferentes. Algunas comprobaciones: debe haber un subdirectorio bin bajo él conteniendo un archivo ejecutable java (sin el .exe esta vez).
Si tiene suerte, la variable de entorno JAVA_HOME existe y es correcta. Si no, tiene que darle valor Ud. mismo, por ejemplo bajo Windows con set JAVA_HOME=C:\Archivos de programa\Java\j2re1.4.2_01 o bajo Linux/bash con export JAVA_HOME=/usr/lib/java/jre (nota: estas rutas son sólo ejemplos; pueden o no ser iguales a las suyas).
Sugerencia: haga permanente la variable de entorno JAVA_HOME para que no tenga que configurarla una y otra vez. Cómo hacer esto depende de su SO. Consulte la documentación si es necesario.
Si ha llegado hasta aquí en una pieza, está finalmente listo para generar los documentos de Firebird. Esto es lo que hay que hacer:
Si no lo ha hecho todavía, este es el momento para leer el archivo ReadMe que se encuentra en el directorio manual. Puede contener información importante no incluída (todavía) en esta guía.
Si Ud. está en un entorno gráfico, abra una ventana de comandos.
A menos que el ReadMe le indique otra cosa, posiciónese en la carpeta manual\src\build y ejecute el comando
build (en Windows), o
./build.sh (en Linux)
si todo fue configurado correctamente, obtendrá una cantidad de líneas de salida que terminan con BUILD SUCCESSFUL (Generación exitosa), y mencionan algunos build targets (objetivos de generación, cosas que puede construir).
Ahora puede generar algo más sustancial, por ejemplo
build html o
build pdf o
build docs
Lo que sea que genere irá a parar a una carpeta bajo manual\dist.
Nota: si genera el PDF, recibirá toneladas de mensajes de error. Puede ignorarlos con seguridad, mientras una de las últimas líneas diga BUILD SUCCESSFUL.
Hay un par de opciones útiles para usar en la generación de documentos específicos:
-Drootid=id_del_documento (root id, identificador base) indica a la herramienta de construcción que genere solamente el documento cuyo identificador es id_del_documento
-Dsfx=identificador_de_lenguaje (suffix, sufijo) indica a la herramienta de construcción que genere los documentos del lenguaje especificado. Algunos identificadores reconocidos son los siguientes:
es: español
fr: francés
Si no se especifica el parámetro -Dsfx, se construirán los documentos en inglés.
Estos parámetros se pueden combinar. Por ejemplo, para generar el pdf de la Guia de Arranque Rápido en castellano usaríamos
build pdf -Drootid=qsg15-es -Dsfx=es
Esto es todo -Ud. es ahora un constructor certificado de documentos Firebird. ¡Felicitaciones!
Si Ud. desea escribir documentos propios para el proyecto Firebird, lea también la Guía de escritores Firebird.
|
| Documentación Firebird → Documentación para escritores de Firebird → Cómo obtener y construir el módulo "manual" de Firebird → Construir los documentos de Firebird |