Salome HOME
[EDF26936] : End of the 2GB limit.
[modules/yacs.git] / doc / main_menu.rst
1
2 .. _main_menu:
3
4 Main Menu
5 =========
6
7 The menu bar is located on the upper part of the desktop window.
8
9 .. image:: images/main_menu_0.png
10   :align: center
11
12 .. centered::
13   **Main Menu**
14
15 Let's consider the available menus in more detail.
16
17 .. _file:
18
19 File
20 ----
21 File menu contains standard operations for creating, opening and saving documents (SALOME studies) as well as schema creation or 
22 import operations. The SALOME study is saved in a HDF file with default extension \*.hdf. YACS Schema must be saved apart in XML files.
23
24 If YACS module has been loaded, File menu contains the following items:
25
26 + YACS:
27
28     + :ref:`create_new_schema`
29     + :ref:`import_yacs_schema`
30
31 .. image:: images/main_menu_2.png
32   :align: center
33
34 Edit
35 ----
36 In SALOME, Edit menu contains standard edition operations like copy/paste and undo/redo functionality. 
37 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.
38 Cut, copy, paste and undo/redo are available in edition mode only.
39
40 .. image:: images/main_menu_3.png
41   :align: center
42
43 Other edition operations on different types of objects are available with help of corresponding context popup menus or 
44 Input Panel property pages. For more information about this topic see :ref:`edit_object` section.
45
46 The user can :ref:`delete_object` with help of corresponding context popup menu item in the edition Tree View or 2D view.
47
48 View
49 ----
50 View menu allows maintaining visibility of the different parts of the desktop like toolbars, status bar, Object Browser, 
51 Tree View, Catalogs, Input Panel.
52
53 .. image:: images/main_menu_4.png
54   :align: center
55
56 .. centered::
57   **Standard Toolbar**
58
59 .. image:: images/main_menu_5.png
60   :align: center
61
62 .. centered::
63   **Windows**
64
65 .. _yacs_menu:
66
67 YACS menu
68 ---------
69 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.
70
71 When YACS is started, YACS menu contains the following items:
72
73 + :ref:`create_new_schema` : create a new schema from scratch
74 + :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
75 + :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
76 + Load a Schema in run mode (without edition)
77 + What's this, detailled help on a few items
78
79 .. image:: images/main_menu_6a.png
80   :align: center
81
82 When the active schema is in edition mode, YACS menu contains the following items:
83
84 + :ref:`create_new_schema` : create a new schema from scratch
85 + :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
86 + :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
87 + Save Schema : save in the current opened file
88 + :ref:`export_schema` : save with file dialog box to choose a new filename
89 + :ref:`execute_schema` : switch from edition to run mode
90 + :ref:`save_restore_execution_state` (from a state of execution saved previously)
91 + Load a Schema in run mode (without edition)
92 + Load a Schema to be executed on a batch system
93 + Undo last edition (modification of nodes positions in 2D view are not undoable)
94 + Redo last edition
95 + Show the stack of undoable edition actions
96 + Show the stack of redoable edition actions
97 + Import Catalog : to import specific data types or nodes
98 + Straight/Orthogonal : toggle between straight lines or orthogonal links
99 + Automatic Links: toggle behaviour for automatic link reconstruction when 2D View layout changes
100 + Simplify Links: toggle behaviour for link simplification (less segments)
101 + Force Ortho Links: toggle behaviour on very simple links (2 segments becomes 3 orthogonals segments)
102 + Separate Links: toggle behaviour to try to avoid or not superposition of links 
103 + Show all links: some links may have been selectively hidden
104 + Hide all links
105 + What's this, detailled help on a few items
106
107 .. image:: images/main_menu_6b.png
108   :align: center
109
110 When the active schema is in execution mode, YACS menu contains the following items:
111
112 + :ref:`create_new_schema` : create a new schema from scratch
113 + :ref:`import_yacs_schema` : load a YACS schema saved on an XML file 
114 + :ref:`import_supervisor_graph` : load a SUPERV schema saved on an XML file
115 + :ref:`save_restore_execution_state` (from a state of execution saved previously)
116 + Load a Schema in run mode (without edition)
117 + :ref:`Start/Resume <start_resume>`
118 + :ref:`Abort <pause_abort_reset>`
119 + :ref:`Pause <pause_abort_reset>`
120 + :ref:`Restart <pause_abort_reset>`
121 + Save state
122 + Mode without stop
123 + Mode breakpoints
124 + Mode step by step
125 + Stop on error
126 + Straight/Orthogonal : toggle between straight lines or orthogonal links
127 + Automatic Links: toggle behaviour for automatic link reconstruction when 2D View layout changes
128 + Simplify Links: toggle behaviour for link simplification (less segments)
129 + Force Ortho Links: toggle behaviour on very simple links (2 segments becomes 3 orthogonals segments)
130 + Separate Links: toggle behaviour to try to avoid or not superposition of links 
131 + Show all links: some links may have been selectively hidden
132 + Hide all links
133 + What's this, detailled help on a few items
134
135 .. image:: images/main_menu_6c.png
136   :align: center
137
138 Tools
139 -----
140 Tools menu provides two standard Salome useful tools such as XML catalog generator and registry display for supervision over component's processes.
141
142 .. image:: images/main_menu_10.png
143   :align: center
144
145 Window
146 ------
147 Window menu contains commands to arrange already opened windows in a different ways (split horizontally or vertically) or to create 
148 a new window with predefined type.
149
150 .. image:: images/main_menu_11.png
151   :align: center
152
153 Help
154 ----
155 Help menu allows reading some basic information about application with help of 'About' dialog box and provides help for YACS module 
156 as HTML documents.
157
158 .. image:: images/main_menu_12.png
159   :align: center
160