Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features.

BUG:215923


git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdeedu@1054174 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

1 files changed, 471 insertions, 0 deletions

diff --git a/doc/kmplot/commands.docbook b/doc/kmplot/commands.docbook
new file mode 100644
index 00000000..a0b2d2b6
--- /dev/null
+++ b/doc/kmplot/commands.docbook
@@ -0,0 +1,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:
+-->