]> SALOME platform Git repositories - modules/yacs.git/blobdiff - doc/main_menu.rst
Salome HOME
bos #29864 Irrelevant assert in test.
[modules/yacs.git] / doc / main_menu.rst
index 4b7ef509f4b3c594565a6d2f993ad8a59862a55e..fa617c6e51c9d2097e10cf0651f1b5dca12639c1 100644 (file)
@@ -4,31 +4,13 @@
 Main Menu
 =========
 
-The menu bar is located on the upper part of the desktop window. Available commands depends on the current selected schema and its mode (edition, run). The menus are specific for each mode and rebuilt as soon as the user changes the current mode. Relevant commands also depends on the item selected in the schema tree view.
+The menu bar is located on the upper part of the desktop window.
 
-Menu bar configurations in edition and run modes are given below.
-
-
-
-.. image:: images/main_menu_0.jpg
+.. image:: images/main_menu_0.png
   :align: center
-  :width: 40ex
-
 
 .. centered::
-  **Main Menu in edition mode**
-
-
-
-
-.. image:: images/main_menu_1.jpg
-  :align: center
-  :width: 35ex
-
-
-.. centered::
-  **Main Menu in run mode**
-
+  **Main Menu**
 
 Let's consider the available menus in more detail.
 
@@ -36,237 +18,143 @@ Let's consider the available menus in more detail.
 
 File
 ----
-File menu contains standard operations for creating, opening and saving documents as well as import and export operations. The YACS GUI document is saved in a HDF file with default extension \*.hdf.
-
-If YACS module has been loaded File menu contains the following items:
-
-
-.. image:: images/main_menu_2.jpg
-  :align: center
-  :width: 40ex
-
-
-
-
-+ Import Schema:
+File menu contains standard operations for creating, opening and saving documents (SALOME studies) as well as schema creation or 
+import operations. The SALOME study is saved in a HDF file with default extension \*.hdf. YACS Schema must be saved apart in XML files.
 
+If YACS module has been loaded, File menu contains the following items:
 
++ YACS:
 
+    + :ref:`create_new_schema`
     + :ref:`import_yacs_schema`
 
-
-    + :ref:`import_supervisor_graph`
-
-
-
-
-
-+ :ref:`export_schema`
-
-
-+ :ref:`create_new_schema`
-
-
-
-
+.. image:: images/main_menu_2.png
+  :align: center
 
 Edit
 ----
-Edit menu supports standard edition operations like copy/paste and undo/redo functionality. Cut, copy, paste, undo/redo should be available in edition mode only. ( **These items are not currently implemented, but will be available in the future version!** )
+In SALOME, Edit menu contains standard edition operations like copy/paste and undo/redo functionality. 
+In YACS module, Cut, copy and paste are available but only within context popup menus. Undo/redo are also available, in YACS menu and toolbar.
+Cut, copy, paste and undo/redo are available in edition mode only.
 
-
-
-.. image:: images/main_menu_3.jpg
+.. image:: images/main_menu_3.png
   :align: center
-  :width: 20ex
-
-
-
-Other edition operations on different types of objects are available with help of corresponding Input Panel property pages. For more information about this topic see :ref:`edit_object` section.
 
-The user can :ref:`delete_object` with help of corresponding context popup menu item in the edition Tree View.
+Other edition operations on different types of objects are available with help of corresponding context popup menus or 
+Input Panel property pages. For more information about this topic see :ref:`edit_object` section.
 
+The user can :ref:`delete_object` with help of corresponding context popup menu item in the edition Tree View or 2D view.
 
 View
 ----
-View menu allows maintaining visibility of the different parts of the desktop like toolbars, status bar, Object Browser, Python Console, Log Window.
+View menu allows maintaining visibility of the different parts of the desktop like toolbars, status bar, Object Browser, 
+Tree View, Catalogs, Input Panel.
 
-
-
-.. image:: images/main_menu_4.jpg
+.. image:: images/main_menu_4.png
   :align: center
-  :width: 44ex
-
-
-.. centered::
-   **Python Console**
-
-
-.. image:: images/main_menu_5.jpg
-  :align: center
-  :width: 41ex
 
 .. centered::
   **Standard Toolbar**
 
-
-.. _create_menu:
-
-Create
-------
-Create menu contains a set of commands for creation of the YACS GUI objects. It is active only in the edition mode of a schema. Create menu contains the following items:
-
-
-
-
-+ :ref:`create_container_definition`
-
-
-+ :ref:`create_component_instance_definition`
-
-
-
-
-
-
-
-.. image:: images/main_menu_6.jpg
+.. image:: images/main_menu_5.png
   :align: center
-  :width: 58ex
-
-
-
-
-
 
-+ :ref:`create_node`
+.. centered::
+  **Windows**
 
+.. _yacs_menu:
 
+YACS menu
+---------
+YACS menu contains a set of commands for creating opening and saving of YACS schemas, importing old SUPERV schemas, execute schemas, import catalogs, and set some specific behavior of 2D views.
 
+When YACS is started, YACS menu contains the following items:
 
++ :ref:`create_new_schema` : create a new schema from scratch
++ :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
++ :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
++ Load a Schema in run mode (without edition)
++ What's this, detailled help on a few items
 
-.. image:: images/main_menu_7.jpg
+.. image:: images/main_menu_6a.png
   :align: center
-  :width: 48ex
-
-
-.. _execute:
-
-Execute
--------
-Execute menu contains a set of commands for execution of the YACS GUI schemas.
-
-If the current mode is the edition mode of a schema, there is only possibility to create a schema run:
 
+When the active schema is in edition mode, YACS menu contains the following items:
 
-
-.. image:: images/main_menu_8.jpg
++ :ref:`create_new_schema` : create a new schema from scratch
++ :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
++ :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
++ Save Schema : save in the current opened file
++ :ref:`export_schema` : save with file dialog box to choose a new filename
++ :ref:`execute_schema` : switch from edition to run mode
++ :ref:`save_restore_execution_state` (from a state of execution saved previously)
++ Load a Schema in run mode (without edition)
++ Load a Schema to be executed on a batch system
++ Undo last edition (modification of nodes positions in 2D view are not undoable)
++ Redo last edition
++ Show the stack of undoable edition actions
++ Show the stack of redoable edition actions
++ Import Catalog : to import specific data types or nodes
++ Straight/Orthogonal : toggle between straight lines or orthogonal links
++ Automatic Links: toggle behaviour for automatic link reconstruction when 2D View layout changes
++ Simplify Links: toggle behaviour for link simplification (less segments)
++ Force Ortho Links: toggle behaviour on very simple links (2 segments becomes 3 orthogonals segments)
++ Separate Links: toggle behaviour to try to avoid or not superposition of links 
++ Show all links: some links may have been selectively hidden
++ Hide all links
++ What's this, detailled help on a few items
+
+.. image:: images/main_menu_6b.png
   :align: center
-  :width: 38ex
-
-
-
-
-
-
-+ :ref:`execute_schema`
 
+When the active schema is in execution mode, YACS menu contains the following items:
 
++ :ref:`create_new_schema` : create a new schema from scratch
++ :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
++ :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
 + :ref:`save_restore_execution_state` (from a state of execution saved previously)
-
-
-+ New Batch Execution ( **Will be available in the future version!** )
-
-
-
-
-
-Execute menu is active only if we are in the run mode of a schema. Execute menu contains the following items:
-
-
-
-.. image:: images/main_menu_9.jpg
++ Load a Schema in run mode (without edition)
++ :ref:`Start/Resume <start_resume>`
++ :ref:`Abort <pause_abort_reset>`
++ :ref:`Pause <pause_abort_reset>`
++ :ref:`Restart <pause_abort_reset>`
++ Save state
++ Mode without stop
++ Mode breakpoints
++ Mode step by step
++ Stop on error
++ Straight/Orthogonal : toggle between straight lines or orthogonal links
++ Automatic Links: toggle behaviour for automatic link reconstruction when 2D View layout changes
++ Simplify Links: toggle behaviour for link simplification (less segments)
++ Force Ortho Links: toggle behaviour on very simple links (2 segments becomes 3 orthogonals segments)
++ Separate Links: toggle behaviour to try to avoid or not superposition of links 
++ Show all links: some links may have been selectively hidden
++ Hide all links
++ What's this, detailled help on a few items
+
+.. image:: images/main_menu_6c.png
   :align: center
-  :width: 44ex
-
-
-
-
-
-
-+ Without stop Mode
-
-
-+ Breakpoints Mode
-
-
-+ Step by step Mode
-
-
-+ Stop on error Option
-
-
-+ Start/Resume
-
-
-+ Pause
-
-
-+ Abort
-
-
-+ Reset
-
-
-+ Execute in batch ( **Will be available in the future version!** )
-
-
-+ Connect to a running batch session ... ( **Will be available in the future version!** )
-
-
-+ Save execution state ...
-
-
-+ New edition
-
-
-
-
 
 Tools
 -----
 Tools menu provides two standard Salome useful tools such as XML catalog generator and registry display for supervision over component's processes.
 
-
-
-.. image:: images/main_menu_10.jpg
+.. image:: images/main_menu_10.png
   :align: center
-  :width: 44ex
-
-
-
 
 Window
 ------
-Window menu contains commands to arrange already opened windows in a different ways (split horizontally or vertically) or to create a new window with predefined type.
+Window menu contains commands to arrange already opened windows in a different ways (split horizontally or vertically) or to create 
+a new window with predefined type.
 
-
-
-.. image:: images/main_menu_11.jpg
+.. image:: images/main_menu_11.png
   :align: center
-  :width: 74ex
-
-
-
 
 Help
 ----
-Help menu allows reading some basic information about application with help of 'About' dialog box and provides help for YACS module as HTML documents.
-
+Help menu allows reading some basic information about application with help of 'About' dialog box and provides help for YACS module 
+as HTML documents.
 
-
-.. image:: images/main_menu_12.jpg
+.. image:: images/main_menu_12.png
   :align: center
-  :width: 65ex
-