- Se agrega una parte solo para la salida HTML del doxygen, con links a todos

[z.facultad/75.42/plaqui.git] / docs / mainpage.h

diff --git a/docs/mainpage.h b/docs/mainpage.h
index bab1e47bb5fe453def33eded1a6908382a468370..8f41a31cd047850aa559f7f233cbdffa0f8cacbf 100644 (file)
--- a/docs/mainpage.h
+++ b/docs/mainpage.h
@@ -1,5 +1,25 @@
 /** \mainpage Plaqui
 
+\htmlonly
+<h2>Archivos.</h2>
+       <h3>Manuales.</h3>
+               <p>A continuación se presenta una lista con los manuales.</p>
+               <ul>
+                       <li><a href="../../manual_proyecto.pdf">Manual del Proyecto</a>.</li>
+                       <li><a href="../devel/refman.pdf">Manual de Desarrollo</a>
+                           (versión imprimible de este manual).</li>
+                       <li><a href="../admin/refman.pdf">Manual de Administración</a>.</li>
+                       <li><a href="../../../Client/doc/manual.pdf">Manual de Usuario de
+                           PlaQui Client</a>.</li>
+                       <li><a href="../../../Constructor/doc/manual.pdf">Manual de Usuario
+                           de PlaQui Constructor</a>.</li>
+               </ul>
+
+       <h3>Archivos de ejemplo.</h3>
+               <p>Puede encontrar archivos de planta de ejemplo en el directorio
+               <a href="../../../Samples">Samples</a>.</p>
+\endhtmlonly
+
 \section introduccion Introducción.
 
        \subsection herramientas Herramientas Utilizadas.
@@ -15,6 +35,15 @@
                  [http://www.vim.org/]
                - Doxygen: Generador de documentación y referencias cruzadas.
                  [http://www.stack.nl/~dimitri/doxygen/]
+               - Subversion: Es un SCM (Source Code Manager) que permite trabajar
+                 con versiones concurrentes en un repositorio de código fuente de
+                 forma remota.
+                 [http://subversion.tigris.org/]
+               - LyX: Procesador de texto WYIWYM (What You See Is What You Mean)
+                 para hacer documentos técnicos fácilmente.
+                 [http://www.lyx.org/]
+               - Mailman: Manejador de listas de correo.
+                 [http://www.gnu.org/software/mailman/]
                - GNU Make.
                  [http://www.gnu.org/software/make/]
                - Automake.
@@ -57,15 +86,15 @@
 
 \section instalacion Instalación.
        El programa se divide en 4 módulos:
-       - Modelo: es el módulo que se encarga de la simulación y el modelo \c
-         físico de la planta (es una biblioteca).
+       - \ref page_model "Modelo": es el módulo que se encarga de la simulación y el modelo
+         \c físico de la planta (es una biblioteca).
        - \ref page_server "Servidor": es la infrastructura de red. Comprende tanto
          el servidor como el cliente en cuando al manejo de la red (es una
          biblioteca y un  programa).
-       - Cliente: es el cliente gráfico que permite ver la simulación (es un
+       - \ref page_client "Cliente": es el cliente gráfico que permite ver la simulación (es un
          programa).
-       - Constructor: es el programa para diseñar la planta química que será
-         simulada por el modelo en el servidor (es un programa).
+       - \ref page_constructor "Constructor": es el programa para diseñar la planta química
+         que será simulada por el modelo en el servidor (es un programa).
 
        La instalación puede realizarse de dos formas: instalando módulo por
        módulo o instalando todos los módulos a la vez.
@@ -81,7 +110,10 @@
                -# Configurar la compilación del proyecto (generalmente basta con):
                   \verbatim ./configure \endverbatim
                   Esto lo instala por defecto en <tt>/usr/local</tt>, se puede
-                  especificar otra ruta con la opcion <tt>--prefix</tt>.
+                  especificar otra ruta con la opcion <tt>--prefix</tt>. También se
+                  puede compilar en modo de depuración con la opción
+                  <tt>--enable-debug</tt>. Para más opciones hacer
+                  <tt>./configure --help</tt>.
                -# Compilar el proyecto:
                   \verbatim make \endverbatim
                -# Instalar el proyecto:
@@ -114,7 +146,7 @@
 
        \subsection mainpage_server_uso_inicio Inicio del servidor.
                Para iniciar el servidor es necesario disponer de un archivo XML de
-               planta (por ejemplo, generado por el Constructor).
+               planta (por ejemplo, generado por el \ref page_constructor "Constructor").
 
                Invocación del servidor:
                \verbatim ./plaqui-server [archivo] [puerto] \endverbatim
@@ -145,7 +177,7 @@
                se detecta un error.
 
                Otro tipo de información del estado del servidor puede ser obtenida desde
-               el cliente a través del comando <tt>/server/info</tt>.
+               el \ref page_client "cliente" a través del comando <tt>/server/info</tt>.
 
                \note Los errores se imprimen en la salida de error, no en la salida
                      estándar.
@@ -157,7 +189,8 @@
                - Enviando una señal de salida (<tt>SIGQUIT</tt>) o de terminación
                  (<tt>SIGTERM</tt>), por ejemplo, a través del comando
                  <tt>kill(1)</tt>.
-               - Enviando un comando <tt>/server/stop</tt> desde un cliente.
+               - Enviando un comando <tt>/server/stop</tt> desde un
+                 \ref page_client "cliente".
 
                Cualquiera de estos métodos es válido y finaliza el servidor de forma
                correcta.