]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blobdiff - Client/doc/manual.lyx
Se completa un poco mas el manual del proyecto.
[z.facultad/75.42/plaqui.git] / Client / doc / manual.lyx
index be225b4a73372ffc1a03262b4a0b062462c042cb..93328f41bf20f5135d31dd67358537784385e255 100644 (file)
@@ -1,6 +1,17 @@
 #LyX 1.3 created this file. For more info see http://www.lyx.org/
 \lyxformat 221
 \textclass book
+\begin_preamble
+\usepackage{graphicx}
+\newcommand{\myLogo}[2]{%
+\setlength{\unitlength}{1cm}
+\begin{picture}(0,0)
+\put(-8,+8.5){#1}% the logo for the left side
+%\put(8,+8.5){#1}% the logo for the right side
+\put(-7,9){\parbox[b]{5cm}{\Large \centering #2}}
+%\put(3,9){\parbox[b]{5cm}{\Large \centering #2}}% text for the rightside
+\end{picture}}
+\end_preamble
 \language spanish
 \inputencoding auto
 \fontscheme palatino
 \quotes_times 2
 \papercolumns 1
 \papersides 2
-\paperpagestyle default
+\paperpagestyle headings
 
 \layout Title
 
 PlaQui Client
 \newline 
 Manual de Usuario
-\layout Author
-
-Nicolás Dimov
 \newline 
-Leandro Lucarella
+\SpecialChar ~
+
 \newline 
-Ricardo Markiewicz
+\begin_inset Graphics
+       filename ../pixmaps/logo.png
+       width 8cm
+
+\end_inset 
+
+
+\layout Date
+
+Versión 1.0
 \layout Standard
 
 
@@ -55,7 +74,7 @@ PlaQui es un conjunto de aplicaciones para dise
 \layout Standard
 
 PlaQui Client es la aplicación para controlar y visualizar una planta química.
- Con este programa se puede ver la evolucion en el tiempo de la planta y
+ Con este programa se puede ver la evolución en el tiempo de la planta y
  controlar los elemento que tengan alguna entrada.
 \layout Section
 
@@ -89,7 +108,7 @@ Una vez abierta la aplicaci
 
 \begin_inset Float figure
 wide false
-collapsed false
+collapsed true
 
 \layout Caption
 
@@ -98,9 +117,9 @@ collapsed false
 
 \end_inset 
 
-Ventana principal de PlaQui Client
+Ventana principal de PlaQui Client.
 \layout Standard
-
+\align center 
 
 \begin_inset Graphics
        filename principal.png
@@ -133,49 +152,56 @@ Archivo
 .
 \layout Standard
 
-En este menú se encuentran todos los comandos generales de la aplicacion.
-\layout Description
+En este menú se encuentran todos los comandos generales de la aplicación.
+\layout Standard
 
 
 \begin_inset Graphics
-       filename conectar.png
+       filename conectar_m.png
+       lyxscale 80
+       scale 50
 
 \end_inset 
 
-Conectar Abre una ventana de dialogo para conectarse al servidor.
-\layout Description
-
 
-\begin_inset Graphics
-       filename desconectar.png
-
-\end_inset 
+\family sans 
+ Conectar
+\layout Standard
 
-Desconectar Cierra la conexion con el servidor.
-\layout Description
+Abre una ventana de diálogo para conectarse al servidor.
+\layout Standard
 
 
 \begin_inset Graphics
-       filename finalizar_servidor.png
+       filename desconectar_m.png
+       lyxscale 80
+       scale 50
 
 \end_inset 
 
-Finalizar\SpecialChar ~
-Servidor Termina el servidor.
- Debe tener cuidado al utilizar esta opcion porque si hay mas de un cliente
- conectado, estos clientes se desconectaran.
-\layout Description
+
+\family sans 
+ Desconectar
+\layout Standard
+
+Cierra la conexión con el servidor.
+\layout Standard
 
 
 \begin_inset Graphics
        filename quit.png
-       lyxscale 80
-       scale 80
+       lyxscale 70
+       scale 40
        keepAspectRatio
 
 \end_inset 
 
-Salir Sale del programa.
+
+\family sans 
+ Salir
+\layout Standard
+
+Sale del programa.
 \layout Paragraph
 
 Menú 
@@ -187,16 +213,50 @@ Ver
 
 En este menú se encuentran los comandos para modificar la forma de visualizar
  la planta.
-\layout Description
+\layout Standard
 
 
 \begin_inset Graphics
        filename properties.png
+       lyxscale 70
+       scale 40
 
 \end_inset 
 
-Propiedades Abre una ventana de dialogo para modificar las propiedades de
- la planta.
+
+\family sans 
+ Propiedades
+\layout Standard
+
+Abre una ventana de diálogo para modificar las propiedades de la planta.
+\layout Paragraph
+
+Menú 
+\family sans 
+Ver
+\family default 
+.
+\layout Standard
+
+En este menú se encuentran los comandos para controlar el servidor.
+\layout Standard
+
+
+\begin_inset Graphics
+       filename detener_servidor.png
+       lyxscale 70
+       scale 40
+
+\end_inset 
+
+
+\family sans 
+ Detener Servidor
+\layout Standard
+
+Detiene el servidor.
+ Debe tener cuidado al utilizar esta opcion porque cierra el servidor inmediatam
+ente, si hay otros clientes serán desconectados.
 \layout Paragraph
 
 Menú 
@@ -215,56 +275,113 @@ Acerca Obtiene informaci
 Barra de herramientas.
 \layout Standard
 
-La barra de herramientas se encuentra debajo de la 
-\family sans 
-Barra de menú
-\family default 
-.
- Tiene los comandos mas usados.
-\layout Standard
+La barra de herramientas
+\begin_inset Float figure
+wide false
+collapsed false
+
+\layout Caption
 
 
+\begin_inset LatexCommand \label{cap:Barra-de-herramientas.}
+
+\end_inset 
+
+Barra de herramientas.
+\layout Standard
+\align center 
+
 \begin_inset Graphics
        filename barra_herramientas.png
+       width 11cm
 
 \end_inset 
 
 
-\layout Standard
+\end_inset 
 
-En la parte inferior se encuentran herramientas adicionales útiles a la
- hora de trabajar con la planta.
-\layout Description
+ se encuentra debajo de la 
+\family sans 
+Barra de menú
+\family default 
+ (ver figura 
+\begin_inset LatexCommand \ref{sub:Empezar-la-simulacion.}
+
+\end_inset 
+
+).
+ Tiene los comandos mas frecuentemente utilizados.
+\layout Standard
 
 
 \begin_inset Graphics
        filename conectar.png
+       lyxscale 40
+       scale 20
 
 \end_inset 
 
-Conectar Se conecta a un servidor.
-\layout Description
+
+\family sans 
+ Conectar
+\layout Standard
+
+Se conecta a un servidor.
+\layout Standard
 
 
 \begin_inset Graphics
        filename simular.png
+       lyxscale 40
+       scale 20
 
 \end_inset 
 
-Simular Comienza o reanuda la simulación del servidor.
-\layout Description
+
+\family sans 
+ Simular
+\layout Standard
+
+Comienza o reanuda la simulación del servidor.
+\layout Standard
 
 
 \begin_inset Graphics
        filename pausar.png
+       lyxscale 40
+       scale 20
 
 \end_inset 
 
-Pausar Detiene momentáneamente la simulación del servidor.
+
+\family sans 
+ Pausar
+\layout Standard
+
+Detiene momentáneamente la simulación del servidor.
 \layout Standard
 
-En el extremo derecho de la barra hay un indicador de conexión que informa
- si el cliente esta conectado (verde) o desconectado (rojo).
+En el extremo derecho de la barra hay un 
+\family sans 
+Indicador de conexión
+\family default 
+ que informa si el cliente esta conectado 
+\begin_inset Graphics
+       filename conectar_m.png
+       lyxscale 80
+       scale 50
+
+\end_inset 
+
+ o desconectado 
+\begin_inset Graphics
+       filename desconectar_m.png
+       lyxscale 80
+       scale 50
+
+\end_inset 
+
+.
 \layout Subsubsection
 
 Barra de información.
@@ -273,11 +390,37 @@ Barra de informaci
 Es la barra que se encuentra a la derecha de la ventana principal y esta
  dividida en dos.
  En la parte superior se indica el estado del elemento seleccionado actualmente,
- en la parte inferior se informa sobre el estado de la conexión y las respuestas
- del servidor.
-\layout Comment
+ en la parte inferior se encuentra una animación que indica si se están
+ recibiendo datos del servidor.
+ Si la animación esta detenida pueden haber pasado 3 cosas:
+\layout Itemize
+
+Pudo haberse perdido la conexión con el servidor.
+ En este caso el 
+\family sans 
+Indicador de conexión
+\family default 
+ estará en rojo.
+\layout Itemize
+
+La simulación puede estar pausada.
+ Pruebe presionando el icono para 
+\family sans 
+Simular
+\family default 
+.
+\layout Itemize
+
+Puede haber un problema de red, por el cual no está llegando el estado de
+ la planta.
+\layout Subsubsection
 
-Actualizar cuando cambie.
+Barra de estado.
+\layout Standard
+
+Es el área de texto que se encuentra en la parte inferior de la ventana
+ principal.
+ Informa sobre el estado de la conexión y las respuestas del servidor.
 \layout Subsubsection
 
 Área de visualización.
@@ -300,6 +443,8 @@ Conectar
  o presionando sobre el icono 
 \begin_inset Graphics
        filename conectar.png
+       lyxscale 40
+       scale 20
 
 \end_inset 
 
@@ -308,8 +453,37 @@ Conectar
 Barra de herramientas
 \family default 
 .
- En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
- el 
+ En ambos casos se abrirá una ventana de diálogo
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Ventana-de-diálogo}
+
+\end_inset 
+
+Ventana de diálogo para conectarse al servidor.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+       filename dialogo_conectar.png
+       width 5cm
+
+\end_inset 
+
+
+\end_inset 
+
+ (figura 
+\begin_inset LatexCommand \vref{cap:Ventana-de-diálogo}
+
+\end_inset 
+
+) en la que puede seleccionar el 
 \emph on 
 host
 \emph default 
@@ -326,13 +500,13 @@ Aceptar
 .
 \layout Standard
 
-Si la conexión fue exitosa vera que el indicador de conexión de la 
+Si la conexión fue exitosa verá que el indicador de conexión de la 
 \family sans 
 Barra de herramientas
 \family default 
  se pondrá verde y aparecerá un mensaje en la 
 \family sans 
-Barra de información
+Barra de estado
 \family default 
 .
 \layout Subsection
@@ -340,7 +514,7 @@ Barra de informaci
 Terminar la conexión.
 \layout Standard
 
-Para finalizar la conexión debe seleccionar la opcion del menú 
+Para finalizar la conexión debe seleccionar la opción del menú 
 \family sans 
 Archivo\SpecialChar \menuseparator
 Desconectar
@@ -368,7 +542,44 @@ Simular
 Barra de Herramientas
 \family default 
 .
- A partir de ahora vera que la planta empieza a evolucionar en el tiempo.
+ A partir de ahora verá que la planta empieza a evolucionar en el tiempo.
+ La animación
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Simulación-en-curso.}
+
+\end_inset 
+
+Simulación en curso.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+       filename simulando.png
+       lyxscale 50
+       width 14.7cm
+
+\end_inset 
+
+
+\end_inset 
+
+ de la 
+\family sans 
+Barra de Información
+\family default 
+ le servirá para saber que la planta está en funcionamiento.
+ En la figura 
+\begin_inset LatexCommand \ref{cap:Simulación-en-curso.}
+
+\end_inset 
+
+ puede ver un ejemplo.
 \layout Subsection
 
 Pausar la simulación.
@@ -383,8 +594,44 @@ Pausar
 Barra de Herramientas
 \family default 
 .
- A partir de ahora vera que la planta se queda en el estado actual y no
- cambia en el tiempo.
+ A partir de ahora verá que la planta se queda en el estado actual y no
+ cambia en el tiempo
+\begin_inset Float figure
+wide false
+collapsed true
+
+\layout Caption
+
+
+\begin_inset LatexCommand \label{cap:Simulación-en-pausa.}
+
+\end_inset 
+
+Simulación en pausa.
+\layout Standard
+\align center 
+
+\begin_inset Graphics
+       filename conectado_pausa.png
+       lyxscale 50
+       width 14.7cm
+
+\end_inset 
+
+
+\end_inset 
+
+ como se ve en la figura 
+\begin_inset LatexCommand \ref{cap:Simulación-en-pausa.}
+
+\end_inset 
+
+.
+ La animación de la 
+\family sans 
+Barra de Información
+\family default 
+ se detendrá también.
 \layout Subsection
 
 Reanudar la simulación.
@@ -408,9 +655,9 @@ Ver\SpecialChar \menuseparator
 Propiedades
 \family default 
 .
- Se abrirá una ventana de dialogo en donde puede elegir la velocidad de
+ Se abrirá una ventana de diálogo en donde puede elegir la velocidad de
  la simulación (o tiempo de refresco).
- Puede ingresar en el campo la cantidad de veces por segundo que cambiara
+ Puede ingresar en el campo la cantidad de veces por segundo que cambiará
  de estado la planta y luego presionar 
 \family sans 
 Aceptar
@@ -464,7 +711,7 @@ Para ver el estado detallado de un elemento primero debe seleccionarlo en
 \family sans 
 Área de trabajo
 \family default 
- haciendo click sobre el.
+ haciendo click sobre él.
  En la parte de 
 \family sans 
 Propiedades
@@ -479,7 +726,7 @@ Barra de informaci
 Propiedades.
 \layout Standard
 
-Las propiedades de los elementos mostradas son las siguientes (entre parentesis
+Las propiedades de los elementos mostradas son las siguientes (entre paréntesis
  se indica que elementos tienen dicha propiedad):
 \layout Description
 
@@ -511,7 +758,7 @@ Para modificar el estado un elemento primero debe seleccionarlo en el
 \family sans 
 Área de trabajo
 \family default 
- haciendo click sobre el.
+ haciendo click sobre él.
  En la parte inferior de 
 \family sans 
 Propiedades