Capítulo 5. Mejorando la presentación y organización del documento

Tabla de contenidos

1. Dividiendo el documento
2. Automatización
3. Acerca del estilo
4. ¿Donde ir por más?

A lo largo de este capítulo presentaremos maneras en las cuales podremos mejorar a nuestro documento de forma óptima en diversos aspectos, como la presentación y modularización.

1. Dividiendo el documento

Cuando el documento adquiere un tamaño considerable es usual querer distribuir el texto que contiene a lo largo de diversos archivos distintos. En nuestro caso dividiremos a nuestro documento en cuatro archivos distintos, herramientas.sgml que contendrá la metainformación del documento, docbook.sgml y emacs.sgml que contendrán los capítulos 1 y 2 respectivamente y apéndices.sgml que contendrá los apéndices.

A continuación mostramos el listado de herramientas.sgml



<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "docbookx.dtd" [
<!ENTITY genindice.xml SYSTEM "genindice.xml">
<!ENTITY docbook.xml SYSTEM "docbook.xml">
<!ENTITY emacs.xml SYSTEM "emacs.xml">
<!ENTITY apendices.xml SYSTEM "apendices.xml">
]>
<book lang="es" id="doc-emacs">
  <bookinfo>
    <date>17 de Junio de 2001</date>
    <title><acronym>DocBook</acronym> y
    <application>emacs</application></title>
    <subtitle>Una guía básica</subtitle>
    <releaseinfo>Documentación en progreso</releaseinfo>
    <authorgroup>
      <author>
	<firstname>Jaime Irving</firstname>
	<surname>Dávila</surname>
      </author>
    </authorgroup>
    <address>jadavila@uniandes.edu.co</address>
    <legalnotice>
      <para>El siguiente documento se cede al dominio público</para>
    </legalnotice>
    <revhistory>
      <revision>
	<revnumber>1.0</revnumber>
	<date>16-06-2001</date>
	<authorinitials>jid</authorinitials>
	<revremark>Creación del documento inicial</revremark>
      </revision>
      <revision>
	<revnumber>1.1</revnumber>
	<date>17-06-2001</date>
	<authorinitials>jid</authorinitials>
	<revremark>Inclusión del encabezado del documento</revremark>
      </revision>
      <revision>
	<revnumber>1.2</revnumber>
	<date>23-09-2001</date>
	<authorinitials>jid</authorinitials>
	<revremark>Corrección de legalnotice y jpg's</revremark>
      </revision>
      <revision>
	<revnumber>1.3</revnumber>
	<date>14-04-2002</date>
	<revremark>Inclusión de listados de programas, faq y
	marquillas de importancia</revremark>
      </revision>
      <revision>
	<revnumber>1.4</revnumber>
	<date>15-04-2002</date>
	<revremark>Partición en varios documentos</revremark>
      </revision>
    </revhistory>
  </bookinfo>
&docbook.xml;
&emacs.xml;
&apendices.xml;
&genindice.xml;
</book>


Notemos que el procedimiento es en general definir entidades por cada uno de los archivos a incluir a través de <!ENTITY ..> y luego incluir el contenido de dichas entidades en la estructura del documento, a través de un comando como &arch.sgml;

Sugerencia

Es útil decir en los archivos que se dividió el documento (en este caso docbook.sgml, emacs.sgml y apendices.sgml) cuál es el documento principal al que pertenecen (en este caso herramientas.sgml). Esto se hace a través de un comentario al final del documento del siguiente estilo

<!-- Local Variables: -->
<!-- sgml-parent-document: "herramientas.sgml" -->
<!-- End: -->

Incluir dichas línes permite que el modo PSGML de emacs funcione correctamente.