no se me ocurre que mas poner, igual hay que mejorar las imagenes, mas que nada achic...

[z.facultad/75.42/plaqui.git] / Constructor / doc / manual.lyx

diff --git a/Constructor/doc/manual.lyx b/Constructor/doc/manual.lyx
index dd16a61c0670811fc21c1a5459c6aaafb5ecd280..f9050323a7cc3fc3fb6403dc6001cbfc3bc4e1cb 100644 (file)
--- a/Constructor/doc/manual.lyx
+++ b/Constructor/doc/manual.lyx
@@ -104,7 +104,7 @@ Ventana principal de PlaQui Constructor
 
 
 \begin_inset Graphics
 
 
 \begin_inset Graphics

-       filename /home/luca/facultad/75.42/2003-2/final/Constructor/doc/manual_ventana_principal.png
+       filename /home/nico/plaqui/Constructor/doc/principal.png

        lyxscale 50
        width 14.7cm
        keepAspectRatio
        lyxscale 50
        width 14.7cm
        keepAspectRatio


@@ -125,9 +125,6 @@ Barra de men
 
 En la barra de menú se encuentra en la parte superior de la ventana y en
  ella están todas los comandos para trabajar con el programa.
 
 En la barra de menú se encuentra en la parte superior de la ventana y en
  ella están todas los comandos para trabajar con el programa.

-\layout Comment
-
-En cada ítem de cada menú se podría agregar un ícono.

 \layout Paragraph
 
 Menú 
 \layout Paragraph
 
 Menú 


@@ -141,17 +138,41 @@ En este men
  del programa.
 \layout Description
 
  del programa.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/new.png
+
+\end_inset 
+

 Nuevo Empieza a construir una planta nueva.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Description
 
 Nuevo Empieza a construir una planta nueva.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/open.png
+
+\end_inset 
+

 Abrir Abre una planta nueva.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Description
 
 Abrir Abre una planta nueva.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/save.png
+
+\end_inset 
+

 Guardar Guarda la planta actual.
 \layout Description
 
 Guardar Guarda la planta actual.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/quit.png
+
+\end_inset 
+

 Salir Sale del programa.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Paragraph
 Salir Sale del programa.
  La planta con la que estaba trabajando actualmente será descartada.
 \layout Paragraph


@@ -167,9 +188,21 @@ En este men
  de la planta.
 \layout Description
 
  de la planta.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/delete.png
+
+\end_inset 
+

 Borrar Borra el elemento seleccionado actualmente.
 \layout Description
 
 Borrar Borra el elemento seleccionado actualmente.
 \layout Description
 

+
+\begin_inset Graphics
+       filename /home/nico/plaqui/Constructor/doc/clear.png
+
+\end_inset 
+

 Borrar\SpecialChar ~
 Todo Borra todos los elementos de la planta.
  Es equivalente a 
 Borrar\SpecialChar ~
 Todo Borra todos los elementos de la planta.
  Es equivalente a 


@@ -196,22 +229,61 @@ Acerca Obtiene informaci
 Barra de herramientas.
 \layout Standard
 
 Barra de herramientas.
 \layout Standard
 

+
+\begin_inset Graphics
+       filename barra_herramientas.png
+
+\end_inset 
+
+
+\layout Standard
+

 En la barra de herramientas se encuentra debajo de la 
 \family sans 
 Barra de menú
 \family default 
  y está dividida en dos.
 En la barra de herramientas se encuentra debajo de la 
 \family sans 
 Barra de menú
 \family default 
  y está dividida en dos.

- En la parte superior se encuentran íconos para ejecutar los comandos (de
- la barra de menú) más comunes del programa, como empezar una planta nueva,
+ En la parte superior se encuentran íconos para ejecutar los comandos (del
+ menú principal) más comunes del programa, como empezar una planta nueva,

  guardar la planta actual y abrir una planta existente.
 \layout Standard
 
 En la parte inferior se encuentran herramientas adicionales útiles a la
  hora de trabajar con la planta.
  guardar la planta actual y abrir una planta existente.
 \layout Standard
 
 En la parte inferior se encuentran herramientas adicionales útiles a la
  hora de trabajar con la planta.

-\layout Comment
+\layout Standard
+
+
+\series bold 
+Verificar Conexionado 
+\series default 
+Verifica que todos los elementos estén conectados, y formen un circuito
+ de manera que pudierda fluir un líquido.
+\layout Standard
+
+
+\series bold 
+Lista
+\series default 
+ Ubicada en la segunda posición de la barra, indica cuál fué el último elemento
+ seleccionado mediante un click del mouse, y almacena todos los nombres
+ de los elementos que fueron seleccionados.
+\layout Standard
+
+
+\series bold 
+Buscar
+\series default 
+ Marca con un recuadro negro el elemento seleccionado (el que aparece en
+ la lista).
+\layout Standard
+
+
+\begin_inset Graphics
+       filename buscar.png
+
+\end_inset 
+

 
 

-Describir mínimamente para qué sirve cada uno de los elementos como en la
- parte de arriba.

 \layout Subsubsection
 
 Barra de elementos de planta.
 \layout Subsubsection
 
 Barra de elementos de planta.


@@ -228,6 +300,7 @@ Barra de compuertas l
 En la barra de íconos que se encuentra a la derecha.
  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
 to dinámico de la planta.
 En la barra de íconos que se encuentra a la derecha.
  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
 to dinámico de la planta.

+ Las compuertas son AND, OR y NOT.

 \layout Subsubsection
 
 Barra de estado.
 \layout Subsubsection
 
 Barra de estado.


@@ -243,6 +316,13 @@ na informaci
 
 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
  de una planta para su diseño.
 
 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
  de una planta para su diseño.

+\layout Comment
+
+ACA ESTARIA BUENO PONER UNA IMAGEN DE TODA LA PANTALLA INDICANDO QUE ES
+ CADA COSA
+\layout Comment
+
+( DENTRO DE LA MISMA IMAGEN)

 \layout Section
 
 Guardar y recuperar el trabajo.
 \layout Section
 
 Guardar y recuperar el trabajo.


@@ -269,29 +349,66 @@ Aceptar
 \family default 
 .
  La planta aparecerá en la ventana principal.
 \family default 
 .
  La planta aparecerá en la ventana principal.

-\layout Comment
+\layout Subsection
+
+Guardar un archivo de planta.
+\layout Standard
+
+De manera similar a la carga o apertura de una planta, se puede guardar
+ o salvar la misma.
+ Para esto también hay dos formas distintas:
+\family sans 
+ Archivo\SpecialChar \menuseparator
+Salvar
+\family default 
+ o presionando sobre el ícono 
+\family sans 
+Salvar
+\family default 
+ de la barra de herramientas.
+\layout Standard
+
+La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona
+r la ubicación donde desee guardarse, luego al presionar el botón en la
+ barra de herramientas que realiza esta acción, se sobreescribirá el archivo.
+\layout Standard
+
+Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre
+ estará disponible la primera opción, que en todos los casos mostrará el
+ diálogo correspondiente.
+\layout Standard

 
 

-En vez de poner 
+Para poder guardar un archivo de planta, esta debe estar correctamente conectada
+, esto puede verificarse presionando el botón de la barra de herramientas
+ 

 \begin_inset Quotes eld
 \end_inset 
 
 \begin_inset Quotes eld
 \end_inset 
 

-ícono Abrir
+Verificar Conexionado

 \begin_inset Quotes erd
 \end_inset 
 
 \begin_inset Quotes erd
 \end_inset 
 

- se podría poner una imágen bonita :)
-\layout Subsection
-
-Guardar un archivo de planta.
-\layout Comment
-
-Idem anterior.
+ el cual desplegará un diálogo de error, indicamdo cual es el elemento que
+ no verifica, si no se cumple la condición o un diálogo de éxito si todo
+ es correcto.

 \layout Subsection
 
 Empezar una planta nueva.
 \layout Subsection
 
 Empezar una planta nueva.

-\layout Comment
+\layout Standard

 
 

-Idem anterior.
+Para comenzar a editar una planta nueva debe presionarse el botón en el
+ menú principal 
+\family sans 
+Archivo\SpecialChar \menuseparator
+Nuevo 
+\family default 
+o directamente desde el acceso rápido en la barra de herramientas presionando
+ el botón con el mismo ícono, que se encuentra en la primera posición.
+\layout Standard
+
+Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo,
+ volverá a aparecer el diálogo para seleccionar la ubicación y nombre del
+ archivo por primera vez.

 \layout Section
 
 Salir del programa.
 \layout Section
 
 Salir del programa.


@@ -326,9 +443,6 @@ A continuaci
 \layout Section
 
 Diseño Físico de la planta.
 \layout Section
 
 Diseño Físico de la planta.

-\layout Comment
-
-Mencionar el botón de verificar conexionado.

 \layout Subsection
 
 Agregar un elemento.
 \layout Subsection
 
 Agregar un elemento.


@@ -384,12 +498,63 @@ Para modificar las propiedades de un elemento puede hacer doble-click sobre
 Nombre Nombre del elemento.
  Este nombre se utiliza para identificar este elemento para poder controlarlo
  desde la aplicación de control.
 Nombre Nombre del elemento.
  Este nombre se utiliza para identificar este elemento para poder controlarlo
  desde la aplicación de control.

-\layout Comment
+\layout Description

 
 

-Poner las otras propiedades que pueden modificarse.
-\layout Comment
+La ventana de propiedades del tubo, el codo, el drenaje y el empalme son
+ practicamente iguales, a este último elemento se le agrega la opción de
+ seleccionar si es una unión o una división, y el drenaje solo posee la
+ propiedad Nombre.
+\layout Description
+
+
+\begin_inset Graphics
+       filename tubo_props.png

 
 

-Poner screenshots???
+\end_inset 
+
+
+\begin_inset Graphics
+       filename empalme_props.png
+
+\end_inset 
+
+
+\layout Description
+
+Para la bomba y el tanque aparecerán ventanas similares, pero estos elementos
+ tienen la capacidad de definir, además del nombre, el color del fluido
+ que almacenan o entregan.
+\layout Description
+
+
+\begin_inset Graphics
+       filename tanque_props.png
+
+\end_inset 
+
+
+\begin_inset Graphics
+       filename bomba_props.png
+
+\end_inset 
+
+
+\layout Description
+
+Al presionar el botón Color, se abrirá un nuevo diálogo que permite seleccionar
+ el mismo.
+\layout Description
+
+
+\begin_inset Graphics
+       filename color_dlg.png
+
+\end_inset 
+
+
+\layout Description
+
+Las compuertas lógicas no tienen la capacidad de modificar sus propiedades.

 \layout Standard
 
 La ventana de diálogo de propiedades también puede abrirse haciendo click
 \layout Standard
 
 La ventana de diálogo de propiedades también puede abrirse haciendo click


@@ -432,9 +597,41 @@ Dise
 \layout Standard
 
 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
 \layout Standard
 
 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.

-\layout Comment
+\layout Standard
+
+El agregado de las compuertas es tan simple como el de los demás elementos,
+ de la misma forma estas pueden rotar para acomodarse a las necesidades
+ del diseñador.
+\layout Standard
+
+Básicamente la conexión lógica se realiza en tres pasos:
+\layout Standard
+
+
+\series bold 
+1.
+ Agregado de compuertas.
+\layout Standard
+
+Como bien se menciono anteriormente, deben arrastrarse las compuertas hasta
+ el área de trabajo (grilla).
+\layout Standard
+
+
+\begin_inset Graphics
+       filename conectando.png

 
 

-Comentar que primero hay que poner compuertas, después poner 
+\end_inset 
+
+
+\layout Standard
+
+
+\series bold 
+2.Pasar al estado Lógico de diseño.
+\layout Standard
+
+Esto se hace clickeando en la caja de selección 

 \begin_inset Quotes eld
 \end_inset 
 
 \begin_inset Quotes eld
 \end_inset 
 


@@ -442,10 +639,82 @@ L
 \begin_inset Quotes erd
 \end_inset 
 
 \begin_inset Quotes erd
 \end_inset 
 

- y empezar a conectar.
-\layout Comment
+ que se encuentra en la barra de herramientas.
+\layout Standard
+
+Cuando este estado este seleccionado, no se podrán realizar cambios en las
+ posiciones de los elementos, ni agregar nuevos, pero si podrán rotarse.
+\layout Standard
+
+Al mismo tiempo que se acciona la lógica, todos los elemento que puedan
+ ser conectados 
+\begin_inset Quotes eld
+\end_inset 
+
+iluminaran
+\begin_inset Quotes erd
+\end_inset 
+
+ sus conectores lógicos, es decir, se dibujarán en ROJO los conectores que
+ representan entradas, y en AZUL los que representen SALIDAS.
+\layout Standard
+
+No todos los items tienen conectores lógicos, por lo tanto, al pasar a este
+ estado, solo se iluminaran los conectores en la exclusa, la bomba, y el
+ tanque.
+ El usuario notará que el tanque posee dos conectores azules, esto se debe
+ a que posee dos salidas.
+\layout Standard
+
+
+\begin_inset Graphics
+       filename logica.png
+
+\end_inset 
+
+
+\layout Standard
+
+
+\series bold 
+3.Conectar los elementos.
+\layout Standard
+
+La finalidad de este paso es simular una conexión lógica entre los elementos
+ de la planta, esto es, conectando mediante líneas los mismos, las cuales
+ podrían representar cables.
+\layout Standard
+
+Es importante destacar que una salida SIEMPRE debe estar conectada con una
+ entrada.
+ Es por eso que el conector ROJO de un elemento se conecta solo con un conector
+ AZUL de otro.
+\layout Subsection
+
+Conectando elementos.
+\layout Standard
+
+Luego de realizados los tres pasos mencionados en el punto anterior, esta
+ todo listo para comenzar a conectar elementos.
+\layout Standard
+
+Las conexiones se realizan siempre desde una compuerta hacia un elemento,
+ o de compuerta a compuerta.
+\layout Standard
+
+Para conectar dos elementos primero hay que realizar un click en la entrada/sali
+da de una compuerta, y luego en la salida/entrada de otro elemento de la
+ planta, siempre respentando la convención de que una entrada se une con
+ una salida.
+\layout Standard
+
+Las compuertas lógicas AND y OR pueden tener un número indefinido de entradas,
+ no así la NOT que debe tener solo una.
+\layout Standard
+
+Todas las compuertas pueden tener solo una salida.
+\layout Standard

 
 

-Explicar tema de los colores (cual es entrada y cual salida) y las limitaciones
- de cada elemento (cuantas entradas soporta cada compuerta lógica, cuantas
- salidas, que tipo de entradas y salidas tiene cada elemento de la planta).
+En los conectores lógicos de los elementos que no son compuertas, pueden
+ conectarse cualquier cantidad de cables.

 \the_end
 \the_end