Herramientas

Hemos documentado nuestra experiencia con tres métodos de instalación para las diferentes herramientas que son necesarias para procesar la documentación. Una es la instalación desde RPMs en Linux, la segunda es la instalación desde el porte a FreeBSD y la última es una instalación general desde distribuciones originales de las herramientas. Estas se describirán más abajo.

Pueden existir otras distribuciones empaquetadas de estas herramientas. Por favor remita información sobre estado de los paquetes a las listas de correo y la incluirimos aquí.

Instalación de RPM Linux

La instalación más sencilla para sistemas Linux compatibles con RedHat utiliza RPM, desarrollado por Mark Galassi de Cygnus. También es posible instalar desde las fuentes, como se describe en secciones posteriores.

Instalando RPMs

  1. Instale los RPM para Jade y los paquetes relacionados.

  2. Instale las últimas hojas de estilo de Norm Walsh. Dependiendo de la antiguedad de los RPM, las últimas hojas de estilo pueden haber sido muy mejoradas respecto a aquellas que aparecen con los RPM.

  3. Actualice su src/Makefile.custom para que incluyan las definiciones de HSTYLE y de PSTYLE que apuntan a las hojas de estilo.

Instalación en FreeBSD

Hay un gran conjunto de portes de la documentación de las herramientas disponibles para FreeBSD. De hecho, postgresql.org, en el que la documentación se actualiza automáticamente cada tarde, es una máquina con FreeBSD.

Instalando los "portes" de FreeBSD

  1. Para compilar la documentación sobre FreeBSD se necesita instalar unos cuantos "portes".

    % cd /usr/ports/devel/gmake && make install
    % cd /usr/ports/textproc/docproj && make install
    % cd /usr/ports/textproc/docbook && make install
    % cd /usr/ports/textproc/dsssl-docbook-modular && make install
          

  2. Fijar las variables de entorno para acceder al conjunto de herramientas de jade .

    Nota

    Esto no era requerido para la máquina FreeBSD de postgresql.org, así que puede que esto no sea necesario.

    export SMGL_ROOT=/usr/local/share/sgml                                          
    SGML_CATALOG_FILES=/usr/local/share/sgml/jade/catalog                           
    SGML_CATALOG_FILES=/usr/local/share/sgml/html/catalog:$SGML_CATALOG_FILES       
    SGML_CATALOG_FILES=/usr/local/share/sgml/iso8879/catalog:$SGML_CATALOG_FILES    
    SGML_CATALOG_FILES=/usr/local/share/sgml/transpec/catalog:$SGML_CATALOG_FILES   
    SGML_CATALOG_FILES=/usr/local/share/sgml/docbook/catalog:$SGML_CATALOG_FILES    
    export SGML_CATALOG_FILES
          
    (esto es para sintaxis sh/bash. Ajústelo para csh/tcsh).

  3. Make necesita algunos argumentos especiales o estos han de ser añadidos a su Makefile.custom:

    HSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/html/ 
    PSTYLE=/usr/local/share/sgml/docbook/dsssl/modular/print/
          
    Por descontado que necesitará usar gmake, no sólo 'make', para compilar.

Instalación en Debian

Hay un juego completo de paquetes de la documentación de las herramientas disponible para Debian.

Instalando los paquetes Debian

  1. Instale jade, docbook y unzip:

    apt-get install jade
    apt-get install docbook
    apt-get install docbook-stylesheets
          

  2. Instale las últimas hojas de estilo.

    1. Verifique que unzip está instalado o instale el paquete:

      apt-get install unzip
      	

    2. Consiga el fichero comprimido con las últimas hojas de estilo en http://www.nwalsh.com/docbook/dsssl y descomprímalo (quizás en /usr/share).

  3. Edite src/Makefile.custom y añádale las definiciones de HSTYLE y PSTYLE adecuadas:

    HSTYLE= /usr/share/docbook/html
    PSTYLE= /usr/share/docbook/print
          

Instalación manual de las herramientas

Esta es una breve descripción del proceso de obtener e instalar el software que necesitará para editar la fuente DocBook con Emacs y tratarla con las hojas de estilo DSSSL de Norman Walsh par crear ficheros HTML y RTF.

La manera más fácil de obtener las herramientas SGML y DocBook quizás sea tomar sgmltools desde sgmltools. sgmltools necesita la versión GNU de m4. Para confirmar que tiene la versión correcta de m4 pruebe

gnum4 --version
    

Si instala GNU m4, instálelo con el nombre gnum4 y sgmltools lo encontrará. Después de la instalación usted tendrá sgmltools, jade y las hojas de estilo DocBook de Norman Walsh. Las instrucciones de abajo son para instalar estas herramientas de modo separado.

Requisitos previos

Lo que usted necesita es:

  • Una instalación funcionando de GCC 2.7.2

  • Una instalación trabajando de Emacs 19.19 o posterior

  • La utilidad unzip para descomprimir ficheros

Debe conseguir:

  • Jade de James Clark (la versión 1.1 en el fichero jade1_1.zip en el momento de escribir esto)

  • DocBook versión 3.0

  • Modular Stylesheets de Norman Walsh (la versión 1.19 fue originalmente usada para producir estos documentos)

  • PSGML de Lennar Staflin (la versión 1.0.1 en psgml-1.0.1.tar.gz era la que estaba disponible en el momento de escribir esto)

URLs importantes:

Instalación de Jade

Instalación de Jade

  1. Lea las instrucciones de instalación en la URL mostrada arriba.

  2. Descomprima la distribución con unzip en el lugar adecuado . El comando para para hacer esto puede ser como este:

    unzip -aU jade1_1.zip
           

  3. Jade no ha sido construido usando GNU autoconf, de modo que tendrá que editar un Makefile por su cuenta. Ya que James Clark ha sido lo suficientemente bueno como para preparar su kit para ello, es una buena idea crear un directorio (con un nombre como la aquitectura de su máquina, por ejemplo) bajo el directorio principal de Jade, copiar desde él el fichero Makefile al directorio recién creado, editarlo y desde ahí mismo ejecutar make.

    Makefile necesitar ser. Hay un fichero llamado Makefile.jade en el directorio principal cuyo cometido es ser usado con make -f Makefile.jade cuando se construye Jade (a diferencia de SP, el parser SGML sobre el que está construido Jade). Aconsejamos que no se haga esto, ya que deberá cambiar más cosas que lo que hay en Makefile.jade.

    Recorra el fichero Makefile, leyendo las instrucciones de Jame y haciendo los cambios necesarios. Hay algunas variables que necesitan ser fijadas. Aquí se muestra un sumario de las más representativas con sus valores más típicos:

    prefix = /usr/local
    XDEFINES = -DSGML_CATALOG_FILES_DEFAULT=\"/usr/local/share/sgml/catalog\"
    XLIBS = -lm
    RANLIB = ranlib
    srcdir = ..
    XLIBDIRS = grove spgrove style
    XPROGDIRS = jade
           
    Observe la especificación de dónde encontrar el catálogo SGML por defecto de los ficheros de soporte (quizás tenga que cambiarlo a algo más adecuado para su instalación). Si su sistema no necesita los ajustes mencionados arriba para la librería de funciones matemáticas y para el comando ranlib, déjelos tal y como están en Makefile.

  4. Escriba make para compilar Jade y las herramientas de SP.

  5. Una vez que esté compilado, make install hará la instalación.

Instalación del DTD de DocBook

Instalación del DTD de DocBook

  1. Es conveniente que emplace los ficheros que constituyen el DTD de DocBook en el directorio en el que compiló Jade, /usr/local/share/sgml/ si ha seguido nuestra recomendación. Además de los ficheros de DocBook, necesitará el fichero catalog en su sitio para el mapa de las especificaciones del tipo de documento y las referencias externas de las entidades a los ficheros actuales en ese directorio. También necesitará el mapa de caracteres ISO y posiblemente una o más versiones de HTML.

    Una manera para instalar las diferentes DTD y ficheros de soporte y para ajustar el fichero catalog es juntarlos todos en el directorio mencionado más arriba, usar un único fichero llamado CATALOG que los describa a todos y entonces crear el fichero catalog como un puntero a catalog añadiendo la línea:

    CATALOG /usr/local/share/sgml/CATALOG
           

  2. El fichero CATALOG contendría tres tipos de líneas. La primera (opcional) la declaracion SGML :

    SGMLDECL docbook.dcl
           
    Después, las diferentes referencias a DTD y ficheros de las entidades. Para los ficheros DocBook las líneas serían como estas:
    PUBLIC "-//Davenport//DTD DocBook V3.0//EN" docbook.dtd
    PUBLIC "-//USA-DOD//DTD Table Model 951010//EN" cals-tbl.dtd
    PUBLIC "-//Davenport//ELEMENTS DocBook Information Pool V3.0//EN" dbpool.mod
    PUBLIC "-//Davenport//ELEMENTS DocBook Document Hierarchy V3.0//EN" dbhier.mod
    PUBLIC "-//Davenport//ENTITIES DocBook Additional General Entities V3.0//EN" dbgenent.mod
           

  3. Por supuesto que en el kit de DocBook hay un fichero que contiene todo esto. Observe que el último elemento en cada una de esas líneas es un nombre de fichero, que aquí se da sin el path. Puede poner los ficheros en subdirectorios de su directorio SGML si quiere y modificar la referencia en el fichero CATALOG. DocBook también referencia el conjunto de caracteres ISO de las entidades, por lo que necesitará traerlos e instalarlos (están disponibles desde varias fuentes y se pueden encontrar fácilmente en las URLs mostradas más arriba), además de su entradas:

    PUBLIC "ISO 8879-1986//ENTITIES Added Latin 1//EN" ISO/ISOlat1
           
    Observe que el nombre de fichero contiene un directorio, diciéndonos que hemos puesto los ficheros de entidades ISO en un subdirectorio ISO. Nuevamente las entradas oportunas en el catálogo deben acompañar a la entidad que se haya traído.

Instalación de las hojas de estilo DSSSL de Norman Walsh

Instalación de las hojas de estilo DSSSL de Norman Walsh

  1. Lea las instrucciones de instalación en la URL mostrada más arriba.

  2. Para instalar las hojas de estilo de Norman, simplemente descomprima los ficheros de la distribución en el lugar adecuado. Un buen lugar para hacerlo sería /usr/local/share, que emplaza los los ficheros en un directorio bajo /usr/local/share/docbook. El comando sería algo parecido a esto:

    unzip -aU db119.zip
           

  3. Una manera de probar la instalación es compilar los formularios HTML y RTF de la Guía de usuarios de PostgreSQL.

    1. Para compilar los ficheros HTML vaya al directorio fuente de SGML , doc/src/sgml, y escriba

      jade -t sgml -d /usr/local/share/docbook/html/docbook.dsl -D ../graphics postgres.sgml
      	 

      book1.htm es el nodo más alto de la salida...

    2. Para generar el RTF preparado ser importado a su procesador de textos favorito, escriba:

      jade -t rtf -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
      	 

Instalación de PSGML

Instalación de PSGML

  1. Lea las instrucciones de instalación en la URL mostrada más arriba.

  2. Desempaquete el fichero de la distribución, ejecute configure, make y make install para colocar en su sitio los ficheros compilados y las librerías.

  3. Después añada las líneas siguientes al fichero /usr/local/share/emacs/site-lisp/site-start.el de modo que Emacs pueda cargar correctamente PSGML cuando lo necesite:

    (setq load-path
          (cons "/usr/local/share/emacs/site-lisp/psgml" load-path))
    (autoload 'sgml-mode "psgml" "Major mode to edit SGML files." t)
           

  4. Si necesita usar PSGML cuando también esté editando HTML añada esto:

    (setq auto-mode-alist
          (cons '("\\.s?html?\\'" . sgml-mode) auto-mode-alist))
           

  5. Hay una cosa importante que debe tener en cuenta con PSGML: su autor asume que su directorio principal para el DTD SGML es /usr/local/lib/sgml. Si, como en los ejemplos de capítulo, utiliza /usr/local/share/sgml, debe corregirlo adecuadamente.

    1. Puede fijar la variable de entorno SGML_CATALOG_FILES.

    2. Puede personalizar su instalación de PSGML (el manual le dirá cómo).

    3. Puede incluso editar el fichero fuente psgml.el antes de compilar e instalar PSGML, de modo que cambie los path para que se adecuen a los suyos por defecto.

Instalación de JadeTeX

Si quiere, también puede instalar JadeTeX para usar TeX como utilidad para formatear Jade. Tenga en cuenta que es todavía un software sin depurar y generará salidas impresas inferiores a las obtenidas desde RTF. A pesar de todo, funciona bien, especialmente para los documentos más simples que no usan tablas y además, como JadeTeX y las hojas de estilo, está en un proceso continuo de mejora a medida que pasa el tiempo.

Para instalar y utilizar JadeTeX necesitará que TeX y LaTeX2eestén funcionando correctamente, incluyendo los paquetes tools y graphics, Babel, AMS fonts y AMS-LaTeX, PSNFSS y el kit de las 35 fuentes, dvips para generar PostScript, los paquetes de macros fancyhdr, hyperref, minitoc, url y ot2enc y por supuesto JadeTeX. Todos ellos se pueden encontrar en el site CTAN más próximo.

JadeTeX, en el momento de escribir esto, no viene con una guía de instalación, pero hay fichero makefile que muestra qué es necesario. También incluye un directorio llamado cooked donde encontrará algunos de los paquetes de macro que necesita (aunque no todos y tampoco completos).

Antes de compilar el fichero de formato jadetex.fmt, es posible que quiera editar el fichero jadetex.ltx para cambiar la configuración de Babel para ajustarla a su instalación. La línea a cambiar se parece a esta:

\RequirePackage[german,french,english]{babel}[1997/01/23]
     
y obviamente debe poner sólo los idiomas que necesite y configurar Babel para ello.

Con JadeTeX en funcionamiento, debería poder generar y formatear las salidas de TeX para los manuales de PostgreSQL pasando los comandos (como más arriba, en el directorio doc/src/sgml)

jade -t tex -d /usr/local/share/docbook/print/docbook.dsl -D ../graphics postgres.sgml
jadetex postgres.tex
jadetex postgres.tex
dvips postgres.dvi
     
Por supuesto, cuando haga esto TeX parará durante la segunda ejecución diciendo que su capacidad se ha sobrepasado. Esto es debido al modo en que JadeTeX genera información de referencias cruzadas. TeX puede ser compilado de manera que utilice estructuras de datos mayores. Los detalles de esto variarán de acuerdo a su instalación.