~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/xcos/help/en_US/xcos_menu_entries.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
23
23
 *
24
24
 -->
25
25
<refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xml:id="xcos_menu_entries">
26
 
  <refnamediv>
27
 
    <refname>Menu_Entries</refname>
28
 
    <refpurpose>Xcos editor menu entries</refpurpose>
29
 
  </refnamediv>
30
 
  <refsection id="Contents_xcos_menu_entries">
31
 
    <title>Contents</title>
32
 
    <para>
33
 
      This section presents briefly all the menu entries of the <emphasis>Xcos</emphasis> editor. Many items are also
34
 
      available in pull-down menus shown by a right click when the mouse cursor is on a block, a link or in the main
35
 
      <emphasis>Xcos</emphasis> window.
36
 
    </para>
37
 
    <itemizedlist>
38
 
      <listitem>
39
 
        <para>
40
 
          <link linkend="xcos_menu_entries">Xcos editor menu entries</link>
41
 
        </para>
42
 
      </listitem>
43
 
      <listitem>
44
 
        <itemizedlist>
45
 
          <listitem>
46
 
            <para>
47
 
              <xref linkend="Filemenu_Menu_entries">File menu</xref>
48
 
            </para>
49
 
          </listitem>
50
 
          <listitem>
51
 
            <para>
52
 
              <xref linkend="Editmenu_Menu_entries">Edit menu</xref>
53
 
            </para>
54
 
          </listitem>
55
 
          <listitem>
56
 
            <para>
57
 
              <xref linkend="Viewmenu_Menu_entries">View menu</xref>
58
 
            </para>
59
 
          </listitem>
60
 
          <listitem>
61
 
            <para>
62
 
              <xref linkend="Simulatemenu_Menu_entries">Simulate menu</xref>
63
 
            </para>
64
 
          </listitem>
65
 
          <listitem>
66
 
            <para>
67
 
              <xref linkend="Formatmenu_Menu_entries">Format menu</xref>
68
 
            </para>
69
 
          </listitem>
70
 
          <listitem>
71
 
            <para>
72
 
              <xref linkend="Toolsmenu_Menu_entries">Tools menu</xref>
73
 
            </para>
74
 
          </listitem>
75
 
          <listitem>
76
 
            <para>
77
 
              <xref linkend="Helpmenu_Menu_entries">? menu</xref>
78
 
            </para>
79
 
          </listitem>
80
 
          <listitem>
81
 
            <para>
82
 
              <xref linkend="Seealso_Menu_entries">See Also</xref>
83
 
            </para>
84
 
          </listitem>
85
 
        </itemizedlist>
86
 
      </listitem>
87
 
    </itemizedlist>
88
 
  </refsection>
89
 
  <refsection id="Filemenu_Menu_entries">
90
 
    <title>File menu</title>
91
 
    <mediaobject>
92
 
      <imageobject>
93
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_file.png"/>
94
 
      </imageobject>
95
 
    </mediaobject>
96
 
    <para/>
97
 
    <itemizedlist>
98
 
      <listitem>
99
 
        <para>
100
 
          <emphasis role="bold"> File:New (Ctrl+N)</emphasis>
101
 
          <inlinemediaobject>
102
 
            <imageobject>
103
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/document-new.png"/>
104
 
            </imageobject>
105
 
          </inlinemediaobject>
106
 
        </para>
107
 
        <para>
108
 
          Clicking on the <emphasis>New</emphasis> menu item open a new empty <emphasis>Xcos</emphasis> diagram in a new
109
 
          window. With this menu, you can open a new diagram or a new palette.
110
 
        </para>
111
 
        <para/>
112
 
      </listitem>
113
 
      <listitem>
114
 
        <para>
115
 
          <emphasis role="bold">File:Open (Ctrl+O)</emphasis>
116
 
          <inlinemediaobject>
117
 
            <imageobject>
118
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/document-open.png"/>
119
 
            </imageobject>
120
 
          </inlinemediaobject>
121
 
        </para>
122
 
        <para>
123
 
          Select the <emphasis>Open</emphasis> menu item to load an XML (<emphasis>.xcos</emphasis>) or a binary file
124
 
          (<emphasis>.cos</emphasis>) which contain saved block diagram or a palette. The command open a dialog box allows
125
 
          you to choose the folder and the file.
126
 
        </para>
127
 
        <para/>
128
 
      </listitem>
129
 
      <listitem>
130
 
        <para>
131
 
          <emphasis role="bold">File:Save (Ctrl+S)</emphasis>
132
 
          <inlinemediaobject>
133
 
            <imageobject>
134
 
              <imagedata fileref="../../../gui/images/icons/16x16/devices/media-floppy.png"/>
135
 
            </imageobject>
136
 
          </inlinemediaobject>
137
 
        </para>
138
 
        <para>
139
 
          Select the <emphasis>Save</emphasis> menu item to save the diagram in a
140
 
          <emphasis>XML</emphasis> file.
141
 
        </para>
142
 
        <para>
143
 
          If you select this menu item and you have never clicked on the <emphasis>Save</emphasis> or
144
 
          <emphasis>Save As</emphasis> menu item, a dialog allows you to choose a directory and
145
 
          specify a file name without extension. The default extension is <emphasis>.xcos</emphasis>.
146
 
        </para>
147
 
        <para>The diagram takes the name of the file (without the extension).</para>
148
 
        <para/>
149
 
      </listitem>
150
 
      <listitem>
151
 
        <para>
152
 
          <emphasis role="bold">File:Save As (Ctrl+Shift+S)</emphasis>
153
 
          <inlinemediaobject>
154
 
            <imageobject>
155
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/document-save-as.png"/>
156
 
            </imageobject>
157
 
          </inlinemediaobject>
158
 
        </para>
159
 
        <para>
160
 
          Select the <emphasis>Save As</emphasis> menu item to save the block diagram or palette in a file with a new name.
161
 
        </para>
162
 
        <para>
163
 
          A dialog box allows specifying a file name without the extension and a saving folder.
164
 
          The default extension is <emphasis>.xcos</emphasis>.
165
 
        </para>
166
 
        <para>The diagram takes the name of the file (without the extension).</para>
167
 
        <para/>
168
 
      </listitem>
169
 
      <listitem>
170
 
        <para>
171
 
          <emphasis role="bold">File:Export (Ctrl+E)</emphasis>
172
 
        </para>
173
 
        <para>
174
 
          This item is used to export a figure of the current <emphasis>Xcos</emphasis> diagram. The export can be done
175
 
          in the WBMP, GIF, HTML, JPEG, JPG, PNG, SVG or VML formats.
176
 
        </para>
177
 
        <para/>
178
 
      </listitem>
179
 
      <listitem>
180
 
        <para>
181
 
          <emphasis role="bold">File:Recent Files</emphasis>
182
 
        </para>
183
 
        <para>Via this menu, you have a quick access to the recent opened files.</para>
184
 
        <para/>
185
 
      </listitem>
186
 
      <listitem>
187
 
        <para>
188
 
          <emphasis role="bold">File:Print (Ctrl+P)</emphasis>
189
 
          <inlinemediaobject>
190
 
            <imageobject>
191
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/document-print.png"/>
192
 
            </imageobject>
193
 
          </inlinemediaobject>
194
 
        </para>
195
 
        <para>Print the current diagram onto a printer.</para>
196
 
        <para/>
197
 
      </listitem>
198
 
      <listitem>
199
 
        <para>
200
 
          <emphasis role="bold">File:Close (Ctrl+W)</emphasis>
201
 
        </para>
202
 
        <para>
203
 
          If several diagrams are opened, the <emphasis>Close</emphasis> action the current diagram. If only one diagram is
204
 
          opened, the <emphasis>Close</emphasis> action will close <emphasis>Xcos</emphasis>. The auxiliary windows as
205
 
          viewport, palettes, etc are also closed if
206
 
          necessary.
207
 
        </para>
208
 
        <para/>
209
 
      </listitem>
210
 
      <listitem>
211
 
        <para>
212
 
          <emphasis role="bold">File:Quit (Ctrl+Q)</emphasis>
213
 
        </para>
214
 
        <para>
215
 
          The <emphasis>Quit</emphasis> action will close <emphasis>Xcos</emphasis>.
216
 
          The auxiliary windows as viewport, palettes, etc are also closed if necessary.
217
 
        </para>
218
 
      </listitem>
219
 
    </itemizedlist>
220
 
  </refsection>
221
 
  <refsection id="Editmenu_Menu_entries">
222
 
    <title>Edit menu</title>
223
 
    <mediaobject>
224
 
      <imageobject>
225
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_edit.png"/>
226
 
      </imageobject>
227
 
    </mediaobject>
228
 
    <para/>
229
 
    <itemizedlist>
230
 
      <listitem>
231
 
        <para>
232
 
          <emphasis role="bold">Edit:Undo (Ctrl+Z)</emphasis>
233
 
          <inlinemediaobject>
234
 
            <imageobject>
235
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-undo.png"/>
236
 
            </imageobject>
237
 
          </inlinemediaobject>
238
 
        </para>
239
 
        <para>
240
 
          Select the <emphasis>Undo</emphasis> menu item to undo the last edit operation.
241
 
        </para>
242
 
      </listitem>
243
 
      <listitem>
244
 
        <para>
245
 
          <emphasis role="bold">Edit:Redo (Ctrl+Y)</emphasis>
246
 
          <inlinemediaobject>
247
 
            <imageobject>
248
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-redo.png"/>
249
 
            </imageobject>
250
 
          </inlinemediaobject>
251
 
        </para>
252
 
        <para>
253
 
          Select the <emphasis>Redo</emphasis> menu item to redo the last undo edit operation.
254
 
        </para>
255
 
        <para/>
256
 
      </listitem>
257
 
      <listitem>
258
 
        <para>
259
 
          <emphasis role="bold">Edit:Cut (Ctrl+X)</emphasis>
260
 
          <inlinemediaobject>
261
 
            <imageobject>
262
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-cut.png"/>
263
 
            </imageobject>
264
 
          </inlinemediaobject>
265
 
        </para>
266
 
        <para>
267
 
          <emphasis>Cut</emphasis> is used to remove the selected objects from the diagram and to copy them in the clipboard.
268
 
          When you cut a block all links connected to it are deleted as well.
269
 
        </para>
270
 
        <para/>
271
 
      </listitem>
272
 
      <listitem>
273
 
        <para>
274
 
          <emphasis role="bold">Edit:Copy (Ctrl+C)</emphasis>
275
 
          <inlinemediaobject>
276
 
            <imageobject>
277
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-copy.png"/>
278
 
            </imageobject>
279
 
          </inlinemediaobject>
280
 
        </para>
281
 
        <para>
282
 
          <emphasis>Copy</emphasis> is used to place a copy of the selected in the clipboard.
283
 
        </para>
284
 
        <para/>
285
 
      </listitem>
286
 
      <listitem>
287
 
        <para>
288
 
          <emphasis role="bold">Edit:Paste (Ctrl+V)</emphasis>
289
 
          <inlinemediaobject>
290
 
            <imageobject>
291
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-paste.png"/>
292
 
            </imageobject>
293
 
          </inlinemediaobject>
294
 
        </para>
295
 
        <para>
296
 
          <emphasis>Paste</emphasis> places the content of the clipboard in the current diagram.
297
 
        </para>
298
 
        <para/>
299
 
      </listitem>
300
 
      <listitem>
301
 
        <para>
302
 
          <emphasis role="bold">Edit:Delete (Delete)</emphasis>
303
 
          <inlinemediaobject>
304
 
            <imageobject>
305
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-delete.png"/>
306
 
            </imageobject>
307
 
          </inlinemediaobject>
308
 
        </para>
309
 
        <para>
310
 
          To delete blocks or links, select objects to be deleted and then the <emphasis>Delete</emphasis> menu item.
311
 
          When you delete a block all links connected to it are deleted as well.
312
 
        </para>
313
 
        <para/>
314
 
      </listitem>
315
 
      <listitem>
316
 
        <para>
317
 
          <emphasis role="bold">Edit:Select all (Ctrl+A)</emphasis>
318
 
        </para>
319
 
        <para>
320
 
          <emphasis>Select all</emphasis> the blocks in the current diagram.
321
 
        </para>
322
 
        <para/>
323
 
      </listitem>
324
 
      <listitem>
325
 
        <para>
326
 
          <emphasis role="bold">Edit:Invert selection</emphasis>
327
 
        </para>
328
 
        <para>Invert the current selection.</para>
329
 
        <para/>
330
 
      </listitem>
331
 
      <listitem>
332
 
        <para>
333
 
          <emphasis role="bold">Edit:Block Parameters (Ctrl+B)</emphasis>
334
 
          <inlinemediaobject>
335
 
            <imageobject>
336
 
              <imagedata fileref="../../../gui/images/icons/16x16/categories/applications-system.png"/>
337
 
            </imageobject>
338
 
          </inlinemediaobject>
339
 
        </para>
340
 
        <para>
341
 
          Open the block configuration dialog for the current selected block. The configuration depends of the used block
342
 
          (see the block help to obtain more information on its configuration).
343
 
        </para>
344
 
        <para/>
345
 
      </listitem>
346
 
      <listitem>
347
 
        <para>
348
 
          <emphasis role="bold">Edit:Region to superblock</emphasis>
349
 
          <inlinemediaobject>
350
 
            <imageobject>
351
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/object-group.png"/>
352
 
            </imageobject>
353
 
          </inlinemediaobject>
354
 
        </para>
355
 
        <para>Convert a selection of blocks into a superblock.</para>
356
 
      </listitem>
357
 
    </itemizedlist>
358
 
  </refsection>
359
 
  <refsection id="Viewmenu_Menu_entries">
360
 
    <title>View menu</title>
361
 
    <mediaobject>
362
 
      <imageobject>
363
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_view.png"/>
364
 
      </imageobject>
365
 
    </mediaobject>
366
 
    <para/>
367
 
    <itemizedlist>
368
 
      <listitem>
369
 
        <para>
370
 
          <emphasis role="bold">View:Zoom in (Ctrl+Plus)</emphasis>
371
 
          <inlinemediaobject>
372
 
            <imageobject>
373
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-in.png"/>
374
 
            </imageobject>
375
 
          </inlinemediaobject>
376
 
        </para>
377
 
        <para>When you select this menu item the diagram is zoomed in by a factor of 10%.</para>
378
 
        <para/>
379
 
      </listitem>
380
 
      <listitem>
381
 
        <para>
382
 
          <emphasis role="bold">View:Zoom out (Ctrl+Minus)</emphasis>
383
 
          <inlinemediaobject>
384
 
            <imageobject>
385
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-out.png"/>
386
 
            </imageobject>
387
 
          </inlinemediaobject>
388
 
        </para>
389
 
        <para>When you select this menu item the diagram is zoomed out by a factor of 10%.</para>
390
 
        <para/>
391
 
      </listitem>
392
 
      <listitem>
393
 
        <para>
394
 
          <emphasis role="bold">View:Fit diagram to view</emphasis>
395
 
          <inlinemediaobject>
396
 
            <imageobject>
397
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-fit-drawing.png"/>
398
 
            </imageobject>
399
 
          </inlinemediaobject>
400
 
        </para>
401
 
        <para>When you select this menu item the diagram is fit to the size of the current window.</para>
402
 
        <para/>
403
 
      </listitem>
404
 
      <listitem>
405
 
        <para>
406
 
          <emphasis role="bold">View:Normal 100%</emphasis>
407
 
          <inlinemediaobject>
408
 
            <imageobject>
409
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-original.png"/>
410
 
            </imageobject>
411
 
          </inlinemediaobject>
412
 
        </para>
413
 
        <para>Resize the diagram components at their normal displaying dimensions.</para>
414
 
        <para/>
415
 
      </listitem>
416
 
      <listitem>
417
 
        <para>
418
 
          <emphasis role="bold">View:Palette browser</emphasis>
419
 
        </para>
420
 
        <para>Open the palette browser.</para>
421
 
        <para/>
422
 
      </listitem>
423
 
      <listitem>
424
 
        <para>
425
 
          <emphasis role="bold">View:Diagram browser</emphasis>
426
 
        </para>
427
 
        <para>
428
 
          Displays a window which lists the global properties of a diagram and all its objects (blocks and links). It presents in
429
 
          a tree form the <emphasis>scs_m</emphasis> structure content of the diagram.
430
 
        </para>
431
 
        <para/>
432
 
      </listitem>
433
 
      <listitem>
434
 
        <para>
435
 
          <emphasis role="bold">View:Viewport</emphasis>
436
 
        </para>
437
 
        <para>
438
 
          Display the <emphasis>Viewport</emphasis> window. This window is a complete image of the current diagram. With
439
 
          the <emphasis>Viewport</emphasis>, you can move the displaying working area onto a part of the diagram.
440
 
          You can zoom and unzoom part of a diagram.
441
 
        </para>
442
 
        <para/>
443
 
        <mediaobject>
444
 
          <imageobject>
445
 
            <imagedata fileref="../gui/xcos_menu_entries/en_US/xcos_menu_viewport.png"/>
446
 
          </imageobject>
447
 
        </mediaobject>
448
 
        <para/>
449
 
        <para>
450
 
          Above, you have an example of the viewport docked in the <emphasis>Xcos</emphasis> which is used to zoom on a
451
 
          part of a diagram. On the left the editor window presents the zoomed part of the diagram.
452
 
        </para>
453
 
        <para/>
454
 
      </listitem>
455
 
      <listitem>
456
 
        <para>
457
 
          <emphasis role="bold">View:Details</emphasis>
458
 
        </para>
459
 
        <para>
460
 
          Displays a window by selected block which list properties of block. It presents in a tree form
461
 
          the <emphasis>scicos_block</emphasis> structure content of the blocks.
462
 
        </para>
463
 
      </listitem>
464
 
    </itemizedlist>
465
 
  </refsection>
466
 
  <refsection id="Simulatemenu_Menu_entries">
467
 
    <title>Simulation menu</title>
468
 
    <mediaobject>
469
 
      <imageobject>
470
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_simulation.png"/>
471
 
      </imageobject>
472
 
    </mediaobject>
473
 
    <para/>
474
 
    <itemizedlist>
475
 
      <listitem>
476
 
        <para>
477
 
          <emphasis role="bold">Simulation:Setup</emphasis>
478
 
          <inlinemediaobject>
479
 
            <imageobject>
480
 
              <imagedata fileref="../../../xcos/images/icons/16x16/categories/preferences-desktop.png"/>
481
 
            </imageobject>
482
 
          </inlinemediaobject>
483
 
        </para>
484
 
        <para/>
485
 
        <para>
486
 
          In the main <emphasis>Xcos</emphasis> window, clicking on the <emphasis>Setup</emphasis> menu item invokes
487
 
          the dialog box below that allows you to change integration (simulation) parameters:
488
 
        </para>
489
 
        <para/>
490
 
        <mediaobject>
491
 
          <imageobject>
492
 
            <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_set_simulation_parameters_gui.png"/>
493
 
          </imageobject>
494
 
        </mediaobject>
495
 
        <para/>
496
 
        <itemizedlist>
497
 
          <listitem>
498
 
            <para>
499
 
              <emphasis role="bold">Final integration time</emphasis>: integration (simulation)
500
 
              ends at this time, it always starts from 0
501
 
            </para>
502
 
            <para/>
503
 
          </listitem>
504
 
          <listitem>
505
 
            <para>
506
 
              <emphasis role="bold">Real time scaling</emphasis>: forces real time simulation
507
 
              by setting <emphasis>Xcos</emphasis> simulation in unit of time to 1 second.
508
 
            </para>
509
 
            <para/>
510
 
          </listitem>
511
 
          <listitem>
512
 
            <para>
513
 
              <emphasis role="bold">Absolute and relative error tolerances</emphasis>: solver
514
 
              properties.
515
 
            </para>
516
 
            <para/>
517
 
          </listitem>
518
 
          <listitem>
519
 
            <para>
520
 
              <emphasis role="bold">Time tolerance</emphasis>: the smallest time interval for which
521
 
              the ode solver is used to update continuous states.
522
 
            </para>
523
 
            <para/>
524
 
          </listitem>
525
 
          <listitem>
526
 
            <para>
527
 
              <emphasis role="bold">Max integration time interval</emphasis>: the maximum time
528
 
              interval for each call to solver.it must be reduced if the error message "Too many calls" is encountered
529
 
            </para>
530
 
          </listitem>
531
 
          <listitem>
532
 
            <para>
533
 
              <emphasis role="bold">Solver</emphasis>: select the numerical solver to be used. You have the
534
 
              choice between an ordinary differential equations (ODE) solver and an algebraic differential
535
 
              equations solver (IDA). If <emphasis>Xcos</emphasis> detects that your model requires an IDA
536
 
              solver, <emphasis> Xcos</emphasis> displays an information box on the automatic switching to
537
 
              the IDA solver.
538
 
            </para>
539
 
            <para/>
540
 
          </listitem>
541
 
          <listitem>
542
 
            <para>
543
 
              <emphasis role="bold">Max step size</emphasis>: maximum time step taken by the solver. This parameter is useful
544
 
              to search localized singularities in a monotonic system response. For this type of response, the numerical solver
545
 
              increase automatically the step size for decrease the calculation time. If you think that your system is in this
546
 
              case, decrease the value of this parameter.
547
 
            </para>
548
 
            <para/>
549
 
          </listitem>
550
 
          <listitem>
551
 
            <para>
552
 
              <emphasis role="bold">Set context</emphasis>: see explanation below
553
 
            </para>
554
 
            <para/>
555
 
          </listitem>
556
 
          <listitem>
557
 
            <para>
558
 
              <emphasis role="bold">Default</emphasis>: this button reset the simulation parameters
559
 
              to their factory values.
560
 
            </para>
561
 
            <para/>
562
 
          </listitem>
563
 
        </itemizedlist>
564
 
        <para>
565
 
          For more information on the solver look at the <xref linkend="Seealso_Menu_entries">
566
 
            See Also
567
 
          </xref>
568
 
          section.
569
 
        </para>
570
 
        <para/>
571
 
      </listitem>
572
 
      <listitem>
573
 
        <para>
574
 
          <emphasis role="bold">Execution Trace and Debug</emphasis>
575
 
        </para>
576
 
        <para>
577
 
          Set <emphasis>Xcos</emphasis> in debug mode. This item opens the following dialog box in which you can choose
578
 
          the debugging mode. For more information, see the command <link linkend="scicos_debug">scicos_debug</link>
579
 
        </para>
580
 
        <para/>
581
 
      </listitem>
582
 
      <listitem>
583
 
        <para>
584
 
          <emphasis role="bold">Simulation:Set Context</emphasis>
585
 
        </para>
586
 
        <para>
587
 
          When you select this menu item you obtain this dialog:
588
 
        </para>
589
 
        <para/>
590
 
        <mediaobject>
591
 
          <imageobject>
592
 
            <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_set_context_gui.png"/>
593
 
          </imageobject>
594
 
        </mediaobject>
595
 
        <para/>
596
 
        <para>
597
 
          You can enter here <emphasis>Scilab</emphasis> instructions for defining the symbolic <emphasis>Xcos</emphasis>
598
 
          parameters used in block definitions or to do whatever you want.
599
 
        </para>
600
 
        <para>
601
 
          These instructions will be evaluated each time the diagram is loaded. If you change the value of a symbolic
602
 
          <emphasis>Xcos</emphasis> parameters in the context, all the blocks that contains this symbolic parameter are
603
 
          updated when you click on <emphasis>OK</emphasis>. By example if you want to set the value
604
 
          of gain of several blocks to a value which depends on a single value, you can proceed like this :
605
 
        </para>
606
 
        <orderedlist>
607
 
          <listitem>
608
 
            <para>
609
 
              We have three GAINBLK_f blocks, open the <emphasis>Set context</emphasis> dialog and
610
 
              writes the symbolic variables:
611
 
            </para>
612
 
            <para/>
613
 
            <programlisting><![CDATA[
 
26
    <refnamediv>
 
27
        <refname>Menu_Entries</refname>
 
28
        <refpurpose>Xcos editor menu entries</refpurpose>
 
29
    </refnamediv>
 
30
    <refsection id="Contents_xcos_menu_entries">
 
31
        <title>Contents</title>
 
32
        <para>
 
33
            This section presents briefly all the menu entries of the <emphasis>Xcos</emphasis> editor. Many items are also
 
34
            available in pull-down menus shown by a right click when the mouse cursor is on a block, a link or in the main
 
35
            <emphasis>Xcos</emphasis> window.
 
36
        </para>
 
37
        <itemizedlist>
 
38
            <listitem>
 
39
                <para>
 
40
                    <link linkend="xcos_menu_entries">Xcos editor menu entries</link>
 
41
                </para>
 
42
            </listitem>
 
43
            <listitem>
 
44
                <itemizedlist>
 
45
                    <listitem>
 
46
                        <para>
 
47
                            <xref linkend="Filemenu_Menu_entries">File menu</xref>
 
48
                        </para>
 
49
                    </listitem>
 
50
                    <listitem>
 
51
                        <para>
 
52
                            <xref linkend="Editmenu_Menu_entries">Edit menu</xref>
 
53
                        </para>
 
54
                    </listitem>
 
55
                    <listitem>
 
56
                        <para>
 
57
                            <xref linkend="Viewmenu_Menu_entries">View menu</xref>
 
58
                        </para>
 
59
                    </listitem>
 
60
                    <listitem>
 
61
                        <para>
 
62
                            <xref linkend="Simulatemenu_Menu_entries">Simulate menu</xref>
 
63
                        </para>
 
64
                    </listitem>
 
65
                    <listitem>
 
66
                        <para>
 
67
                            <xref linkend="Formatmenu_Menu_entries">Format menu</xref>
 
68
                        </para>
 
69
                    </listitem>
 
70
                    <listitem>
 
71
                        <para>
 
72
                            <xref linkend="Toolsmenu_Menu_entries">Tools menu</xref>
 
73
                        </para>
 
74
                    </listitem>
 
75
                    <listitem>
 
76
                        <para>
 
77
                            <xref linkend="Helpmenu_Menu_entries">? menu</xref>
 
78
                        </para>
 
79
                    </listitem>
 
80
                    <listitem>
 
81
                        <para>
 
82
                            <xref linkend="Seealso_Menu_entries">See Also</xref>
 
83
                        </para>
 
84
                    </listitem>
 
85
                </itemizedlist>
 
86
            </listitem>
 
87
        </itemizedlist>
 
88
    </refsection>
 
89
    <refsection id="Filemenu_Menu_entries">
 
90
        <title>File menu</title>
 
91
        <mediaobject>
 
92
            <imageobject>
 
93
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_file.png"/>
 
94
            </imageobject>
 
95
        </mediaobject>
 
96
        <para/>
 
97
        <itemizedlist>
 
98
            <listitem>
 
99
                <para>
 
100
                    <emphasis role="bold"> File:New (Ctrl+N)</emphasis>
 
101
                    <inlinemediaobject>
 
102
                        <imageobject>
 
103
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/document-new.png"/>
 
104
                        </imageobject>
 
105
                    </inlinemediaobject>
 
106
                </para>
 
107
                <para>
 
108
                    Clicking on the <emphasis>New</emphasis> menu item open a new empty <emphasis>Xcos</emphasis> diagram in a new
 
109
                    window. With this menu, you can open a new diagram or a new palette.
 
110
                </para>
 
111
                <para/>
 
112
            </listitem>
 
113
            <listitem>
 
114
                <para>
 
115
                    <emphasis role="bold">File:Open (Ctrl+O)</emphasis>
 
116
                    <inlinemediaobject>
 
117
                        <imageobject>
 
118
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/document-open.png"/>
 
119
                        </imageobject>
 
120
                    </inlinemediaobject>
 
121
                </para>
 
122
                <para>
 
123
                    Select the <emphasis>Open</emphasis> menu item to load an XML (<emphasis>.xcos</emphasis>) or a binary file
 
124
                    (<emphasis>.cos</emphasis>) which contain saved block diagram or a palette. The command open a dialog box allows
 
125
                    you to choose the folder and the file.
 
126
                </para>
 
127
                <para/>
 
128
            </listitem>
 
129
            <listitem>
 
130
                <para>
 
131
                    <emphasis role="bold">File:Save (Ctrl+S)</emphasis>
 
132
                    <inlinemediaobject>
 
133
                        <imageobject>
 
134
                            <imagedata fileref="../../../gui/images/icons/16x16/devices/media-floppy.png"/>
 
135
                        </imageobject>
 
136
                    </inlinemediaobject>
 
137
                </para>
 
138
                <para>
 
139
                    Select the <emphasis>Save</emphasis> menu item to save the diagram in a
 
140
                    <emphasis>XML</emphasis> file.
 
141
                </para>
 
142
                <para>
 
143
                    If you select this menu item and you have never clicked on the <emphasis>Save</emphasis> or
 
144
                    <emphasis>Save As</emphasis> menu item, a dialog allows you to choose a directory and
 
145
                    specify a file name without extension. The default extension is <emphasis>.xcos</emphasis>.
 
146
                </para>
 
147
                <para>The diagram takes the name of the file (without the extension).</para>
 
148
                <para/>
 
149
            </listitem>
 
150
            <listitem>
 
151
                <para>
 
152
                    <emphasis role="bold">File:Save As (Ctrl+Shift+S)</emphasis>
 
153
                    <inlinemediaobject>
 
154
                        <imageobject>
 
155
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/document-save-as.png"/>
 
156
                        </imageobject>
 
157
                    </inlinemediaobject>
 
158
                </para>
 
159
                <para>
 
160
                    Select the <emphasis>Save As</emphasis> menu item to save the block diagram or palette in a file with a new name.
 
161
                </para>
 
162
                <para>
 
163
                    A dialog box allows specifying a file name without the extension and a saving folder.
 
164
                    The default extension is <emphasis>.xcos</emphasis>.
 
165
                </para>
 
166
                <para>The diagram takes the name of the file (without the extension).</para>
 
167
                <para/>
 
168
            </listitem>
 
169
            <listitem>
 
170
                <para>
 
171
                    <emphasis role="bold">File:Export (Ctrl+E)</emphasis>
 
172
                </para>
 
173
                <para>
 
174
                    This item is used to export a figure of the current <emphasis>Xcos</emphasis> diagram. The export can be done
 
175
                    in the WBMP, GIF, HTML, JPEG, JPG, PNG, SVG or VML formats.
 
176
                </para>
 
177
                <para/>
 
178
            </listitem>
 
179
            <listitem>
 
180
                <para>
 
181
                    <emphasis role="bold">File:Recent Files</emphasis>
 
182
                </para>
 
183
                <para>Via this menu, you have a quick access to the recent opened files.</para>
 
184
                <para/>
 
185
            </listitem>
 
186
            <listitem>
 
187
                <para>
 
188
                    <emphasis role="bold">File:Print (Ctrl+P)</emphasis>
 
189
                    <inlinemediaobject>
 
190
                        <imageobject>
 
191
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/document-print.png"/>
 
192
                        </imageobject>
 
193
                    </inlinemediaobject>
 
194
                </para>
 
195
                <para>Print the current diagram onto a printer.</para>
 
196
                <para/>
 
197
            </listitem>
 
198
            <listitem>
 
199
                <para>
 
200
                    <emphasis role="bold">File:Close (Ctrl+W)</emphasis>
 
201
                </para>
 
202
                <para>
 
203
                    If several diagrams are opened, the <emphasis>Close</emphasis> action the current diagram. If only one diagram is
 
204
                    opened, the <emphasis>Close</emphasis> action will close <emphasis>Xcos</emphasis>. The auxiliary windows as
 
205
                    viewport, palettes, etc are also closed if
 
206
                    necessary.
 
207
                </para>
 
208
                <para/>
 
209
            </listitem>
 
210
            <listitem>
 
211
                <para>
 
212
                    <emphasis role="bold">File:Quit (Ctrl+Q)</emphasis>
 
213
                </para>
 
214
                <para>
 
215
                    The <emphasis>Quit</emphasis> action will close <emphasis>Xcos</emphasis>.
 
216
                    The auxiliary windows as viewport, palettes, etc are also closed if necessary.
 
217
                </para>
 
218
            </listitem>
 
219
        </itemizedlist>
 
220
    </refsection>
 
221
    <refsection id="Editmenu_Menu_entries">
 
222
        <title>Edit menu</title>
 
223
        <mediaobject>
 
224
            <imageobject>
 
225
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_edit.png"/>
 
226
            </imageobject>
 
227
        </mediaobject>
 
228
        <para/>
 
229
        <itemizedlist>
 
230
            <listitem>
 
231
                <para>
 
232
                    <emphasis role="bold">Edit:Undo (Ctrl+Z)</emphasis>
 
233
                    <inlinemediaobject>
 
234
                        <imageobject>
 
235
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-undo.png"/>
 
236
                        </imageobject>
 
237
                    </inlinemediaobject>
 
238
                </para>
 
239
                <para>
 
240
                    Select the <emphasis>Undo</emphasis> menu item to undo the last edit operation.
 
241
                </para>
 
242
            </listitem>
 
243
            <listitem>
 
244
                <para>
 
245
                    <emphasis role="bold">Edit:Redo (Ctrl+Y)</emphasis>
 
246
                    <inlinemediaobject>
 
247
                        <imageobject>
 
248
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-redo.png"/>
 
249
                        </imageobject>
 
250
                    </inlinemediaobject>
 
251
                </para>
 
252
                <para>
 
253
                    Select the <emphasis>Redo</emphasis> menu item to redo the last undo edit operation.
 
254
                </para>
 
255
                <para/>
 
256
            </listitem>
 
257
            <listitem>
 
258
                <para>
 
259
                    <emphasis role="bold">Edit:Cut (Ctrl+X)</emphasis>
 
260
                    <inlinemediaobject>
 
261
                        <imageobject>
 
262
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-cut.png"/>
 
263
                        </imageobject>
 
264
                    </inlinemediaobject>
 
265
                </para>
 
266
                <para>
 
267
                    <emphasis>Cut</emphasis> is used to remove the selected objects from the diagram and to copy them in the clipboard.
 
268
                    When you cut a block all links connected to it are deleted as well.
 
269
                </para>
 
270
                <para/>
 
271
            </listitem>
 
272
            <listitem>
 
273
                <para>
 
274
                    <emphasis role="bold">Edit:Copy (Ctrl+C)</emphasis>
 
275
                    <inlinemediaobject>
 
276
                        <imageobject>
 
277
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-copy.png"/>
 
278
                        </imageobject>
 
279
                    </inlinemediaobject>
 
280
                </para>
 
281
                <para>
 
282
                    <emphasis>Copy</emphasis> is used to place a copy of the selected in the clipboard.
 
283
                </para>
 
284
                <para/>
 
285
            </listitem>
 
286
            <listitem>
 
287
                <para>
 
288
                    <emphasis role="bold">Edit:Paste (Ctrl+V)</emphasis>
 
289
                    <inlinemediaobject>
 
290
                        <imageobject>
 
291
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-paste.png"/>
 
292
                        </imageobject>
 
293
                    </inlinemediaobject>
 
294
                </para>
 
295
                <para>
 
296
                    <emphasis>Paste</emphasis> places the content of the clipboard in the current diagram.
 
297
                </para>
 
298
                <para/>
 
299
            </listitem>
 
300
            <listitem>
 
301
                <para>
 
302
                    <emphasis role="bold">Edit:Delete (Delete)</emphasis>
 
303
                    <inlinemediaobject>
 
304
                        <imageobject>
 
305
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/edit-delete.png"/>
 
306
                        </imageobject>
 
307
                    </inlinemediaobject>
 
308
                </para>
 
309
                <para>
 
310
                    To delete blocks or links, select objects to be deleted and then the <emphasis>Delete</emphasis> menu item.
 
311
                    When you delete a block all links connected to it are deleted as well.
 
312
                </para>
 
313
                <para/>
 
314
            </listitem>
 
315
            <listitem>
 
316
                <para>
 
317
                    <emphasis role="bold">Edit:Select all (Ctrl+A)</emphasis>
 
318
                </para>
 
319
                <para>
 
320
                    <emphasis>Select all</emphasis> the blocks in the current diagram.
 
321
                </para>
 
322
                <para/>
 
323
            </listitem>
 
324
            <listitem>
 
325
                <para>
 
326
                    <emphasis role="bold">Edit:Invert selection</emphasis>
 
327
                </para>
 
328
                <para>Invert the current selection.</para>
 
329
                <para/>
 
330
            </listitem>
 
331
            <listitem>
 
332
                <para>
 
333
                    <emphasis role="bold">Edit:Block Parameters (Ctrl+B)</emphasis>
 
334
                    <inlinemediaobject>
 
335
                        <imageobject>
 
336
                            <imagedata fileref="../../../gui/images/icons/16x16/categories/applications-system.png"/>
 
337
                        </imageobject>
 
338
                    </inlinemediaobject>
 
339
                </para>
 
340
                <para>
 
341
                    Open the block configuration dialog for the current selected block. The configuration depends of the used block
 
342
                    (see the block help to obtain more information on its configuration).
 
343
                </para>
 
344
                <para/>
 
345
            </listitem>
 
346
            <listitem>
 
347
                <para>
 
348
                    <emphasis role="bold">Edit:Region to superblock</emphasis>
 
349
                    <inlinemediaobject>
 
350
                        <imageobject>
 
351
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/object-group.png"/>
 
352
                        </imageobject>
 
353
                    </inlinemediaobject>
 
354
                </para>
 
355
                <para>Convert a selection of blocks into a superblock.</para>
 
356
            </listitem>
 
357
        </itemizedlist>
 
358
    </refsection>
 
359
    <refsection id="Viewmenu_Menu_entries">
 
360
        <title>View menu</title>
 
361
        <mediaobject>
 
362
            <imageobject>
 
363
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_view.png"/>
 
364
            </imageobject>
 
365
        </mediaobject>
 
366
        <para/>
 
367
        <itemizedlist>
 
368
            <listitem>
 
369
                <para>
 
370
                    <emphasis role="bold">View:Zoom in (Ctrl+Plus)</emphasis>
 
371
                    <inlinemediaobject>
 
372
                        <imageobject>
 
373
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-in.png"/>
 
374
                        </imageobject>
 
375
                    </inlinemediaobject>
 
376
                </para>
 
377
                <para>When you select this menu item the diagram is zoomed in by a factor of 10%.</para>
 
378
                <para/>
 
379
            </listitem>
 
380
            <listitem>
 
381
                <para>
 
382
                    <emphasis role="bold">View:Zoom out (Ctrl+Minus)</emphasis>
 
383
                    <inlinemediaobject>
 
384
                        <imageobject>
 
385
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-out.png"/>
 
386
                        </imageobject>
 
387
                    </inlinemediaobject>
 
388
                </para>
 
389
                <para>When you select this menu item the diagram is zoomed out by a factor of 10%.</para>
 
390
                <para/>
 
391
            </listitem>
 
392
            <listitem>
 
393
                <para>
 
394
                    <emphasis role="bold">View:Fit diagram to view</emphasis>
 
395
                    <inlinemediaobject>
 
396
                        <imageobject>
 
397
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-fit-drawing.png"/>
 
398
                        </imageobject>
 
399
                    </inlinemediaobject>
 
400
                </para>
 
401
                <para>When you select this menu item the diagram is fit to the size of the current window.</para>
 
402
                <para/>
 
403
            </listitem>
 
404
            <listitem>
 
405
                <para>
 
406
                    <emphasis role="bold">View:Normal 100%</emphasis>
 
407
                    <inlinemediaobject>
 
408
                        <imageobject>
 
409
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/zoom-original.png"/>
 
410
                        </imageobject>
 
411
                    </inlinemediaobject>
 
412
                </para>
 
413
                <para>Resize the diagram components at their normal displaying dimensions.</para>
 
414
                <para/>
 
415
            </listitem>
 
416
            <listitem>
 
417
                <para>
 
418
                    <emphasis role="bold">View:Palette browser</emphasis>
 
419
                </para>
 
420
                <para>Open the palette browser.</para>
 
421
                <para/>
 
422
            </listitem>
 
423
            <listitem>
 
424
                <para>
 
425
                    <emphasis role="bold">View:Diagram browser</emphasis>
 
426
                </para>
 
427
                <para>
 
428
                    Displays a window which lists the global properties of a diagram and all its objects (blocks and links). It presents in
 
429
                    a tree form the <emphasis>scs_m</emphasis> structure content of the diagram.
 
430
                </para>
 
431
                <para/>
 
432
            </listitem>
 
433
            <listitem>
 
434
                <para>
 
435
                    <emphasis role="bold">View:Viewport</emphasis>
 
436
                </para>
 
437
                <para>
 
438
                    Display the <emphasis>Viewport</emphasis> window. This window is a complete image of the current diagram. With
 
439
                    the <emphasis>Viewport</emphasis>, you can move the displaying working area onto a part of the diagram.
 
440
                    You can zoom and unzoom part of a diagram.
 
441
                </para>
 
442
                <para/>
 
443
                <mediaobject>
 
444
                    <imageobject>
 
445
                        <imagedata fileref="../gui/xcos_menu_entries/en_US/xcos_menu_viewport.png"/>
 
446
                    </imageobject>
 
447
                </mediaobject>
 
448
                <para/>
 
449
                <para>
 
450
                    Above, you have an example of the viewport docked in the <emphasis>Xcos</emphasis> which is used to zoom on a
 
451
                    part of a diagram. On the left the editor window presents the zoomed part of the diagram.
 
452
                </para>
 
453
                <para/>
 
454
            </listitem>
 
455
            <listitem>
 
456
                <para>
 
457
                    <emphasis role="bold">View:Details</emphasis>
 
458
                </para>
 
459
                <para>
 
460
                    Displays a window by selected block which list properties of block. It presents in a tree form
 
461
                    the <emphasis>scicos_block</emphasis> structure content of the blocks.
 
462
                </para>
 
463
            </listitem>
 
464
        </itemizedlist>
 
465
    </refsection>
 
466
    <refsection id="Simulatemenu_Menu_entries">
 
467
        <title>Simulation menu</title>
 
468
        <mediaobject>
 
469
            <imageobject>
 
470
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_simulation.png"/>
 
471
            </imageobject>
 
472
        </mediaobject>
 
473
        <para/>
 
474
        <itemizedlist>
 
475
            <listitem>
 
476
                <para>
 
477
                    <emphasis role="bold">Simulation:Setup</emphasis>
 
478
                    <inlinemediaobject>
 
479
                        <imageobject>
 
480
                            <imagedata fileref="../../../xcos/images/icons/16x16/categories/preferences-desktop.png"/>
 
481
                        </imageobject>
 
482
                    </inlinemediaobject>
 
483
                </para>
 
484
                <para/>
 
485
                <para>
 
486
                    In the main <emphasis>Xcos</emphasis> window, clicking on the <emphasis>Setup</emphasis> menu item invokes
 
487
                    the dialog box below that allows you to change integration (simulation) parameters:
 
488
                </para>
 
489
                <para/>
 
490
                <mediaobject>
 
491
                    <imageobject>
 
492
                        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_set_simulation_parameters_gui.png"/>
 
493
                    </imageobject>
 
494
                </mediaobject>
 
495
                <para/>
 
496
                <itemizedlist>
 
497
                    <listitem>
 
498
                        <para>
 
499
                            <emphasis role="bold">Final integration time</emphasis>: integration (simulation)
 
500
                            ends at this time, it always starts from 0
 
501
                        </para>
 
502
                        <para/>
 
503
                    </listitem>
 
504
                    <listitem>
 
505
                        <para>
 
506
                            <emphasis role="bold">Real time scaling</emphasis>: forces real time simulation
 
507
                            by setting <emphasis>Xcos</emphasis> simulation in unit of time to 1 second.
 
508
                        </para>
 
509
                        <para/>
 
510
                    </listitem>
 
511
                    <listitem>
 
512
                        <para>
 
513
                            <emphasis role="bold">Absolute and relative error tolerances</emphasis>: solver
 
514
                            properties.
 
515
                        </para>
 
516
                        <para/>
 
517
                    </listitem>
 
518
                    <listitem>
 
519
                        <para>
 
520
                            <emphasis role="bold">Time tolerance</emphasis>: the smallest time interval for which
 
521
                            the ode solver is used to update continuous states.
 
522
                        </para>
 
523
                        <para/>
 
524
                    </listitem>
 
525
                    <listitem>
 
526
                        <para>
 
527
                            <emphasis role="bold">Max integration time interval</emphasis>: the maximum time
 
528
                            interval for each call to solver.it must be reduced if the error message "Too many calls" is encountered
 
529
                        </para>
 
530
                    </listitem>
 
531
                    <listitem>
 
532
                        <para>
 
533
                            <emphasis role="bold">Solver</emphasis>: select the numerical solver to be used. You have the
 
534
                            choice between an ordinary differential equations (ODE) solver and an algebraic differential
 
535
                            equations solver (IDA). If <emphasis>Xcos</emphasis> detects that your model requires an IDA
 
536
                            solver, <emphasis> Xcos</emphasis> displays an information box on the automatic switching to
 
537
                            the IDA solver.
 
538
                        </para>
 
539
                        <para/>
 
540
                    </listitem>
 
541
                    <listitem>
 
542
                        <para>
 
543
                            <emphasis role="bold">Max step size</emphasis>: maximum time step taken by the solver. This parameter is useful
 
544
                            to search localized singularities in a monotonic system response. For this type of response, the numerical solver
 
545
                            increase automatically the step size for decrease the calculation time. If you think that your system is in this
 
546
                            case, decrease the value of this parameter.
 
547
                        </para>
 
548
                        <para/>
 
549
                    </listitem>
 
550
                    <listitem>
 
551
                        <para>
 
552
                            <emphasis role="bold">Set context</emphasis>: see explanation below
 
553
                        </para>
 
554
                        <para/>
 
555
                    </listitem>
 
556
                    <listitem>
 
557
                        <para>
 
558
                            <emphasis role="bold">Default</emphasis>: this button reset the simulation parameters
 
559
                            to their factory values.
 
560
                        </para>
 
561
                        <para/>
 
562
                    </listitem>
 
563
                </itemizedlist>
 
564
                <para>
 
565
                    For more information on the solver look at the <xref linkend="Seealso_Menu_entries">
 
566
                        See Also
 
567
                    </xref>
 
568
                    section.
 
569
                </para>
 
570
                <para/>
 
571
            </listitem>
 
572
            <listitem>
 
573
                <para>
 
574
                    <emphasis role="bold">Execution Trace and Debug</emphasis>
 
575
                </para>
 
576
                <para>
 
577
                    Set <emphasis>Xcos</emphasis> in debug mode. This item opens the following dialog box in which you can choose
 
578
                    the debugging mode. For more information, see the command <link linkend="scicos_debug">scicos_debug</link>
 
579
                </para>
 
580
                <para/>
 
581
            </listitem>
 
582
            <listitem>
 
583
                <para>
 
584
                    <emphasis role="bold">Simulation:Set Context</emphasis>
 
585
                </para>
 
586
                <para>
 
587
                    When you select this menu item you obtain this dialog:
 
588
                </para>
 
589
                <para/>
 
590
                <mediaobject>
 
591
                    <imageobject>
 
592
                        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_set_context_gui.png"/>
 
593
                    </imageobject>
 
594
                </mediaobject>
 
595
                <para/>
 
596
                <para>
 
597
                    You can enter here <emphasis>Scilab</emphasis> instructions for defining the symbolic <emphasis>Xcos</emphasis>
 
598
                    parameters used in block definitions or to do whatever you want.
 
599
                </para>
 
600
                <para>
 
601
                    These instructions will be evaluated each time the diagram is loaded. If you change the value of a symbolic
 
602
                    <emphasis>Xcos</emphasis> parameters in the context, all the blocks that contains this symbolic parameter are
 
603
                    updated when you click on <emphasis>OK</emphasis>. By example if you want to set the value
 
604
                    of gain of several blocks to a value which depends on a single value, you can proceed like this :
 
605
                </para>
 
606
                <orderedlist>
 
607
                    <listitem>
 
608
                        <para>
 
609
                            We have three GAINBLK_f blocks, open the <emphasis>Set context</emphasis> dialog and
 
610
                            writes the symbolic variables:
 
611
                        </para>
 
612
                        <para/>
 
613
                        <programlisting><![CDATA[
614
614
              A = 1.5;
615
615
              B = 2*A;
616
616
              C = 3*A;
617
617
            ]]></programlisting>
618
 
            <para/>
619
 
          </listitem>
620
 
          <listitem>
621
 
            <para>
622
 
              Then, open successively each block parameters dialog and set for the gain value the name of
623
 
              required symbolic value, here <emphasis>A</emphasis>,<emphasis> B</emphasis> and
624
 
              <emphasis>C</emphasis>.
625
 
            </para>
626
 
          </listitem>
627
 
        </orderedlist>
628
 
        <para/>
629
 
      </listitem>
630
 
      <listitem>
631
 
        <para>
632
 
          <emphasis role="bold">Simulate:Compile</emphasis>
633
 
        </para>
634
 
        <para>
635
 
          Select the <emphasis>Compile</emphasis> menu item to compile the block diagram. This
636
 
          menu item need never be used since compilation is performed automatically, if necessary,
637
 
          before the beginning of every simulation (<emphasis>Run</emphasis> menu item). Normally,
638
 
          a new compilation is not needed if only system parameters and internal states are modified.
639
 
          In some cases however these modifications are not correctly updated and a manual compilation may be
640
 
          needed before a <emphasis>Restart</emphasis> or a <emphasis>Continue</emphasis>.
641
 
        </para>
642
 
        <para>
643
 
          <emphasis role="bold">Please report to us if you encounter such a case.</emphasis>
644
 
          <ulink url="http://bugzilla.scilab.org/">
645
 
            Report bugs and wishes about <emphasis>Scilab</emphasis>
646
 
          </ulink>
647
 
        </para>
648
 
        <para/>
649
 
      </listitem>
650
 
      <listitem>
651
 
        <para>
652
 
          <emphasis role="bold">Simulate:Modelica initialize</emphasis>
653
 
        </para>
654
 
        <para>
655
 
          This menu item opens a specific dialog to the <emphasis>Modelica</emphasis> compiler where you can see the
656
 
          components of your model and also select the solver between the <emphasis>Kinsol</emphasis>,
657
 
          <emphasis>Ida</emphasis>, <emphasis>Fsolve</emphasis>, <emphasis>Optim</emphasis>,
658
 
          <emphasis>Nelder Mead</emphasis> and <emphasis>Hompack</emphasis> solvers.
659
 
        </para>
660
 
        <para/>
661
 
      </listitem>
662
 
      <listitem>
663
 
        <para>
664
 
          <emphasis role="bold">Simulate:Start</emphasis>
665
 
          <inlinemediaobject>
666
 
            <imageobject>
667
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/media-playback-start.png"/>
668
 
            </imageobject>
669
 
          </inlinemediaobject>
670
 
        </para>
671
 
        <para>
672
 
          Select the <emphasis>Start</emphasis> menu item to start the simulation. If the system
673
 
          has already been simulated, a dialog box appears where you can choose to
674
 
          <emphasis>Continue</emphasis>, <emphasis>Restart</emphasis> or <emphasis>End</emphasis>
675
 
          the simulation.
676
 
        </para>
677
 
        <para/>
678
 
      </listitem>
679
 
      <listitem>
680
 
        <para>
681
 
          <emphasis role="bold">Simulation:Stop</emphasis>
682
 
          <inlinemediaobject>
683
 
            <imageobject>
684
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/process-stop.png"/>
685
 
            </imageobject>
686
 
          </inlinemediaobject>
687
 
        </para>
688
 
        <para>
689
 
          You may interrupt the simulation by clicking on the <emphasis>Stop</emphasis> menu item
690
 
          or on the toolbar button. You can change any of the block parameters and continue the
691
 
          simulation with the new values.
692
 
        </para>
693
 
      </listitem>
694
 
    </itemizedlist>
695
 
  </refsection>
696
 
  <refsection id="Formatmenu_Menu_entries">
697
 
    <title>Format menu</title>
698
 
    <mediaobject>
699
 
      <imageobject>
700
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format.png"/>
701
 
      </imageobject>
702
 
    </mediaobject>
703
 
    <itemizedlist>
704
 
      <listitem>
705
 
        <para>
706
 
          <emphasis role="bold">Format:Rotate (Ctrl+R)</emphasis>
707
 
          <inlinemediaobject>
708
 
            <imageobject>
709
 
              <imagedata fileref="../../../gui/images/icons/16x16/actions/transform-rotate.png"/>
710
 
            </imageobject>
711
 
          </inlinemediaobject>
712
 
        </para>
713
 
        <para>
714
 
          Rotate allows to turn a block on the left with an of 90°. Rotation affects all the selected blocks.
715
 
        </para>
716
 
        <para/>
717
 
      </listitem>
718
 
      <listitem>
719
 
        <para>
720
 
          <emphasis role="bold">Format:Flip (Ctrl+F)</emphasis>
721
 
          <inlinemediaobject>
722
 
            <imageobject>
723
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/transform-flip.png"/>
724
 
            </imageobject>
725
 
          </inlinemediaobject>
726
 
        </para>
727
 
        <para>
728
 
          To reverse the positions of the activation inputs and outputs set at the top and the bottom of a block, select a block
729
 
          and select the <emphasis>Flip</emphasis> menu item. This does not affect the order, nor the position of the input and
730
 
          output event ports which are numbered from left to right. Flipping affects all the selected blocks.
731
 
        </para>
732
 
        <para/>
733
 
      </listitem>
734
 
      <listitem>
735
 
        <para>
736
 
          <emphasis role="bold">Format:Mirror (Ctrl+M)</emphasis>
737
 
          <inlinemediaobject>
738
 
            <imageobject>
739
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/transform-mirror.png"/>
740
 
            </imageobject>
741
 
          </inlinemediaobject>
742
 
        </para>
743
 
        <para>
744
 
          To reverse the positions of the (regular) inputs and outputs set on the left and the right of a block, select a
745
 
          block and select the <emphasis>Mirror</emphasis> menu item. This does not affect the order, nor the position of
746
 
          the input and output ports which are numbered from top to bottom. Mirroring affects all the selected blocks.
747
 
        </para>
748
 
        <para/>
749
 
      </listitem>
750
 
      <listitem>
751
 
        <para>
752
 
          <emphasis role="bold">Format:Show/Hide shadow</emphasis>
753
 
        </para>
754
 
        <para>This menu allows to select 3D shape for selected blocks and associated parameters.</para>
755
 
        <para/>
756
 
      </listitem>
757
 
      <listitem>
758
 
        <para>
759
 
          <emphasis role="bold">Format:Align Blocks</emphasis>
760
 
        </para>
761
 
        <para/>
762
 
        <mediaobject>
763
 
          <imageobject>
764
 
            <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format_align.png"/>
765
 
          </imageobject>
766
 
        </mediaobject>
767
 
        <para/>
768
 
        <para>
769
 
          When you select several blocks, it is possible to align them on horizontal axis (<emphasis>Top</emphasis>,
770
 
          <emphasis>Bottom</emphasis> and <emphasis>Middle</emphasis>) or on vertical axis (<emphasis>Left</emphasis>,
771
 
          <emphasis>Right</emphasis>, <emphasis>Center</emphasis>).
772
 
        </para>
773
 
        <para/>
774
 
      </listitem>
775
 
      <listitem>
776
 
        <para>
777
 
          <emphasis role="bold">Format: Border Color</emphasis>
778
 
          <inlinemediaobject>
779
 
            <imageobject>
780
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/draw-brush.png"/>
781
 
            </imageobject>
782
 
          </inlinemediaobject>
783
 
        </para>
784
 
        <para>
785
 
          This menu allows to change the border color of the selected blocks.
786
 
        </para>
787
 
        <para/>
788
 
      </listitem>
789
 
      <listitem>
790
 
        <para>
791
 
          <emphasis role="bold">Format:Fill Color</emphasis>
792
 
          <inlinemediaobject>
793
 
            <imageobject>
794
 
              <imagedata fileref="../../../xcos/images/icons/16x16/actions/color-fill.png"/>
795
 
            </imageobject>
796
 
          </inlinemediaobject>
797
 
        </para>
798
 
        <para>This menu allows to change the fill color of the selected blocks.</para>
799
 
        <para/>
800
 
      </listitem>
801
 
      <listitem>
802
 
        <para>
803
 
          <emphasis role="bold">Format:Link Style</emphasis>
804
 
        </para>
805
 
        <para/>
806
 
        <mediaobject>
807
 
          <imageobject>
808
 
            <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format_link_style.png"/>
809
 
          </imageobject>
810
 
        </mediaobject>
811
 
        <para/>
812
 
        <para>
813
 
          This menu allows to change the style of the link.
814
 
        </para>
815
 
        <para>
816
 
          First select the link and select the appropriate menu item or use the shortcuts
817
 
          (<emphasis>H</emphasis>), <emphasis>S</emphasis>, <emphasis>V</emphasis>).
818
 
          The following list shows the results obtained.
819
 
        </para>
820
 
        <itemizedlist>
821
 
          <listitem>
822
 
            <para>
823
 
              Horizontal (<emphasis>H</emphasis>)
824
 
            </para>
825
 
            <mediaobject>
826
 
              <imageobject>
827
 
                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_horizontal_en_US.png"/>
828
 
              </imageobject>
829
 
            </mediaobject>
830
 
          </listitem>
831
 
          <listitem>
832
 
            <para>
833
 
              Straight (<emphasis>S</emphasis>)
834
 
            </para>
835
 
            <mediaobject>
836
 
              <imageobject>
837
 
                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_straight_en_US.png"/>
838
 
              </imageobject>
839
 
            </mediaobject>
840
 
          </listitem>
841
 
          <listitem>
842
 
            <para>
843
 
              Vertical (<emphasis>V</emphasis>)
844
 
            </para>
845
 
            <mediaobject>
846
 
              <imageobject>
847
 
                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_vertical_en_US.png"/>
848
 
              </imageobject>
849
 
            </mediaobject>
850
 
          </listitem>
851
 
        </itemizedlist>
852
 
      </listitem>
853
 
      <listitem>
854
 
        <para>
855
 
          <emphasis role="bold">Format: Diagram background</emphasis>
856
 
        </para>
857
 
        <para>This menu allows to change the background color.</para>
858
 
        <para/>
859
 
      </listitem>
860
 
      <listitem>
861
 
        <para>
862
 
          <emphasis role="bold">Format:Grid</emphasis>
863
 
        </para>
864
 
        <para>
865
 
          This menu allows to activate / deactivate the grid. With the grid, the block and link placement on the working area
866
 
          is more easy and you obtain a more readable diagram.
867
 
        </para>
868
 
      </listitem>
869
 
    </itemizedlist>
870
 
  </refsection>
871
 
  <refsection id="Toolsmenu_Menu_entries">
872
 
    <title>Tools menu</title>
873
 
    <mediaobject>
874
 
      <imageobject>
875
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_tools.png"/>
876
 
      </imageobject>
877
 
    </mediaobject>
878
 
    <itemizedlist>
879
 
      <listitem>
880
 
        <para>
881
 
          <emphasis role="bold">Tools:Code generation</emphasis>
882
 
        </para>
883
 
        <para>
884
 
          This menu allows to generate the simulation code associated with a discrete time Super Block. The code generation
885
 
          is obtained simply by selecting the Super Block and then this menu.
886
 
        </para>
887
 
        <para>
888
 
          If the Super Block satisfies the required conditions, a dialog box pops up to ask for a block name, a directory where
889
 
          to put the generated files and for optional libraries requested by the linker.
890
 
          Given this information the code is generated, compiled and linked with Scilab.
891
 
        </para>
892
 
        <para>
893
 
          The Super Block is automatically replaced by a new block which implements the generated code. It is then possible to
894
 
          run the modified diagram. The code for standalone use is also generated.
895
 
        </para>
896
 
      </listitem>
897
 
    </itemizedlist>
898
 
  </refsection>
899
 
  <refsection id="Helpmenu_Menu_entries">
900
 
    <title>Help menu</title>
901
 
    <mediaobject>
902
 
      <imageobject>
903
 
        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_help.png"/>
904
 
      </imageobject>
905
 
    </mediaobject>
906
 
    <para/>
907
 
    <itemizedlist>
908
 
      <listitem>
909
 
        <para>
910
 
          <emphasis role="bold">Help:Xcos Help (F1)</emphasis>
911
 
          <inlinemediaobject>
912
 
            <imageobject>
913
 
              <imagedata fileref="../../../gui/images/icons/16x16/apps/help-browser.png"/>
914
 
            </imageobject>
915
 
          </inlinemediaobject>
916
 
        </para>
917
 
        <para>
918
 
          This menu opens the main help browser (if it is not open) on the <emphasis>Xcos</emphasis>
919
 
          help chapter.
920
 
        </para>
921
 
        <para/>
922
 
      </listitem>
923
 
      <listitem>
924
 
        <para>
925
 
          <emphasis role="bold">Help:Block Help</emphasis>
926
 
          <inlinemediaobject>
927
 
            <imageobject>
928
 
              <imagedata fileref="../../../gui/images/icons/16x16/apps/help-browser.png"/>
929
 
            </imageobject>
930
 
          </inlinemediaobject>
931
 
        </para>
932
 
        <para>
933
 
          To get help on a <emphasis>Xcos</emphasis> block, select the block and then click on this menu item.
934
 
        </para>
935
 
        <para/>
936
 
      </listitem>
937
 
      <listitem>
938
 
        <para>
939
 
          <emphasis role="bold">Help:Xcos Demos</emphasis>
940
 
          <inlinemediaobject>
941
 
            <imageobject>
942
 
              <imagedata fileref="../../../gui/images/icons/16x16/categories/applications-system.png"/>
943
 
            </imageobject>
944
 
          </inlinemediaobject>
945
 
        </para>
946
 
        <para>
947
 
          The item allows to open some examples of <emphasis>Xcos</emphasis> diagram.
948
 
        </para>
949
 
      </listitem>
950
 
      <listitem>
951
 
        <para>
952
 
          <emphasis role="bold">Help:About Xcos</emphasis>
953
 
        </para>
954
 
        <para>
955
 
          <emphasis>About Xcos</emphasis> item display the current version of <emphasis>Xcos</emphasis> in a dialog.
956
 
        </para>
957
 
      </listitem>
958
 
    </itemizedlist>
959
 
  </refsection>
960
 
  <refsection role="see also" id="Seealso_Menu_entries">
961
 
    <title>See Also</title>
962
 
    <itemizedlist>
963
 
      <listitem>
964
 
        <link linkend="scicos_debug">scicos_debug</link>
965
 
      </listitem>
966
 
      <listitem>
967
 
        <link linkend="ode">ode</link>
968
 
      </listitem>
969
 
      <listitem>
970
 
        <link linkend="dassl">dassl</link>
971
 
      </listitem>
972
 
    </itemizedlist>
973
 
  </refsection>
 
618
                        <para/>
 
619
                    </listitem>
 
620
                    <listitem>
 
621
                        <para>
 
622
                            Then, open successively each block parameters dialog and set for the gain value the name of
 
623
                            required symbolic value, here <emphasis>A</emphasis>,<emphasis> B</emphasis> and
 
624
                            <emphasis>C</emphasis>.
 
625
                        </para>
 
626
                    </listitem>
 
627
                </orderedlist>
 
628
                <para/>
 
629
            </listitem>
 
630
            <listitem>
 
631
                <para>
 
632
                    <emphasis role="bold">Simulate:Compile</emphasis>
 
633
                </para>
 
634
                <para>
 
635
                    Select the <emphasis>Compile</emphasis> menu item to compile the block diagram. This
 
636
                    menu item need never be used since compilation is performed automatically, if necessary,
 
637
                    before the beginning of every simulation (<emphasis>Run</emphasis> menu item). Normally,
 
638
                    a new compilation is not needed if only system parameters and internal states are modified.
 
639
                    In some cases however these modifications are not correctly updated and a manual compilation may be
 
640
                    needed before a <emphasis>Restart</emphasis> or a <emphasis>Continue</emphasis>.
 
641
                </para>
 
642
                <para>
 
643
                    <emphasis role="bold">Please report to us if you encounter such a case.</emphasis>
 
644
                    <ulink url="http://bugzilla.scilab.org/">
 
645
                        Report bugs and wishes about <emphasis>Scilab</emphasis>
 
646
                    </ulink>
 
647
                </para>
 
648
                <para/>
 
649
            </listitem>
 
650
            <listitem>
 
651
                <para>
 
652
                    <emphasis role="bold">Simulate:Modelica initialize</emphasis>
 
653
                </para>
 
654
                <para>
 
655
                    This menu item opens a specific dialog to the <emphasis>Modelica</emphasis> compiler where you can see the
 
656
                    components of your model and also select the solver between the <emphasis>Kinsol</emphasis>,
 
657
                    <emphasis>Ida</emphasis>, <emphasis>Fsolve</emphasis>, <emphasis>Optim</emphasis>,
 
658
                    <emphasis>Nelder Mead</emphasis> and <emphasis>Hompack</emphasis> solvers.
 
659
                </para>
 
660
                <para/>
 
661
            </listitem>
 
662
            <listitem>
 
663
                <para>
 
664
                    <emphasis role="bold">Simulate:Start</emphasis>
 
665
                    <inlinemediaobject>
 
666
                        <imageobject>
 
667
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/media-playback-start.png"/>
 
668
                        </imageobject>
 
669
                    </inlinemediaobject>
 
670
                </para>
 
671
                <para>
 
672
                    Select the <emphasis>Start</emphasis> menu item to start the simulation. If the system
 
673
                    has already been simulated, a dialog box appears where you can choose to
 
674
                    <emphasis>Continue</emphasis>, <emphasis>Restart</emphasis> or <emphasis>End</emphasis>
 
675
                    the simulation.
 
676
                </para>
 
677
                <para/>
 
678
            </listitem>
 
679
            <listitem>
 
680
                <para>
 
681
                    <emphasis role="bold">Simulation:Stop</emphasis>
 
682
                    <inlinemediaobject>
 
683
                        <imageobject>
 
684
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/process-stop.png"/>
 
685
                        </imageobject>
 
686
                    </inlinemediaobject>
 
687
                </para>
 
688
                <para>
 
689
                    You may interrupt the simulation by clicking on the <emphasis>Stop</emphasis> menu item
 
690
                    or on the toolbar button. You can change any of the block parameters and continue the
 
691
                    simulation with the new values.
 
692
                </para>
 
693
            </listitem>
 
694
        </itemizedlist>
 
695
    </refsection>
 
696
    <refsection id="Formatmenu_Menu_entries">
 
697
        <title>Format menu</title>
 
698
        <mediaobject>
 
699
            <imageobject>
 
700
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format.png"/>
 
701
            </imageobject>
 
702
        </mediaobject>
 
703
        <itemizedlist>
 
704
            <listitem>
 
705
                <para>
 
706
                    <emphasis role="bold">Format:Rotate (Ctrl+R)</emphasis>
 
707
                    <inlinemediaobject>
 
708
                        <imageobject>
 
709
                            <imagedata fileref="../../../gui/images/icons/16x16/actions/transform-rotate.png"/>
 
710
                        </imageobject>
 
711
                    </inlinemediaobject>
 
712
                </para>
 
713
                <para>
 
714
                    Rotate allows to turn a block on the left with an of 90°. Rotation affects all the selected blocks.
 
715
                </para>
 
716
                <para/>
 
717
            </listitem>
 
718
            <listitem>
 
719
                <para>
 
720
                    <emphasis role="bold">Format:Flip (Ctrl+F)</emphasis>
 
721
                    <inlinemediaobject>
 
722
                        <imageobject>
 
723
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/transform-flip.png"/>
 
724
                        </imageobject>
 
725
                    </inlinemediaobject>
 
726
                </para>
 
727
                <para>
 
728
                    To reverse the positions of the activation inputs and outputs set at the top and the bottom of a block, select a block
 
729
                    and select the <emphasis>Flip</emphasis> menu item. This does not affect the order, nor the position of the input and
 
730
                    output event ports which are numbered from left to right. Flipping affects all the selected blocks.
 
731
                </para>
 
732
                <para/>
 
733
            </listitem>
 
734
            <listitem>
 
735
                <para>
 
736
                    <emphasis role="bold">Format:Mirror (Ctrl+M)</emphasis>
 
737
                    <inlinemediaobject>
 
738
                        <imageobject>
 
739
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/transform-mirror.png"/>
 
740
                        </imageobject>
 
741
                    </inlinemediaobject>
 
742
                </para>
 
743
                <para>
 
744
                    To reverse the positions of the (regular) inputs and outputs set on the left and the right of a block, select a
 
745
                    block and select the <emphasis>Mirror</emphasis> menu item. This does not affect the order, nor the position of
 
746
                    the input and output ports which are numbered from top to bottom. Mirroring affects all the selected blocks.
 
747
                </para>
 
748
                <para/>
 
749
            </listitem>
 
750
            <listitem>
 
751
                <para>
 
752
                    <emphasis role="bold">Format:Show/Hide shadow</emphasis>
 
753
                </para>
 
754
                <para>This menu allows to select 3D shape for selected blocks and associated parameters.</para>
 
755
                <para/>
 
756
            </listitem>
 
757
            <listitem>
 
758
                <para>
 
759
                    <emphasis role="bold">Format:Align Blocks</emphasis>
 
760
                </para>
 
761
                <para/>
 
762
                <mediaobject>
 
763
                    <imageobject>
 
764
                        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format_align.png"/>
 
765
                    </imageobject>
 
766
                </mediaobject>
 
767
                <para/>
 
768
                <para>
 
769
                    When you select several blocks, it is possible to align them on horizontal axis (<emphasis>Top</emphasis>,
 
770
                    <emphasis>Bottom</emphasis> and <emphasis>Middle</emphasis>) or on vertical axis (<emphasis>Left</emphasis>,
 
771
                    <emphasis>Right</emphasis>, <emphasis>Center</emphasis>).
 
772
                </para>
 
773
                <para/>
 
774
            </listitem>
 
775
            <listitem>
 
776
                <para>
 
777
                    <emphasis role="bold">Format: Border Color</emphasis>
 
778
                    <inlinemediaobject>
 
779
                        <imageobject>
 
780
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/draw-brush.png"/>
 
781
                        </imageobject>
 
782
                    </inlinemediaobject>
 
783
                </para>
 
784
                <para>
 
785
                    This menu allows to change the border color of the selected blocks.
 
786
                </para>
 
787
                <para/>
 
788
            </listitem>
 
789
            <listitem>
 
790
                <para>
 
791
                    <emphasis role="bold">Format:Fill Color</emphasis>
 
792
                    <inlinemediaobject>
 
793
                        <imageobject>
 
794
                            <imagedata fileref="../../../xcos/images/icons/16x16/actions/color-fill.png"/>
 
795
                        </imageobject>
 
796
                    </inlinemediaobject>
 
797
                </para>
 
798
                <para>This menu allows to change the fill color of the selected blocks.</para>
 
799
                <para/>
 
800
            </listitem>
 
801
            <listitem>
 
802
                <para>
 
803
                    <emphasis role="bold">Format:Link Style</emphasis>
 
804
                </para>
 
805
                <para/>
 
806
                <mediaobject>
 
807
                    <imageobject>
 
808
                        <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_format_link_style.png"/>
 
809
                    </imageobject>
 
810
                </mediaobject>
 
811
                <para/>
 
812
                <para>
 
813
                    This menu allows to change the style of the link.
 
814
                </para>
 
815
                <para>
 
816
                    First select the link and select the appropriate menu item or use the shortcuts
 
817
                    (<emphasis>H</emphasis>), <emphasis>S</emphasis>, <emphasis>V</emphasis>).
 
818
                    The following list shows the results obtained.
 
819
                </para>
 
820
                <itemizedlist>
 
821
                    <listitem>
 
822
                        <para>
 
823
                            Horizontal (<emphasis>H</emphasis>)
 
824
                        </para>
 
825
                        <mediaobject>
 
826
                            <imageobject>
 
827
                                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_horizontal_en_US.png"/>
 
828
                            </imageobject>
 
829
                        </mediaobject>
 
830
                    </listitem>
 
831
                    <listitem>
 
832
                        <para>
 
833
                            Straight (<emphasis>S</emphasis>)
 
834
                        </para>
 
835
                        <mediaobject>
 
836
                            <imageobject>
 
837
                                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_straight_en_US.png"/>
 
838
                            </imageobject>
 
839
                        </mediaobject>
 
840
                    </listitem>
 
841
                    <listitem>
 
842
                        <para>
 
843
                            Vertical (<emphasis>V</emphasis>)
 
844
                        </para>
 
845
                        <mediaobject>
 
846
                            <imageobject>
 
847
                                <imagedata fileref="../images/xcos_menu_entries/en_US/xcos_link_vertical_en_US.png"/>
 
848
                            </imageobject>
 
849
                        </mediaobject>
 
850
                    </listitem>
 
851
                </itemizedlist>
 
852
            </listitem>
 
853
            <listitem>
 
854
                <para>
 
855
                    <emphasis role="bold">Format: Diagram background</emphasis>
 
856
                </para>
 
857
                <para>This menu allows to change the background color.</para>
 
858
                <para/>
 
859
            </listitem>
 
860
            <listitem>
 
861
                <para>
 
862
                    <emphasis role="bold">Format:Grid</emphasis>
 
863
                </para>
 
864
                <para>
 
865
                    This menu allows to activate / deactivate the grid. With the grid, the block and link placement on the working area
 
866
                    is more easy and you obtain a more readable diagram.
 
867
                </para>
 
868
            </listitem>
 
869
        </itemizedlist>
 
870
    </refsection>
 
871
    <refsection id="Toolsmenu_Menu_entries">
 
872
        <title>Tools menu</title>
 
873
        <mediaobject>
 
874
            <imageobject>
 
875
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_tools.png"/>
 
876
            </imageobject>
 
877
        </mediaobject>
 
878
        <itemizedlist>
 
879
            <listitem>
 
880
                <para>
 
881
                    <emphasis role="bold">Tools:Code generation</emphasis>
 
882
                </para>
 
883
                <para>
 
884
                    This menu allows to generate the simulation code associated with a discrete time Super Block. The code generation
 
885
                    is obtained simply by selecting the Super Block and then this menu.
 
886
                </para>
 
887
                <para>
 
888
                    If the Super Block satisfies the required conditions, a dialog box pops up to ask for a block name, a directory where
 
889
                    to put the generated files and for optional libraries requested by the linker.
 
890
                    Given this information the code is generated, compiled and linked with Scilab.
 
891
                </para>
 
892
                <para>
 
893
                    The Super Block is automatically replaced by a new block which implements the generated code. It is then possible to
 
894
                    run the modified diagram. The code for standalone use is also generated.
 
895
                </para>
 
896
            </listitem>
 
897
        </itemizedlist>
 
898
    </refsection>
 
899
    <refsection id="Helpmenu_Menu_entries">
 
900
        <title>Help menu</title>
 
901
        <mediaobject>
 
902
            <imageobject>
 
903
                <imagedata align="center" fileref="../gui/xcos_menu_entries/en_US/xcos_menu_help.png"/>
 
904
            </imageobject>
 
905
        </mediaobject>
 
906
        <para/>
 
907
        <itemizedlist>
 
908
            <listitem>
 
909
                <para>
 
910
                    <emphasis role="bold">Help:Xcos Help (F1)</emphasis>
 
911
                    <inlinemediaobject>
 
912
                        <imageobject>
 
913
                            <imagedata fileref="../../../gui/images/icons/16x16/apps/help-browser.png"/>
 
914
                        </imageobject>
 
915
                    </inlinemediaobject>
 
916
                </para>
 
917
                <para>
 
918
                    This menu opens the main help browser (if it is not open) on the <emphasis>Xcos</emphasis>
 
919
                    help chapter.
 
920
                </para>
 
921
                <para/>
 
922
            </listitem>
 
923
            <listitem>
 
924
                <para>
 
925
                    <emphasis role="bold">Help:Block Help</emphasis>
 
926
                    <inlinemediaobject>
 
927
                        <imageobject>
 
928
                            <imagedata fileref="../../../gui/images/icons/16x16/apps/help-browser.png"/>
 
929
                        </imageobject>
 
930
                    </inlinemediaobject>
 
931
                </para>
 
932
                <para>
 
933
                    To get help on a <emphasis>Xcos</emphasis> block, select the block and then click on this menu item.
 
934
                </para>
 
935
                <para/>
 
936
            </listitem>
 
937
            <listitem>
 
938
                <para>
 
939
                    <emphasis role="bold">Help:Xcos Demos</emphasis>
 
940
                    <inlinemediaobject>
 
941
                        <imageobject>
 
942
                            <imagedata fileref="../../../gui/images/icons/16x16/categories/applications-system.png"/>
 
943
                        </imageobject>
 
944
                    </inlinemediaobject>
 
945
                </para>
 
946
                <para>
 
947
                    The item allows to open some examples of <emphasis>Xcos</emphasis> diagram.
 
948
                </para>
 
949
            </listitem>
 
950
            <listitem>
 
951
                <para>
 
952
                    <emphasis role="bold">Help:About Xcos</emphasis>
 
953
                </para>
 
954
                <para>
 
955
                    <emphasis>About Xcos</emphasis> item display the current version of <emphasis>Xcos</emphasis> in a dialog.
 
956
                </para>
 
957
            </listitem>
 
958
        </itemizedlist>
 
959
    </refsection>
 
960
    <refsection role="see also" id="Seealso_Menu_entries">
 
961
        <title>See Also</title>
 
962
        <itemizedlist>
 
963
            <listitem>
 
964
                <link linkend="scicos_debug">scicos_debug</link>
 
965
            </listitem>
 
966
            <listitem>
 
967
                <link linkend="ode">ode</link>
 
968
            </listitem>
 
969
            <listitem>
 
970
                <link linkend="dassl">dassl</link>
 
971
            </listitem>
 
972
        </itemizedlist>
 
973
    </refsection>
974
974
</refentry>