Herramientas

En este apartado nos referiremos a algunas de las herramientas que necesitará o querrá utilizar para crear su propia documentación LDP. En primer lugar, vamos a describirlas para posteriormente definirlas mejor y explicar cómo se instalan. En el caso de que recurra a alguna otra herramienta que le ayude a escribir LDP, le rogamos que nos lo comunique y añadiremos una nota al respecto.

DSSSL

Se necesita la versión Norman Walsh, pero el DSL del LDP es opcional.

El DSSSL Norman Walsh

http://nwalsh.com/docbook/dsssl/db152.zip

El Document Style Semantics and Specification Language dice a Jade cómo convertir un documento SGML para impresión o formato de visualización en línea. El DSSSL es lo que transforma, por ejemplo, una etiqueta de título en una etiqueta <H1> en HTML, o en negrita Times Roman de 14 puntos para RTF. La documentación sobre DSSSL se encuentra en http://nwalsh.com/docbook/dsssl/db152d.zip. Debe advertir que al modificar el DSSSL no se modifica el DocBook. Únicamente cambia la forma en la que aparece el texto convertido. El LDP utiliza un DSSSL modificado que proporciona una tabla de contenidos.

El DSSSL del LDP

http://metalab.unc.edu/gferg/ldp/ldp.dsl

El DSSSL del LDP necesita la versión Norman Walsh (ver información previa), aunque se trata de un DSSSL ligeramente modificado para proporcionar características tales como una tabla de contenidos.

DTD DocBook (versión 3.1)

Se necesita http://www.oasis-open.org/docbook/sgml/3.1/docbk31.zip

La DTD DocBook define las etiquetas y la estructura de un documento SGML de DocBook. Al modificar la DTD, añadiendo por ejemplo una nueva etiqueta, provoque que deje de considerarse DocBook.

Jade

Jade y OpenJade son dos de los programas que realizan la mayor parte de la representación y validación de cualquier código no basado en la DTD ni en el DSSSL. Es imprescindible uno de ellos y deberá instalarse una vez que hayan sido instalados la DTD y el DSSSL.

Jade

ftp://ftp.jclark.com/pub/jade/jade-1.2.1.tar.gz

Jade es el procesador frontal para SGML. Utiliza el DSSSL y el DTD DocBook para proporcionar la verificación y representación de SGML en el formato destino.

OpenJade

http://openjade.sourceforge.net/

Se trata de una extensión de Jade escrita por la comunidad DSSSL. Algunas aplicaciones precisan Jade, pero se están poniendo al día para admitir cualquier paquete de software.

Envoltorios Jade

Estas herramientas son opcionales y podrían instalarse una vez que se encuentren instalados Jade, el DSSSL y la DTD.

sgmltools-lite

http://sgmltools-lite.sourceforge.net/

Estamos ante el sucesor del proyecto sgmltools, que se abandonó oficialmente hace más de un año. Desde entonces, Cees de Groot ha elaborado un proyecto un tanto diferente, que actúa como un envoltorio respecto al procesador Jade SGML. Mejora la estética de la sintaxis. El creador fue capaz de instalar el antiguo paquete sgmltools seguido del sgmltools-lite y pudo formatear este documento con bastante facilidad. Existe incluso una página man (página de manual) que explica la sintaxis del sgmltools.

Herramientas Cygnus DocBook

Sitio de Red Hat: http://www.redhat.com/

Red Hat distribuye tres paquetes, que comienzan con la versión 6.2 y que incluyen soporte DocBook y algunas herramientas. La instalación de las herramientas es muy sencilla, lo que le va a permitir centrarse en escribir en lugar de estar luchando innecesariamente con ellas. En primer lugar, tiene que instalar TeTex, Jade, y JadeTeX . Los tres paquetes se encuentran disponibles en el CD de instalación de esta y otras distribuciones. N. del T.: en el caso de Debian, basta con teclear: bash# apt-get install cygnus-stylesheets

Herramientas de edición

Las siguientes herramientas pueden destinarse a la creación, edición o validación de su CÓMO.

LyX

http://www.lyx.org/

LyX permite escribir SGML con la misma facilidad de uso que la de cualquier procesador de texto normal. No se trata de un programa WYSIWYG, sino más bien de una aplicación WYSIWYM (What You See Is What You MEAN), ya que lo que observa en la pantalla no es necesariamente lo que ocurre una vez que el procesador SGML lo ha llevado a cabo. El aspecto que proporciona LyX se parece, aunque no es exactamente igual, a cómo sería la salida de Jade. Sin embargo, se acerca lo suficiente como para que pueda ver el hilo del documento. Las secciones y subsecciones se encuentran numeradas y resaltadas en negrita, y se recurre a fuentes distintas cuando se trata de subrayar algo como, por ejemplo, etiquetas <code> o <ul> . La mayoría de las etiquetas están ocultas en la ventana principal de LyX mientras está editando, ya que LyX escribe en TeX, y luego exporta el TeX a SGML.

Figure 1. Captura de pantalla LyX

LyX no muestra las etiquetas, pero reformatea el texto
basándose en la etiqueta que estásiendo utilizada.

Emacs (PSGML)

Opcional - http://www.lysator.liu.se/~lenst/about_psgml/

Emacs tiene un modo de escritura SGML denominado psgml, que es el modo principal diseñado para editar documentos SGML y XML. Ofrece las características de "coloreado de texto" y de "bonita impresión" que hacen sobresalir a las etiquetas SGML, una manera de insertar etiqueta que no tiene nada que ver con el tecleo manual, y la capacidad para dar validez a su documento mientras lo está escribiendo.

Según los usuarios de Emacs, se trata de un avance importante y muchos confían en él por permitir más versatilidad que cualquier otra herramienta de documentación SGML. Funciona igual de bien con DocBook, LinuxDoc y otros DTDs.

VIM

http://www.vim.org

No sería posible ofrecer una idea completa de Emacs sin hablar de vi. El editor VIM (Vi IMproved) tiene las mismas funciones que un vi corriente, pero además incorpora un modo SGML que coloreará y organizará su pantalla con el fin de mostrar dónde se encuentran las etiquetas.

WordPerfect 9 (Corel Office 2000)

http://www.corel.com/

WordPerfect 9 para la plataforma MS Windows admite SGML y DocBook 3.0. WordPerfect 9 para Linux no tiene capacidad SGML.

Esta es la más asequible de las aplicaciones comerciales que admiten SGML.

sgedit

http://www.tksgml.de/

El programa sgedit le permite editar visualmente ficheros SGML. Tiene la ventaja de que no necesitará conocer previamente ni Emacs ni VI , y además la ventaja de que es una aplicación de plataforma cruzada que funciona tanto con Windows como con Linux. Se trata de una aplicación comercial, pero aún no se ha establecido su precio. Habrá licencias gratuitas para uso privado y académico.

Además de la edición visual, sgedit también validará los documentos que se descarguen y que se soliciten mediante la orden Document->Validate.

La captura de pantalla del programa sgedit muestra
en la parte izquierda un árbol con el documento de SGML jerarquizado,
y en la derecha, el documento en sí. Las etiquetas se muestran con un
fondo gris.

Otros/Referencias

En esta sección se encuentran recogidos libros u otras utilidades que no se pueden clasificar fácilmente (por ahora).

DocBook: The Definitive Guide

http://www.docbook.org/

Este libro lo dio a conocer O'Reilly en octubre de 1999, y es una referencia importante para DocBook. Personalmente, no creo que sea un gran libro práctico, y pone mucho énfasis en XML, pero todas las etiquetas DocBook para la versión 3.1 se encuentran detalladas en un formato muy práctico. Puede conseguirlo en cualquier librería. El libro completo también se encuentra disponible online (en formato HTML y SGML ) así como en la URL citada.

Aspell

Opcional - http://aspell.sourceforge.net/

Este corrector ortográfico puede funcionar con etiquetas SGML, y únicamente corrije el contenido de esas etiquetas. Los correctores ortográficos por defecto como ispell intentarán corregir las etiquetas, provocando errores en cada nueva etiqueta.