* Se agrega el TIP de luca

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

diff --git a/docs/mainpage.h b/docs/mainpage.h
index 4a4b903cdd021a9892c5a15cce18f3704855d3e5..1a82f031f47bb9ae4e3f803fd013d14574a4798b 100644 (file)
--- a/docs/mainpage.h
+++ b/docs/mainpage.h
@@ -1,9 +1,9 @@
 /** \mainpage Plaqui
 
 /** \mainpage Plaqui
 

-\section introduccion Introducción
+\section introduccion Introducción

 
        \subsection herramientas Herramientas Utilizadas
 
        \subsection herramientas Herramientas Utilizadas

-               Aquí tenemos un listado de las herramientas y bibliotecas que estamos
+               Aquí tenemos un listado de las herramientas y bibliotecas que estamos

                utilizando a fin de poder luego documentar de manera correcta los
                requerimientos para instalar y ejecutar el programa, las versiones y los
                programas utilizados durante el desarrollo.
                utilizando a fin de poder luego documentar de manera correcta los
                requerimientos para instalar y ejecutar el programa, las versiones y los
                programas utilizados durante el desarrollo.


@@ -13,7 +13,7 @@
                  [http://gcc.gnu.org/]
                - VIM: Editor de texto utilizado para programar.
                  [http://www.vim.org/]
                  [http://gcc.gnu.org/]
                - VIM: Editor de texto utilizado para programar.
                  [http://www.vim.org/]

-               - Doxygen: Generador de documentación y referencias cruzadas.
+               - Doxygen: Generador de documentación y referencias cruzadas.

                  [http://www.stack.nl/~dimitri/doxygen/]
                - GNU Make.
                  [http://www.gnu.org/software/make/]
                  [http://www.stack.nl/~dimitri/doxygen/]
                - GNU Make.
                  [http://www.gnu.org/software/make/]


@@ -27,78 +27,125 @@
                  [http://www.gtkmm.org/]
                - Glademm ( >= 2.0.0): Para cargar archivos XML con la UI
                  [http://www.gtkmm.org/]
                  [http://www.gtkmm.org/]
                - Glademm ( >= 2.0.0): Para cargar archivos XML con la UI
                  [http://www.gtkmm.org/]

-               - Glibmm ( >= 2.0.0): Funciones de threads y otras básicas.
+               - Glibmm ( >= 2.0.0): Funciones de threads y otras básicas.

                  [http://www.gtkmm.org/]
                  [http://www.gtkmm.org/]

-               - sigc++ ( >= 1.2.5): Sistema de señales para C++
+               - sigc++ ( >= 1.2.5): Sistema de señales para C++

                  [http://libsigc.sourceforge.net/]
                  [http://libsigc.sourceforge.net/]

+               - libxml2 ( >= 0.15.0): Parser de XML.
+                 [http://xmlsoft.org/]
+               - libxm++ ( >= 0.15.0): Wrapper de libxml2 para C++.
+                 [http://libxmlplusplus.sourceforge.net/]

                - socket++ ( >= 1.12.10): Wrapper de socket portables en C++ streams
                  [http://members.aon.at/hstraub/linux/socket++/]
 
                - socket++ ( >= 1.12.10): Wrapper de socket portables en C++ streams
                  [http://members.aon.at/hstraub/linux/socket++/]
 

-       \subsection requerimientos Requerimientos de Hardware y SO.
+       \subsection requerimientos Requerimientos de Hardware y SO

                PlaQui fue desarrollado bajo Debian GNU/Linux sid (http://www.debian.org/),
                PlaQui fue desarrollado bajo Debian GNU/Linux sid (http://www.debian.org/),

-               pero debería andar en cualquier GNU/Linux e incluso probablemente en otros
-               Unixes (e incluso podría llegar a andar en WIN32). La versión para el
-               usuario (binaria y sin símbolos para depurar) requiere menos de 2MB de
-               espacio en disco. Para compilarlo (con símbolos para depurar) puede
-               necesitar más de 80MB.
-
-               \subsubsection requerimientos_minimos Requerimientos mínimos
-                       Esta es la mínima configuración en la que fue probado.
+               pero debería andar en cualquier GNU/Linux e incluso probablemente en otros
+               Unixes (e incluso podría llegar a andar en WIN32). La versión para el
+               usuario (binaria y sin símbolos para depurar) requiere menos de 2MB de
+               espacio en disco. Para compilarlo (con símbolos para depurar) puede
+               necesitar más de 80MB.
+
+               \subsubsection requerimientos_minimos Requerimientos mínimos
+                       Esta es la mínima configuración en la que fue probado.

                        - Procesador: Pentium 75MHz
                        - Procesador: Pentium 75MHz

-                       - Memoria RAM (física y virtual): 32MB
+                       - Memoria RAM (física y virtual): 32MB

 
                \subsubsection requerimientos_recomendados Requerimientos recomendados
                        - Procesador: PII 400 Mhz
                        - Memoria RAM: 64 MB
 
 
                \subsubsection requerimientos_recomendados Requerimientos recomendados
                        - Procesador: PII 400 Mhz
                        - Memoria RAM: 64 MB
 

-       \subsection 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_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
-         programa).
-       - 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.
-
-               \subsubsection instalacion_global Instalación Global
-               Para instalar todos los programas es sencillo.
-               -# Descomprimir el paquete:
-                  \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
-               -# Entrar al directorio del proyecto:
-                  \verbatim cd plaqui \endverbatim
-               -# Inicializar el proyecto:
-                  \verbatim aclocal && autoconf && automake -a \endverbatim
-               -# Configurar la compilación del proyecto (generalmente basta con):
-                  \verbatim ./configure \endverbatim
-                  Esto lo instala por defecto en /usr/local, se puede
-                  especificar otra ruta con la opcion \c --prefix
-               -# Compilar el proyecto:
-                  \verbatim make \endverbatim
-               -# Instalar el proyecto:
-                  \verbatim make install \endverbatim
-
-               \subsubsection instalacion_global Instalación Por Partes
-               El procedimiento es muy similar al anterior:
-               -# Descomprimir el paquete:
-                  \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
-               -# Entrar al directorio del módulo [Módulo]:
-                  \verbatim cd plaqui/[Módulo] \endverbatim
-               -# Inicializar el módulo:
-                  \verbatim aclocal && autoconf && automake -a \endverbatim
-               -# Configurar la compilación del módulo (generalmente basta con):
-                  \verbatim ./configure \endverbatim
-               -# Compilar el módulo:
-                  \verbatim make \endverbatim
-               -# Instalar el módulo:
-                  \verbatim make install \endverbatim
+       \subsection 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_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
+                 programa).
+               - 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.
+
+               \subsubsection instalacion_global Instalación Global
+                       Para instalar todos los programas es sencillo.
+                       -# Descomprimir el paquete:
+                          \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
+                       -# Entrar al directorio del proyecto:
+                          \verbatim cd plaqui \endverbatim
+                       -# Inicializar el proyecto:
+                          \verbatim aclocal && autoconf && automake -a \endverbatim
+                       -# 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>.
+                       -# Compilar el proyecto:
+                          \verbatim make \endverbatim
+                       -# Instalar el proyecto:
+                          \verbatim make install \endverbatim
+
+                       \note Para realizar el último paso, dependiendo de si usó la
+                             opción <tt>--prefix</tt> o no, es posible que necesite
+                             permisos de superusuario (<tt>root</tt>).
+
+               \subsubsection instalacion_por_partes Instalación Por Partes
+                       El procedimiento es muy similar al anterior:
+                       -# Descomprimir el paquete:
+                          \verbatim tar -xvzf plaqui-proyect.tar.gz \endverbatim
+                       -# Entrar al directorio del módulo [Módulo]:
+                          \verbatim cd plaqui/[Módulo] \endverbatim
+                       -# Inicializar el módulo:
+                          \verbatim aclocal && autoconf && automake -a \endverbatim
+                       -# Configurar la compilación del módulo (generalmente basta con):
+                          \verbatim ./configure \endverbatim
+                       -# Compilar el módulo:
+                          \verbatim make \endverbatim
+                       -# Instalar el módulo:
+                          \verbatim make install \endverbatim
+
+                       \note Para realizar el último paso, dependiendo de si usó la
+                             opción <tt>--prefix</tt> o no, es posible que necesite
+                             permisos de superusuario (<tt>root</tt>).

 
 \section mainpage_servidor Servidor
 
 \section mainpage_servidor Servidor

-       Puede ver la documentación del servidor en \ref page_server
+       Puede ver la documentación del servidor en \ref page_server
+\section mainpage_constructor Constructor
+       \subsection constructor_formato_xml Formato del archivo
+       El archivo que guarda el Constructor es un archvo de texto con formato XML.
+       Cada elemento posee su propia forma de guardarse en el archivo.
+       - Tubo
+               \verbinclude tubo.xml
+       - Codo
+               \verbinclude codo.xml
+       - Empalme
+               \verinclude empalme.xml
+       - Bomba
+               \verbinclude bomba.xml
+       - Tanque
+               \verbinclude tanque.xml
+       - Exclusa
+               \verbinclude exclusa.xml
+       - Drenaje
+               \verbinclude drenaje.xml
+       - And
+               \verbinclude and.xml
+       - Or
+               \verbinclude or.xml
+       - Not
+               \verbinclude not.xml
+       
+*/
+
+/** \namespace PlaQui
+
+Diseñador, simulador y controlador de plantas químicas distribuido.
+
+El Programa se divide en 4 módulos. Los módulo que se comportan como
+biblioteca compartida tienen a su vez un espacio de nombres (namespace)
+anidado: PlaQui::Model y PlaQui::Server.

 
 */
 
 */

+