mergefrom branch BR_V511_PR tag mergeto_trunk_03feb09

[modules/yacs.git] / doc / gui.rst

diff --git a/doc/gui.rst b/doc/gui.rst
new file mode 100644 (file)
index 0000000..9f1ae85
--- /dev/null
+++ b/doc/gui.rst
@@ -0,0 +1,70 @@
+.. _gui:
+
+*******************************************************
+Utilisation de YACS avec l'interface graphique (GUI)
+*******************************************************
+
+YACS GUI description
+====================
+
+The YACS GUI document contains several 2D and tree views, one of each per run of a schema. There are different view modes of the schema. The SALOME Object browser is only used to publish the run of the schema as a whole, and under the run, the outputs of the run that are published for the use of other SALOME modules. During the schema design (edition), a dedicated edition tree view of the YACS
+data structure is used for schema building. Modifications are displayed on the 2D view.
+
+Several executions (run) of the same schema can occur at the same time. Dedicated tree in run mode and 2D views are used for each run. The run tree view is used to control the execution (stop, breakpoints) and the 2D view reflects the detailed current state of execution.
+
+The Python Console and Log Window in the low part of the desktop permits the user to invoke some YACS functionality from Python (for example, import XML graph from Python - not a normal use) and to display diagnostic messages correspondingly.
+
+For the quick access to basic operations the system of context-dependent popup menu is supported. Popup menu is called by click of the right button of the mouse on the selected object.
+
+The main window look & feel is presented schematically below.
+
+.. _mainwindow:
+
+.. figure:: images/yacs_gui_description_0.jpg
+  :align: center
+
+  Main Window
+
+.. raw:: LaTeX
+
+   \clearpage
+
+.. toctree::
+   :maxdepth: 1
+
+   gui_components
+   main_menu
+   toolbars
+
+.. raw:: LaTeX
+
+   \clearpage
+
+Functionality list
+==================
+
+Let's describe the principal functionalities of objects creation, edition, visualization and execution of the YACS module.
+
+.. toctree::
+   :maxdepth: 2
+
+   operations
+   modification
+   representation
+   execution
+
+.. raw:: LaTeX
+
+   \clearpage
+
+YACS schema examples
+====================
+
+In this section we consider several examples of YACS schemas.
+
+.. toctree::
+   :maxdepth: 2
+
+   scratch
+   dataflow
+