Constructor/doc/manual.lyx

   1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 221
   3 \textclass book
   4 \language spanish
   5 \inputencoding auto
   6 \fontscheme palatino
   7 \graphics default
   8 \float_placement !htb
   9 \paperfontsize default
  10 \spacing single
  11 \papersize a4paper
  12 \paperpackage widemarginsa4
  13 \use_geometry 0
  14 \use_amsmath 0
  15 \use_natbib 0
  16 \use_numerical_citations 0
  17 \paperorientation portrait
  18 \secnumdepth 3
  19 \tocdepth 3
  20 \paragraph_separation indent
  21 \defskip medskip
  22 \quotes_language english
  23 \quotes_times 2
  24 \papercolumns 1
  25 \papersides 2
  26 \paperpagestyle default
  27
  28 \layout Title
  29
  30 PlaQui Constructor
  31 \newline
  32 Manual de Usuario
  33 \layout Author
  34
  35 Nicolás Dimov
  36 \newline
  37 Leandro Lucarella
  38 \newline
  39 Ricardo Markiewicz
  40 \layout Standard
  41
  42
  43 \begin_inset LatexCommand \tableofcontents{}
  44
  45 \end_inset
  46
  47
  48 \layout Chapter
  49
  50 Introducción.
  51 \layout Standard
  52
  53 PlaQui es un conjunto de aplicaciones para diseño, simulación y control
  54  de plantas químicas.
  55 \layout Standard
  56
  57 PlaQui Constructor es la aplicación para diseñar y construir la planta química.
  58  Con este programa se puede diseñar fácilmente tanto la distribución física
  59  de la planta y sus componentes como las conexiones lógicas para su correcto
  60  funcionamiento.
  61 \layout Section
  62
  63 Abrir la aplicación.
  64 \layout Standard
  65
  66 Para abrir la aplicación basta con ejecutarla desde la línea de comandos.
  67  Escriba
  68 \family typewriter
  69 plaqui-constructor
  70 \family default
  71  y presione
  72 \family typewriter
  73 Enter
  74 \family default
  75 .
  76 \layout Subsection
  77
  78 Pantalla inicial.
  79 \layout Standard
  80
  81 Una vez abierta la aplicación aparecerá la ventana principal que se puede
  82  ver en la figura
  83 \begin_inset LatexCommand \vref{cap:Ventana-principal}
  84
  85 \end_inset
  86
  87 .
  88 \layout Standard
  89
  90
  91 \begin_inset Float figure
  92 wide false
  93 collapsed true
  94
  95 \layout Caption
  96
  97
  98 \begin_inset LatexCommand \label{cap:Ventana-principal}
  99
 100 \end_inset
 101
 102 Ventana principal de PlaQui Constructor
 103 \layout Standard
 104
 105
 106 \begin_inset Graphics
 107         filename /home/nico/plaqui/Constructor/doc/principal.png
 108         lyxscale 50
 109         width 14.7cm
 110         keepAspectRatio
 111
 112 \end_inset
 113
 114
 115 \end_inset
 116
 117
 118 \layout Standard
 119
 120 La ventana contiene los siguientes elementos:
 121 \layout Subsubsection
 122
 123 Barra de menú.
 124 \layout Standard
 125
 126 En la barra de menú se encuentra en la parte superior de la ventana y en
 127  ella están todas los comandos para trabajar con el programa.
 128 \layout Comment
 129
 130 En cada ítem de cada menú se podría agregar un ícono.
 131 \layout Paragraph
 132
 133 Menú
 134 \family sans
 135 Archivo
 136 \family default
 137 .
 138 \layout Standard
 139
 140 En este menú se encuentran todos los comandos para manejar archivos y salir
 141  del programa.
 142 \layout Description
 143
 144
 145 \begin_inset Graphics
 146         filename /home/nico/plaqui/Constructor/doc/new.png
 147
 148 \end_inset
 149
 150 Nuevo Empieza a construir una planta nueva.
 151  La planta con la que estaba trabajando actualmente será descartada.
 152 \layout Description
 153
 154
 155 \begin_inset Graphics
 156         filename /home/nico/plaqui/Constructor/doc/open.png
 157
 158 \end_inset
 159
 160 Abrir Abre una planta nueva.
 161  La planta con la que estaba trabajando actualmente será descartada.
 162 \layout Description
 163
 164
 165 \begin_inset Graphics
 166         filename /home/nico/plaqui/Constructor/doc/save.png
 167
 168 \end_inset
 169
 170 Guardar Guarda la planta actual.
 171 \layout Description
 172
 173
 174 \begin_inset Graphics
 175         filename /home/nico/plaqui/Constructor/doc/quit.png
 176
 177 \end_inset
 178
 179 Salir Sale del programa.
 180  La planta con la que estaba trabajando actualmente será descartada.
 181 \layout Paragraph
 182
 183 Menú
 184 \family sans
 185 Edición
 186 \family default
 187 .
 188 \layout Standard
 189
 190 En este menú se encuentran los comandos para trabajar con los elementos
 191  de la planta.
 192 \layout Description
 193
 194
 195 \begin_inset Graphics
 196         filename /home/nico/plaqui/Constructor/doc/delete.png
 197
 198 \end_inset
 199
 200 Borrar Borra el elemento seleccionado actualmente.
 201 \layout Description
 202
 203
 204 \begin_inset Graphics
 205         filename /home/nico/plaqui/Constructor/doc/clear.png
 206
 207 \end_inset
 208
 209 Borrar\SpecialChar ~
 210 Todo Borra todos los elementos de la planta.
 211  Es equivalente a
 212 \family sans
 213 Archivo\SpecialChar \menuseparator
 214 Nuevo
 215 \family default
 216 .
 217 \layout Paragraph
 218
 219 Menú
 220 \family sans
 221 Ayuda
 222 \family default
 223 .
 224 \layout Standard
 225
 226 En este menú se encuentran los comandos para obtener ayuda.
 227 \layout Description
 228
 229 Acerca Obtiene información acerca de la aplicación.
 230 \layout Subsubsection
 231
 232 Barra de herramientas.
 233 \layout Standard
 234
 235
 236 \begin_inset Graphics
 237         filename barra_herramientas.png
 238
 239 \end_inset
 240
 241
 242 \layout Standard
 243
 244 En la barra de herramientas se encuentra debajo de la
 245 \family sans
 246 Barra de menú
 247 \family default
 248  y está dividida en dos.
 249  En la parte superior se encuentran íconos para ejecutar los comandos (del
 250  menú principal) más comunes del programa, como empezar una planta nueva,
 251  guardar la planta actual y abrir una planta existente.
 252 \layout Standard
 253
 254 En la parte inferior se encuentran herramientas adicionales útiles a la
 255  hora de trabajar con la planta.
 256 \layout Standard
 257
 258
 259 \series bold
 260 Verificar Conexionado
 261 \series default
 262 Verifica que todos los elementos estén conectados, y formen un circuito
 263  de manera que pudierda fluir un líquido.
 264 \layout Standard
 265
 266
 267 \series bold
 268 Lista
 269 \series default
 270  Ubicada en la segunda posición de la barra, indica cuál fué el último elemento
 271  seleccionado mediante un click del mouse, y almacena todos los nombres
 272  de los elementos que fueron seleccionados.
 273 \layout Standard
 274
 275
 276 \series bold
 277 Buscar
 278 \series default
 279  Marca con un recuadro negro el elemento seleccionado (el que aparece en
 280  la lista).
 281 \layout Standard
 282
 283
 284 \begin_inset Graphics
 285         filename buscar.png
 286
 287 \end_inset
 288
 289
 290 \layout Subsubsection
 291
 292 Barra de elementos de planta.
 293 \layout Standard
 294
 295 En la barra de íconos que se encuentra a la izquierda.
 296  En ella están todos los elementos (físicos) que pueden ser incluídos en
 297  una planta.
 298 \layout Subsubsection
 299
 300 Barra de compuertas lógicas.
 301 \layout Standard
 302
 303 En la barra de íconos que se encuentra a la derecha.
 304  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
 305 to dinámico de la planta.
 306 \layout Subsubsection
 307
 308 Barra de estado.
 309 \layout Standard
 310
 311 Esta barra se encuentra en la parte inferior de la ventana principal y proporcio
 312 na información adicional útil a la hora de trabajar con una planta, como
 313  las propiedades del elemento seleccionado.
 314 \layout Subsubsection
 315
 316 Área de trabajo.
 317 \layout Standard
 318
 319 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
 320  de una planta para su diseño.
 321 \layout Comment
 322
 323 ACA ESTARIA BUENO PONER UNA IMAGEN DE TODA LA PANTALLA INDICANDO QUE ES
 324  CADA COSA
 325 \layout Comment
 326
 327 ( DENTRO DE LA MISMA IMAGEN)
 328 \layout Section
 329
 330 Guardar y recuperar el trabajo.
 331 \layout Subsection
 332
 333 Abrir un archivo de planta.
 334 \layout Standard
 335
 336 Para abrir un archivo tiene dos formas: desde el menú
 337 \family sans
 338 Archivo\SpecialChar \menuseparator
 339 Abrir
 340 \family default
 341  o presionando sobre el ícono
 342 \family sans
 343 Abrir
 344 \family default
 345  de la barra de herramientas.
 346  En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
 347  el archivo a abrir.
 348  Una vez seleccionado, presione
 349 \family sans
 350 Aceptar
 351 \family default
 352 .
 353  La planta aparecerá en la ventana principal.
 354 \layout Comment
 355
 356 En vez de poner
 357 \begin_inset Quotes eld
 358 \end_inset
 359
 360 ícono Abrir
 361 \begin_inset Quotes erd
 362 \end_inset
 363
 364  se podría poner una imágen bonita :)
 365 \layout Subsection
 366
 367 Guardar un archivo de planta.
 368 \layout Standard
 369
 370 De manera similar a la carga o apertura de una planta, se puede guardar
 371  o salvar la misma.
 372  Para esto también hay dos formas distintas:
 373 \family sans
 374  Archivo\SpecialChar \menuseparator
 375 Salvar
 376 \family default
 377  o presionando sobre el ícono
 378 \family sans
 379 Salvar
 380 \family default
 381  de la barra de herramientas.
 382 \layout Standard
 383
 384 La primera vez que el archivo sea guardado, se abrirá un diálogo para selecciona
 385 r la ubicación donde desee guardarse, luego al presionar el botón en la
 386  barra de herramientas que realiza esta acción, se sobreescribirá el archivo.
 387 \layout Standard
 388
 389 Si se desea guardar el archivo con otro nombre o en otra ubicación, siempre
 390  estará disponible la primera opción, que en todos los casos mostrará el
 391  diálogo correspondiente.
 392 \layout Subsection
 393
 394 Empezar una planta nueva.
 395 \layout Standard
 396
 397 Para comenzar a editar una planta nueva debe presionarse el botón en el
 398  menú principal
 399 \family sans
 400 Archivo\SpecialChar \menuseparator
 401 Nuevo
 402 \family default
 403 o directamente desde el acceso rápido en la barra de herramientas presionando
 404  el botón con el mismo ícono, que se encuentra en la primera posición.
 405 \layout Standard
 406
 407 Luego de este procedimiento, si el usuario desea guardar nuevamente el trabajo,
 408  volverá a aparecer el diálogo para seleccionar la ubicación y nombre del
 409  archivo por primera vez.
 410 \layout Section
 411
 412 Salir del programa.
 413 \layout Standard
 414
 415 Para salir del programa puede presionar sobre la cruz que generalmente se
 416  encuentra en la esquina superior derecha de la ventana principal (esto
 417  depende de su manejador de ventanas) o desde el menú
 418 \family sans
 419 Archivo\SpecialChar \menuseparator
 420 Salir
 421 \family default
 422 .
 423 \layout Chapter
 424
 425 Crear una planta.
 426 \layout Standard
 427
 428 Para crear una planta sólo tiene que arrastrar y soltar los elementos en
 429  el área de trabajo.
 430  Una vez conseguido el diseño físico de la planta puede empezar a arrastrar
 431  y soltar compuertas lógicas para definir su comportamiento dinámico.
 432  Finalmente, para hacer el conexionado lógico debe activar la caja de selección
 433
 434 \family sans
 435 Lógica
 436 \family default
 437  de la barra de herramientas.
 438 \layout Standard
 439
 440 A continuación se detalla el proceso.
 441 \layout Section
 442
 443 Diseño Físico de la planta.
 444 \layout Subsection
 445
 446 Agregar un elemento.
 447 \layout Standard
 448
 449 Para agregar un elemento hay que arrastrarlo y soltarlo desde la
 450 \family sans
 451 Barra de elementos
 452 \family default
 453  al
 454 \family sans
 455 Área de trabajo
 456 \family default
 457 .
 458 \layout Subsection
 459
 460 Modificar un elemento.
 461 \layout Standard
 462
 463 Para modificar un elemento primero debe seleccionarlo en el
 464 \family sans
 465 Área de trabajo
 466 \family default
 467  y luego realizar alguna de las siguientes acciones:
 468 \layout Subsubsection
 469
 470 Orientar un elemento.
 471 \layout Standard
 472
 473 Para cambiar la orientación de un elemento puede hacer click con el botón
 474  central del puntero o hacer click con el botón derecho y seleccionar la
 475  opción
 476 \family sans
 477 Rotar
 478 \family default
 479  del menú contextual.
 480  Según el tipo de elemento puede ser que rote o se
 481 \emph on
 482 espeje
 483 \emph default
 484 .
 485 \layout Subsubsection
 486
 487 Cambiar las propiedades de un elemento.
 488 \layout Standard
 489
 490 Para modificar las propiedades de un elemento puede hacer doble-click sobre
 491  el mismo.
 492  Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá
 493  cambiar las siguiente propiedades:
 494 \layout Description
 495
 496 Nombre Nombre del elemento.
 497  Este nombre se utiliza para identificar este elemento para poder controlarlo
 498  desde la aplicación de control.
 499 \layout Comment
 500
 501 Poner las otras propiedades que pueden modificarse.
 502 \layout Comment
 503
 504 Poner screenshots???
 505 \layout Standard
 506
 507 La ventana de diálogo de propiedades también puede abrirse haciendo click
 508  con el botón derecho del puntero y seleccionando la opción
 509 \family sans
 510 Propiedades
 511 \family default
 512  del menú contextual.
 513 \layout Subsection
 514
 515 Eliminar un elemento.
 516 \layout Standard
 517
 518 Para eliminar un elemento puede utilizar la opción del menú
 519 \family sans
 520 Edición\SpecialChar \menuseparator
 521 Borrar
 522 \family default
 523  o hacer click con el botón derecho del puntero y seleccionar la opción
 524
 525 \family sans
 526 Eliminar
 527 \family default
 528  del menú contextual.
 529  Además del elemento se eliminarán todas sus conexiones lógicas.
 530 \layout Subsection
 531
 532 Mover un elemento.
 533 \layout Standard
 534
 535 Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del
 536
 537 \family sans
 538 Área de trabajo
 539 \family default
 540  a otra.
 541 \layout Section
 542
 543 Diseño lógico de la planta.
 544 \layout Standard
 545
 546 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
 547 \layout Comment
 548
 549 Comentar que primero hay que poner compuertas, después poner
 550 \begin_inset Quotes eld
 551 \end_inset
 552
 553 Lógica
 554 \begin_inset Quotes erd
 555 \end_inset
 556
 557  y empezar a conectar.
 558 \layout Comment
 559
 560 Explicar tema de los colores (cual es entrada y cual salida) y las limitaciones
 561  de cada elemento (cuantas entradas soporta cada compuerta lógica, cuantas
 562  salidas, que tipo de entradas y salidas tiene cada elemento de la planta).
 563 \the_end