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 External ChessDiagram,"",""
 237
 238 \end_inset
 239
 240
 241 \begin_inset Graphics
 242         filename /home/nico/plaqui/Constructor/doc/barra_herramientas.png
 243
 244 \end_inset
 245
 246
 247 \layout Standard
 248
 249 En la barra de herramientas se encuentra debajo de la
 250 \family sans
 251 Barra de menú
 252 \family default
 253  y está dividida en dos.
 254  En la parte superior se encuentran íconos para ejecutar los comandos (del
 255  menú principal) más comunes del programa, como empezar una planta nueva,
 256  guardar la planta actual y abrir una planta existente.
 257 \layout Standard
 258
 259 En la parte inferior se encuentran herramientas adicionales útiles a la
 260  hora de trabajar con la planta.
 261 \layout Standard
 262
 263
 264 \series bold
 265 Verificar Conexionado
 266 \series default
 267 Verifica que todos los elementos estén conectados, y formen un circuito
 268  de manera que pudierda fluir un líquido.
 269 \layout Standard
 270
 271
 272 \series bold
 273 Lista
 274 \series default
 275  Ubicada en la segunda posición de la barra, indica cuál fué el último elemento
 276  seleccionado mediante un click del mouse, y almacena todos los nombres
 277  de los elementos que fueron seleccionados.
 278 \layout Standard
 279
 280
 281 \series bold
 282 Buscar
 283 \series default
 284  Marca con un recuadro negro el elemento seleccionado (el que aparece en
 285  la lista).
 286 \layout Standard
 287
 288
 289 \begin_inset Graphics
 290         filename /home/nico/plaqui/Constructor/doc/buscar.png
 291
 292 \end_inset
 293
 294
 295 \layout Subsubsection
 296
 297 Barra de elementos de planta.
 298 \layout Standard
 299
 300 En la barra de íconos que se encuentra a la izquierda.
 301  En ella están todos los elementos (físicos) que pueden ser incluídos en
 302  una planta.
 303 \layout Subsubsection
 304
 305 Barra de compuertas lógicas.
 306 \layout Standard
 307
 308 En la barra de íconos que se encuentra a la derecha.
 309  En esta barra se encuentran las compuertas lógicas para diseñar el comportamien
 310 to dinámico de la planta.
 311 \layout Subsubsection
 312
 313 Barra de estado.
 314 \layout Standard
 315
 316 Esta barra se encuentra en la parte inferior de la ventana principal y proporcio
 317 na información adicional útil a la hora de trabajar con una planta, como
 318  las propiedades del elemento seleccionado.
 319 \layout Subsubsection
 320
 321 Área de trabajo.
 322 \layout Standard
 323
 324 Es el espacio grillado central, en ella se arrastran y sueltan los elementos
 325  de una planta para su diseño.
 326 \layout Section
 327
 328 Guardar y recuperar el trabajo.
 329 \layout Subsection
 330
 331 Abrir un archivo de planta.
 332 \layout Standard
 333
 334 Para abrir un archivo tiene dos formas: desde el menú
 335 \family sans
 336 Archivo\SpecialChar \menuseparator
 337 Abrir
 338 \family default
 339  o presionando sobre el ícono
 340 \family sans
 341 Abrir
 342 \family default
 343  de la barra de herramientas.
 344  En ambos casos se abrirá una ventana de dialogo en la que puede seleccionar
 345  el archivo a abrir.
 346  Una vez seleccionado, presione
 347 \family sans
 348 Aceptar
 349 \family default
 350 .
 351  La planta aparecerá en la ventana principal.
 352 \layout Comment
 353
 354 En vez de poner
 355 \begin_inset Quotes eld
 356 \end_inset
 357
 358 ícono Abrir
 359 \begin_inset Quotes erd
 360 \end_inset
 361
 362  se podría poner una imágen bonita :)
 363 \layout Subsection
 364
 365 Guardar un archivo de planta.
 366 \layout Standard
 367
 368 De manera similar a la carga o apertura de una planta, se puede guardar
 369  o salvar la misma.
 370  Para esto también hay dos formas distintas:
 371 \family sans
 372 Archivo\SpecialChar \menuseparator
 373 Salvar
 374 \layout Subsection
 375
 376 Empezar una planta nueva.
 377 \layout Comment
 378
 379 Idem anterior.
 380 \layout Section
 381
 382 Salir del programa.
 383 \layout Standard
 384
 385 Para salir del programa puede presionar sobre la cruz que generalmente se
 386  encuentra en la esquina superior derecha de la ventana principal (esto
 387  depende de su manejador de ventanas) o desde el menú
 388 \family sans
 389 Archivo\SpecialChar \menuseparator
 390 Salir
 391 \family default
 392 .
 393 \layout Chapter
 394
 395 Crear una planta.
 396 \layout Standard
 397
 398 Para crear una planta sólo tiene que arrastrar y soltar los elementos en
 399  el área de trabajo.
 400  Una vez conseguido el diseño físico de la planta puede empezar a arrastrar
 401  y soltar compuertas lógicas para definir su comportamiento dinámico.
 402  Finalmente, para hacer el conexionado lógico debe activar la caja de selección
 403
 404 \family sans
 405 Lógica
 406 \family default
 407  de la barra de herramientas.
 408 \layout Standard
 409
 410 A continuación se detalla el proceso.
 411 \layout Section
 412
 413 Diseño Físico de la planta.
 414 \layout Comment
 415
 416 Mencionar el botón de verificar conexionado.
 417 \layout Subsection
 418
 419 Agregar un elemento.
 420 \layout Standard
 421
 422 Para agregar un elemento hay que arrastrarlo y soltarlo desde la
 423 \family sans
 424 Barra de elementos
 425 \family default
 426  al
 427 \family sans
 428 Área de trabajo
 429 \family default
 430 .
 431 \layout Subsection
 432
 433 Modificar un elemento.
 434 \layout Standard
 435
 436 Para modificar un elemento primero debe seleccionarlo en el
 437 \family sans
 438 Área de trabajo
 439 \family default
 440  y luego realizar alguna de las siguientes acciones:
 441 \layout Subsubsection
 442
 443 Orientar un elemento.
 444 \layout Standard
 445
 446 Para cambiar la orientación de un elemento puede hacer click con el botón
 447  central del puntero o hacer click con el botón derecho y seleccionar la
 448  opción
 449 \family sans
 450 Rotar
 451 \family default
 452  del menú contextual.
 453  Según el tipo de elemento puede ser que rote o se
 454 \emph on
 455 espeje
 456 \emph default
 457 .
 458 \layout Subsubsection
 459
 460 Cambiar las propiedades de un elemento.
 461 \layout Standard
 462
 463 Para modificar las propiedades de un elemento puede hacer doble-click sobre
 464  el mismo.
 465  Esto abre una ventana de diálogo que, según el tipo de elemento le permitirá
 466  cambiar las siguiente propiedades:
 467 \layout Description
 468
 469 Nombre Nombre del elemento.
 470  Este nombre se utiliza para identificar este elemento para poder controlarlo
 471  desde la aplicación de control.
 472 \layout Comment
 473
 474 Poner las otras propiedades que pueden modificarse.
 475 \layout Comment
 476
 477 Poner screenshots???
 478 \layout Standard
 479
 480 La ventana de diálogo de propiedades también puede abrirse haciendo click
 481  con el botón derecho del puntero y seleccionando la opción
 482 \family sans
 483 Propiedades
 484 \family default
 485  del menú contextual.
 486 \layout Subsection
 487
 488 Eliminar un elemento.
 489 \layout Standard
 490
 491 Para eliminar un elemento puede utilizar la opción del menú
 492 \family sans
 493 Edición\SpecialChar \menuseparator
 494 Borrar
 495 \family default
 496  o hacer click con el botón derecho del puntero y seleccionar la opción
 497
 498 \family sans
 499 Eliminar
 500 \family default
 501  del menú contextual.
 502  Además del elemento se eliminarán todas sus conexiones lógicas.
 503 \layout Subsection
 504
 505 Mover un elemento.
 506 \layout Standard
 507
 508 Puede mover un elemento arrastrandolo y soltándolo desde una ubicación del
 509
 510 \family sans
 511 Área de trabajo
 512 \family default
 513  a otra.
 514 \layout Section
 515
 516 Diseño lógico de la planta.
 517 \layout Standard
 518
 519 Para agregar un circuito lógico a la planta debe agregar compuertas lógicas.
 520 \layout Comment
 521
 522 Comentar que primero hay que poner compuertas, después poner
 523 \begin_inset Quotes eld
 524 \end_inset
 525
 526 Lógica
 527 \begin_inset Quotes erd
 528 \end_inset
 529
 530  y empezar a conectar.
 531 \layout Comment
 532
 533 Explicar tema de los colores (cual es entrada y cual salida) y las limitaciones
 534  de cada elemento (cuantas entradas soporta cada compuerta lógica, cuantas
 535  salidas, que tipo de entradas y salidas tiene cada elemento de la planta).
 536 \the_end