summaryrefslogtreecommitdiffstats
path: root/doc/kmplot/commands.docbook
blob: a0b2d2b6dca67321dcca9a7bb1e7124dfae26821 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
<chapter id="commands">
<title>Command Reference</title> 

<sect1 id="a-file-menu">
<title>The <guimenu>File</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>New</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Starts a new Plot by clearing the coordinate system
and resetting the function parser.</action></para> 
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice><shortcut>
<keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Open...</guimenuitem></menuchoice></term>
<listitem><para><action>Opens an existing document.</action>
</para></listitem>
</varlistentry>

<varlistentry>
<term><menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Open Recent</guimenuitem>
</menuchoice></term>
<listitem><para><action>Displays a list of recently opened files.</action>
Selecting one from this list plots the functions in the file.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo
 action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Save</guimenuitem></menuchoice></term>
<listitem><para><action>Saves the document.</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Save As...</guimenuitem></menuchoice></term>
<listitem><para><action>Saves the document under another
 name.</action></para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
</shortcut>
<guimenu>File</guimenu>
<guimenuitem>Print...</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Sends the plot to a printer or file.</action></para>
</listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Export...</guimenuitem></menuchoice></term>
<listitem><para><action>Export values to a textfile. 
</action>Every value in the parameter list will be 
written to one line in the file.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut><keycombo action="simul">
&Ctrl;<keycap>Q</keycap>
</keycombo></shortcut>
<guimenu>File</guimenu>
<guimenuitem>Quit</guimenuitem></menuchoice></term>
<listitem><para><action>Exits</action> &kmplot;.</para></listitem>
</varlistentry>
</variablelist>
</sect1>

<sect1 id="a-view-menu">
<title>The <guimenu>Edit</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Colors...</guimenuitem>
</menuchoice></term>
<listitem><para>
Displays the <guilabel>Colors</guilabel> Settings dialog box. See
<xref linkend="colors-config"/>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System...</guimenuitem>
</menuchoice></term>
<listitem><para>Displays the <guilabel>Coordinate System</guilabel> dialog box. See <xref linkend="coords-config"/>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Scaling...</guimenuitem>
</menuchoice></term>
<listitem><para>Displays the <guilabel>Scale</guilabel> Settings dialog box. See
<xref linkend="scaling-config"/>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Fonts...</guimenuitem>
</menuchoice></term>
<listitem><para>Displays the <guilabel>Fonts</guilabel> Settings dialog box. See
<xref linkend="font-config"/>.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System I</guimenuitem>
</menuchoice></term>
<listitem><para>Show both positive and negative x- and y-values on the grid.
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System II</guimenuitem>
</menuchoice></term>
<listitem><para>Show positive and negative y-values, but positive x-values only
</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System III</guimenuitem>
</menuchoice></term>
<listitem><para>Show only positive x- and y-values.
</para>
</listitem>
</varlistentry>

</variablelist>
</sect1>

<sect1 id="a-functions-menu">
<title>The <guimenu>Plot</guimenu> Menu</title>

<variablelist>

<varlistentry>
<term>
<menuchoice>
<guimenu>Plot</guimenu>
<guimenuitem>New Function Plot...</guimenuitem>
</menuchoice>
</term>
<listitem><para>Opens the dialog for creating a new function plot. See <xref
linkend="using-kmplot"/>.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Plot</guimenu>
<guimenuitem>New Parametric Plot...</guimenuitem>
</menuchoice>
</term>
<listitem><para>Opens the dialog for creating a new parametric plot. See <xref
linkend="using-kmplot"/>.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Plot</guimenu>
<guimenuitem>New Polar Plot...</guimenuitem>
</menuchoice>
</term>
<listitem><para>Opens the dialog for creating a new polar plot. See <xref
linkend="using-kmplot"/>.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Plot</guimenu>
<guimenuitem>Edit Plots...</guimenuitem>
</menuchoice>
</term>
<listitem><para>Displays the functions dialog. There you can add, edit and remove functions. See <xref
linkend="using-kmplot"/>.</para></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="a-zoom-menu">
<title>The <guimenu>Zoom</guimenu> Menu</title>
<para>The first five items in the menu change zoom-mode.</para>

<variablelist>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>0</keycap></keycombo>
</shortcut>
<guimenu>Zoom</guimenu>
<guimenuitem>No Zoom</guimenuitem>
</menuchoice>
</term>
<listitem><para>Disable the zoom-mode.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo>
</shortcut>
<guimenu>Zoom</guimenu>
<guimenuitem>Zoom Rectangular</guimenuitem>
</menuchoice>
</term>
<listitem><para>Let the user draw a rectangle. The minimum and maximum values will be set to the coordinates of the rectangle.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo>
</shortcut>
<guimenu>Zoom</guimenu>
<guimenuitem>Zoom In</guimenuitem>
</menuchoice>
</term>
<listitem><para>The minimum and maximum values will come closer to each other and the selected point in the graph will be centered.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>3</keycap></keycombo>
</shortcut>
<guimenu>Zoom</guimenu>
<guimenuitem>Zoom Out</guimenuitem>
</menuchoice>
</term>
<listitem><para>The minimum and maximum values will be more separated from each other and the selected point in the graph will be centered.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>4</keycap></keycombo>
</shortcut>
<guimenu>Zoom</guimenu>
<guimenuitem>Center Point</guimenuitem>
</menuchoice>
</term>
<listitem><para>The selected point in the graph will be centered.</para></listitem>
</varlistentry>

<varlistentry>
<term>
<menuchoice>
<guimenu>Zoom</guimenu>
<guimenuitem>Fit Widget to Trigonometric Functions</guimenuitem>
</menuchoice>
</term>
<listitem><para>The scale will be adapted to trigonometric functions. This works both for radians and degrees.</para></listitem>
</varlistentry>

</variablelist>

</sect1>

<sect1 id="a-tools-menu">
<title>The <guimenu>Tools</guimenu> Menu</title>

<para>This menu contains some tools for the functions that can be useful:</para>

<variablelist>

<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Get y-Value...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Let the user get the y-value from a specific x-value. At the moment, only plot functions are supported. Type a value or expression in the text box under "X:". In the list below all the available functions are shown. Press the "Calculate" button to find the function's y-value. The result will be shown in the y-value box.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Search for Minimum Value...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Find the minimum value of the graph in a specified range.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Search for Maximum Value...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Find the maximum value of the graph in a specified range.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Calculate Integral</guimenuitem>
</menuchoice></term>
<listitem>
<para>Select a graph and the x-values in the new dialog that appears.
Calulates the integral and draws the area between the graph and the x-axis in the 
range of the selected x-values in the color of the graph.</para>
</listitem>
</varlistentry>

</variablelist>
</sect1>

<sect1 id="a-settings-menu">
<title>The <guimenu>Settings</guimenu> Menu</title>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Show/Hide Toolbar</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Toggle on and off the display of the toolbar.</action>
The default is on.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Show/Hide Statusbar</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Toggle on and off the display of the status bar at the bottom of
the &kmplot; main window.</action>
The default is on.</para>
</listitem>
</varlistentry>

<!-- Is the settings menu the right place for Full Screen Mode, same for Show Sliders ? 
perhaps better a new menu View with Full Screen, Sliders, and Coordinate System I to III 
from the menu Edit, usability bugreport against kmplot?
-->
<varlistentry>
<term><menuchoice>
<shortcut>
<keycombo>&Ctrl;&Shift;<keycap>F</keycap></keycombo>
</shortcut>
<guimenu>Settings</guimenu>
<guimenuitem>Full Screen Mode</guimenuitem>
</menuchoice></term>
<listitem><para>With this action you toggle the full screen mode.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Show Sliders</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Toogles</action> the display of sliders 1 to 4 on and off.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Shortcuts...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Personalize the keybindings</action> for &kmplot;.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure Toolbars...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Personalize the toolbars</action> for &kmplot;.</para>
</listitem>
</varlistentry>

<varlistentry>
<term><menuchoice><guimenu>Settings</guimenu>
<guimenuitem>Configure &kmplot;...</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Customize</action> &kmplot;. The options available to
you are described in <xref linkend="configuration"/>.</para>
</listitem>
</varlistentry>
</variablelist>

</sect1>

<sect1 id="a-help-menu">
<title>The <guimenu>Help</guimenu> Menu</title>

<para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> as described
below, with one addition:</para>

<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Help</guimenu>
<guimenuitem>Predefined Math Functions...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Opens a window with a list of the predefined function names and constants
that &kmplot; knows.</para>
</listitem>
</varlistentry>
</variablelist>

<para>The standard &kde; <guimenu>Help</guimenu> entries are:</para>

&help.menu.documentation;

</sect1>


</chapter>
<!--
Local Variables:
mode: sgml
sgml-minimize-attributes:nil
sgml-general-insert-case:lower
sgml-indent-step:0
sgml-indent-data:nil
sgml-parent-document:("index.docbook" "BOOK" "CHAPTER")
End:
-->