doc/kmplot/commands.docbook

   1 <chapter id="commands">
   2 <title>Command Reference</title>
   3
   4 <sect1 id="a-file-menu">
   5 <title>The <guimenu>File</guimenu> Menu</title>
   6
   7 <variablelist>
   8
   9 <varlistentry>
  10 <term>
  11 <menuchoice>
  12 <shortcut>
  13 <keycombo action="simul">&Ctrl;<keycap>N</keycap></keycombo>
  14 </shortcut>
  15 <guimenu>File</guimenu>
  16 <guimenuitem>New</guimenuitem>
  17 </menuchoice>
  18 </term>
  19 <listitem>
  20 <para><action>Starts a new Plot by clearing the coordinate system
  21 and resetting the function parser.</action></para>
  22 </listitem>
  23 </varlistentry>
  24
  25 <varlistentry>
  26 <term>
  27 <menuchoice><shortcut>
  28 <keycombo action="simul">&Ctrl;<keycap>O</keycap></keycombo></shortcut>
  29 <guimenu>File</guimenu>
  30 <guimenuitem>Open...</guimenuitem></menuchoice></term>
  31 <listitem><para><action>Opens an existing document.</action>
  32 </para></listitem>
  33 </varlistentry>
  34
  35 <varlistentry>
  36 <term>
  37 <menuchoice>
  38 <shortcut><keycombo
  39  action="simul">&Ctrl;<keycap>S</keycap></keycombo></shortcut>
  40 <guimenu>File</guimenu>
  41 <guimenuitem>Save</guimenuitem></menuchoice></term>
  42 <listitem><para><action>Saves the document.</action></para></listitem>
  43 </varlistentry>
  44
  45 <varlistentry>
  46 <term>
  47 <menuchoice>
  48 <guimenu>File</guimenu>
  49 <guimenuitem>Save As...</guimenuitem></menuchoice></term>
  50 <listitem><para><action>Saves the document under another
  51  name.</action></para></listitem>
  52 </varlistentry>
  53
  54 <varlistentry>
  55 <term>
  56 <menuchoice>
  57 <shortcut>
  58 <keycombo action="simul">&Ctrl;<keycap>P</keycap></keycombo>
  59 </shortcut>
  60 <guimenu>File</guimenu>
  61 <guimenuitem>Print...</guimenuitem>
  62 </menuchoice>
  63 </term>
  64 <listitem>
  65 <para><action>Sends the plot to a printer or file.</action></para>
  66 </listitem>
  67 </varlistentry>
  68
  69 <varlistentry>
  70 <term>
  71 <menuchoice>
  72 <shortcut><keycombo action="simul">
  73 &Ctrl;<keycap>Q</keycap>
  74 </keycombo></shortcut>
  75 <guimenu>File</guimenu>
  76 <guimenuitem>Quit</guimenuitem></menuchoice></term>
  77 <listitem><para><action>Exits</action> &kmplot;.</para></listitem>
  78 </varlistentry>
  79 </variablelist>
  80 </sect1>
  81
  82 <sect1 id="a-view-menu">
  83 <title>The <guimenu>Edit</guimenu> Menu</title>
  84
  85 <variablelist>
  86 <varlistentry>
  87 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Colors...</guimenuitem>
  88 </menuchoice></term>
  89 <listitem><para>
  90 Displays the <guilabel>Color Settings</guilabel> dialog box. See
  91 <xref linkend="configuration"/>.
  92 </para>
  93 </listitem>
  94 </varlistentry>
  95
  96 <varlistentry>
  97 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System...</guimenuitem>
  98 </menuchoice></term>
  99 <listitem><para>Displays the <guilabel>Coordinate System</guilabel> dialog box. See <xref linkend="configuration"/>.
 100 </para>
 101 </listitem>
 102 </varlistentry>
 103
 104 <varlistentry>
 105 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Scaling...</guimenuitem>
 106 </menuchoice></term>
 107 <listitem><para>Displays the <guilabel>Scaling Settings</guilabel> dialog box. See
 108 <xref linkend="configuration"/>.
 109 </para>
 110 </listitem>
 111 </varlistentry>
 112
 113 <varlistentry>
 114 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Fonts...</guimenuitem>
 115 </menuchoice></term>
 116 <listitem><para>Displays the <guilabel>Font Settings</guilabel> dialog box. See
 117 <xref linkend="configuration"/>.
 118 </para>
 119 </listitem>
 120 </varlistentry>
 121
 122 <varlistentry>
 123 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System I</guimenuitem>
 124 </menuchoice></term>
 125 <listitem><para>Show both positive and negative x- and y-values on the grid.
 126 </para>
 127 </listitem>
 128 </varlistentry>
 129
 130 <varlistentry>
 131 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System II</guimenuitem>
 132 </menuchoice></term>
 133 <listitem><para>Show positive and negative y-values, but positive x-values only
 134 </para>
 135 </listitem>
 136 </varlistentry>
 137
 138 <varlistentry>
 139 <term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Coordinate System III</guimenuitem>
 140 </menuchoice></term>
 141 <listitem><para>Show only positive x- and y-values.
 142 </para>
 143 </listitem>
 144 </varlistentry>
 145 </variablelist>
 146 </sect1>
 147
 148 <sect1 id="a-functions-menu">
 149 <title>The <guimenu>Plot</guimenu> Menu</title>
 150
 151 <variablelist>
 152 <varlistentry>
 153 <term>
 154 <menuchoice>
 155 <guimenu>Functions</guimenu>
 156 <guimenuitem>New Function Plot...</guimenuitem>
 157 </menuchoice>
 158 </term>
 159 <listitem><para>Opens the dialog for creating a new function plot. See <xref
 160 linkend="using-kmplot"/>.</para></listitem>
 161 </varlistentry>
 162
 163 <varlistentry>
 164 <term>
 165 <menuchoice>
 166 <guimenu>Functions</guimenu>
 167 <guimenuitem>New Parametric Plot...</guimenuitem>
 168 </menuchoice>
 169 </term>
 170 <listitem><para>Opens the dialog for creating a new parametric plot. See <xref
 171 linkend="using-kmplot"/>.</para></listitem>
 172 </varlistentry>
 173
 174 <varlistentry>
 175 <term>
 176 <menuchoice>
 177 <guimenu>Functions</guimenu>
 178 <guimenuitem>New Polar Plot...</guimenuitem>
 179 </menuchoice>
 180 </term>
 181 <listitem><para>Opens the dialog for creating a new polar plot. See <xref
 182 linkend="using-kmplot"/>.</para></listitem>
 183 </varlistentry>
 184
 185 <varlistentry>
 186 <term>
 187 <menuchoice>
 188 <guimenu>Functions</guimenu>
 189 <guimenuitem>Edit Plots...</guimenuitem>
 190 </menuchoice>
 191 </term>
 192 <listitem><para>Displays the functions dialog. There you can add, edit and remove functions. See <xref
 193 linkend="using-kmplot"/>.</para></listitem>
 194 </varlistentry>
 195
 196 </variablelist>
 197
 198 </sect1>
 199
 200 <sect1 id="a-zoom-menu">
 201 <title>The <guimenu>Zoom</guimenu> Menu</title>
 202 <para>The first five items in the menu change zoom-mode.</para>
 203 <variablelist>
 204 <varlistentry>
 205 <term>
 206 <menuchoice>
 207 <guimenu>Zoom</guimenu>
 208 <guimenuitem>No Zoom</guimenuitem>
 209 </menuchoice>
 210 </term>
 211 <listitem><para>Disable the zoom-mode.</para></listitem>
 212 </varlistentry>
 213 </variablelist>
 214
 215
 216 <variablelist>
 217 <varlistentry>
 218 <term>
 219 <menuchoice>
 220 <guimenu>Zoom</guimenu>
 221 <guimenuitem>Zoom rectangular</guimenuitem>
 222 </menuchoice>
 223 </term>
 224 <listitem><para>Let the user draw a rectangle. The minimum and maximum values will be set to the coordinates of the rectangle.</para></listitem>
 225 </varlistentry>
 226 </variablelist>
 227
 228 <variablelist>
 229 <varlistentry>
 230 <term>
 231 <menuchoice>
 232 <guimenu>Zoom</guimenu>
 233 <guimenuitem>Zoom in</guimenuitem>
 234 </menuchoice>
 235 </term>
 236 <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>
 237 </varlistentry>
 238 </variablelist>
 239
 240 <variablelist>
 241 <varlistentry>
 242 <term>
 243 <menuchoice>
 244 <guimenu>Zoom</guimenu>
 245 <guimenuitem>Zoom out</guimenuitem>
 246 </menuchoice>
 247 </term>
 248 <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>
 249 </varlistentry>
 250 </variablelist>
 251
 252 <variablelist>
 253 <varlistentry>
 254 <term>
 255 <menuchoice>
 256 <guimenu>Zoom</guimenu>
 257 <guimenuitem>Center a point</guimenuitem>
 258 </menuchoice>
 259 </term>
 260 <listitem><para>The selected point in the graph will be centered.</para></listitem>
 261 </varlistentry>
 262 </variablelist>
 263
 264 <variablelist>
 265 <varlistentry>
 266 <term>
 267 <menuchoice>
 268 <guimenu>Zoom</guimenu>
 269 <guimenuitem>Fit widget to trigonometric functions</guimenuitem>
 270 </menuchoice>
 271 </term>
 272 <listitem><para>The scale will be adapted to trigonometric functions. This works both for radians and degrees.</para></listitem>
 273 </varlistentry>
 274 </variablelist>
 275
 276 </sect1>
 277
 278
 279 <sect1 id="a-settings-menu">
 280 <title>The <guimenu>Settings</guimenu> Menu</title>
 281
 282 <variablelist>
 283 <varlistentry>
 284 <term><menuchoice><guimenu>Settings</guimenu>
 285 <guimenuitem>Show Toolbar</guimenuitem>
 286 </menuchoice></term>
 287 <listitem>
 288 <para><action>Toggle on and off the display of the toolbar.</action>
 289 The default is on.</para>
 290 </listitem>
 291 </varlistentry>
 292
 293 <varlistentry>
 294 <term><menuchoice><guimenu>Settings</guimenu>
 295 <guimenuitem>Show Statusbar</guimenuitem>
 296 </menuchoice></term>
 297 <listitem>
 298 <para><action>Toggle on and off the display of the statusbar at the bottom of
 299 the &kmplot; main window.</action>
 300 The default is on.</para>
 301 </listitem>
 302 </varlistentry>
 303
 304 <varlistentry>
 305 <term><menuchoice><guimenu>Settings</guimenu>
 306 <guimenuitem>Configure Shortcuts...</guimenuitem>
 307 </menuchoice></term>
 308 <listitem>
 309 <para><action>Personalize the keybindings</action> for &kmplot;.</para>
 310 </listitem>
 311 </varlistentry>
 312
 313 <varlistentry>
 314 <term><menuchoice><guimenu>Settings</guimenu>
 315 <guimenuitem>Configure Toolbars...</guimenuitem>
 316 </menuchoice></term>
 317 <listitem>
 318 <para><action>Personalize the toolbars</action> for &kmplot;.</para>
 319 </listitem>
 320 </varlistentry>
 321
 322 <varlistentry>
 323 <term><menuchoice><guimenu>Settings</guimenu>
 324 <guimenuitem>Configure &kmplot;</guimenuitem>
 325 </menuchoice></term>
 326 <listitem>
 327 <para><action>Customize</action> &kmplot;. The options available to
 328 you are described in <xref linkend="configuration"/>.</para>
 329 </listitem>
 330 </varlistentry>
 331 </variablelist>
 332
 333 </sect1>
 334
 335 <sect1 id="a-tools-menu">
 336 <title>The <guimenu>Tools</guimenu> Menu</title>
 337
 338 <para>This menu constains some tools for the functions that can be useful:</para>
 339
 340 <variablelist>
 341 <varlistentry>
 342 <term><menuchoice><guimenu>Tools</guimenu>
 343 <guimenuitem>Get y-value</guimenuitem>
 344 </menuchoice></term>
 345 <listitem>
 346 <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 textbox 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>
 347 </listitem>
 348 </varlistentry>
 349 </variablelist>
 350 </sect1>
 351
 352 <sect1 id="a-help-menu">
 353 <title>The <guimenu>Help</guimenu> Menu</title>
 354
 355 <para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> as described
 356 below, with one addition:</para>
 357
 358 <variablelist>
 359 <varlistentry>
 360 <term><menuchoice><guimenu>Help</guimenu>
 361 <guimenuitem>Names...</guimenuitem>
 362 </menuchoice></term>
 363 <listitem>
 364 <para>Opens a window with a list of the predefined function names and constants
 365 that &kmplot; knows.</para>
 366 </listitem>
 367 </varlistentry>
 368 </variablelist>
 369
 370 <para>The standard &kde; <guimenu>Help</guimenu> entries are:</para>
 371
 372 &help.menu.documentation;
 373
 374 </sect1>
 375
 376
 377 </chapter>
 378 <!--
 379 Local Variables:
 380 mode: sgml
 381 sgml-minimize-attributes:nil
 382 sgml-general-insert-case:lower
 383 sgml-indent-step:0
 384 sgml-indent-data:nil
 385 sgml-parent-document:("index.docbook" "BOOK" "CHAPTER")
 386 End:
 387 -->