diff options
Diffstat (limited to 'doc/kmplot')
24 files changed, 2373 insertions, 0 deletions
diff --git a/doc/kmplot/Makefile.am b/doc/kmplot/Makefile.am new file mode 100644 index 00000000..da8216ae --- /dev/null +++ b/doc/kmplot/Makefile.am @@ -0,0 +1,4 @@ + +KDE_LANG = en +KDE_DOCS = AUTO +KDE_MANS = AUTO 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: +--> diff --git a/doc/kmplot/configuration.docbook b/doc/kmplot/configuration.docbook new file mode 100644 index 00000000..17903299 --- /dev/null +++ b/doc/kmplot/configuration.docbook @@ -0,0 +1,237 @@ +<chapter id="configuration"> +<title>Configuring &kmplot;</title> +<para>To access the &kmplot; configuration +dialog, select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure +&kmplot;...</guimenuitem></menuchoice>. A number of settings (<guimenuitem>Colors...</guimenuitem>, +<guimenuitem>Coordinate System...</guimenuitem>, <guimenuitem>Scaling...</guimenuitem> and +<guimenuitem>Fonts...</guimenuitem>) can only be changed +from the <guimenu>Edit</guimenu> menu. </para> + +<sect1 id="general-config"> +<title><guilabel>General</guilabel> Configuration</title> +<para>Here you can set global settings which automatic will be saved when you exit &kmplot;. In the first page you can set calculation-precision, angle-mode (radians and degrees), background color and zoom in and zoom out factors. </para> + +<screenshot> +<screeninfo>screenshot of the &kmplot; settings dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="settingsdlg.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>screenshot of the &kmplot; settings dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>The second page let you define you own constants. &kmplot; saves the constants in the same file as &kcalc; does. That means you can create a constant in &kmplot;, close the program and load it in &kcalc; and vice versa. &kmplot; only supports constant names that consist of one capital character and if you in &kcalc; define a constant name that is not one character, the name will be truncated. E.g, if you already have the constants "apple" and "bananas" in &kcalc;, they will be renamed to "A" and "B" in &kmplot;.</para> + +</sect1> + + +<sect1 id="colors-config"> +<title><guilabel>Colors</guilabel> Configuration</title> +<para>In the <guilabel>Coords</guilabel> tab of the <guilabel>Colors</guilabel> +configuration dialog, you can change the colors of the axes and grid of the +main &kmplot; area.</para> + +<screenshot> +<screeninfo>screenshot of the colors configuration dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="settings-colors.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>screenshot of the colors configuration dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>In the <guilabel>Default Function Colors</guilabel> tab, you can change the colors used +for the graphs of the ten functions allowed in &kmplot;.</para> +</sect1> + +<sect1 id="coords-config"> +<title><guimenuitem>Coordinate System</guimenuitem> Configuration</title> + +<sect2 id="axes-config"> +<title>The <guilabel>Axes</guilabel> Configuration</title> +<para> +<variablelist> + +<varlistentry> +<term><guilabel>X-Axis</guilabel></term> +<listitem> +<para>Sets the range for the x-axis scale. You can choose one of the +predefined ranges, or select <guilabel>Custom</guilabel> to make your +own. Note that in the <guilabel>Custom</guilabel> boxes, you can use the +predefined functions and constants (see <xref linkend="func-predefined"/>) as +the extremes of the range (⪚, set <guilabel>Min:</guilabel> to +<userinput>2*pi</userinput>). You can even use functions you have defined to +set the extremes of the axis range. For example, if you have defined a function +<userinput>f(x)=x^2</userinput>, you could set <guilabel>Min:</guilabel> to +<userinput>f(3)</userinput>, which would make the lower end of the range equal +to 9.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Y-Axis</guilabel></term> +<listitem> +<para>Sets the range for the y-axis. See <quote>X-Axis</quote> above.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Axis-line width:</guilabel></term> +<listitem> +<para>Sets the width of the lines representing the axes.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Tic width:</guilabel></term> +<listitem> +<para>Sets the width of the lines representing tics on the axes.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Tic length:</guilabel></term> +<listitem> +<para>Sets the length of the lines representing tics on the axes.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show labels</guilabel></term> +<listitem> +<para>If checked, the names (x, y) of the axes are shown on the plot and the axes' tics are labeled.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show extra frame</guilabel></term> +<listitem> +<para>If checked, the plot area is framed by an extra line.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show axes</guilabel></term> +<listitem> +<para>If checked, the axes are visible.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Show arrows</guilabel></term> +<listitem> +<para>If checked, the axes are displayed with arrows at their ends.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +</sect2> + +<sect2 id="grid-config"> +<title>The <guilabel>Grid</guilabel> Configuration</title> +<para>You can set the <guilabel>Grid Style</guilabel> to one of four options: +<variablelist> + +<varlistentry> +<term><guilabel>None</guilabel></term> +<listitem> +<para>No gridlines are drawn on the plot area</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Lines</guilabel></term> +<listitem> +<para>Straight lines form a grid of squares on the plot area.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Crosses</guilabel></term> +<listitem> +<para>Crosses are drawn to indicate points where x and y have integer values +(⪚, (1,1), (4,2) &etc;).</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Polar</guilabel></term> +<listitem> +<para>Lines of constant radius and of constant angle are drawn on the plot +area.</para> +</listitem> +</varlistentry> +</variablelist> +</para> +<para>The <guilabel>Line width</guilabel> option is used to set the width of +the lines of the grid.</para> +</sect2> + +</sect1> + +<sect1 id="scaling-config"> +<title><guilabel>Scaling</guilabel> Configuration</title> + +<screenshot> +<screeninfo>screenshot of the scaling configuration dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="settings-scaling.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>screenshot of the scaling configuration dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para>For each axis, you can set the <guilabel>Scaling:</guilabel> and +<guilabel>Printing:</guilabel> of one tic. The <guilabel>Scaling:</guilabel> +option selects how many units apart the axis tics will be (and therefore, how +far apart grid lines will be drawn), and the <guilabel>Printing:</guilabel> +option selects the length of one tic when displayed on the screen or +printed. In this way, these options can be used to change the size of the graph +on screen or on a page: For example, doubling the <guilabel>Printing:</guilabel> +setting whilst keeping the <guilabel>Scaling:</guilabel> setting the same will +result in the graph doubling in in height or width.</para> +</sect1> + +<sect1 id="font-config"> +<title><guilabel>Fonts</guilabel> Configuration</title> + +<screenshot> +<screeninfo>screenshot of the fonts configuration dialog</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="settings-fonts.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>screenshot of the fonts configuration dialog</phrase> + </textobject> + </mediaobject> +</screenshot> + +<para><guilabel>Header table:</guilabel> sets the font for the information table +shown in &kmplot; printouts, and <guilabel>Axis font:</guilabel> and <guilabel>Axis font size:</guilabel> +sets the font and its size used for all labels on the axes in the plot area.</para> +</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: +--> diff --git a/doc/kmplot/credits.docbook b/doc/kmplot/credits.docbook new file mode 100644 index 00000000..29703df0 --- /dev/null +++ b/doc/kmplot/credits.docbook @@ -0,0 +1,47 @@ +<chapter id="credits"> +<title>Credits and License</title> + +<para> +&kmplot; +</para> + +<para> +Program copyright 2000-2002 Klaus-Dieter Möller &Klaus-Dieter.Moeller.mail; +</para> + +<itemizedlist> +<title>Contributors</title> + <listitem> + <para><acronym>CVS</acronym>: &Robert.Gogolok; <email>mail@robert-gogoloh.de</email></para> + </listitem> + <listitem> + <para>Porting &GUI; to &kde; 3 and Translating: &Matthias.Messmer; &Matthias.Messmer.mail;</para> + </listitem> + <listitem> + <para>Various improvements: Fredrik Edemar <email>f_edemar@linux.se</email></para> + </listitem> +</itemizedlist> + +<para>Documentation copyright 2000--2002 by Klaus-Dieter Möller &Klaus-Dieter.Moeller.mail;.</para> +<para>Documentation extended and updated for &kde; 3.2 by &Philip.Rodrigues; &Philip.Rodrigues.mail;.</para> +<para>Documentation extended and updated for &kde; 3.3 by &Philip.Rodrigues; &Philip.Rodrigues.mail; and Fredrik Edemar <email>f_edemar@linux.se</email>.</para> +<para>Documentation extended and updated for &kde; 3.4 by Fredrik Edemar <email>f_edemar@linux.se</email>.</para> + + +<!-- TRANS:CREDIT_FOR_TRANSLATORS --> +&underFDL; +&underGPL; + +</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: +--> + diff --git a/doc/kmplot/dcop.docbook b/doc/kmplot/dcop.docbook new file mode 100644 index 00000000..3907b650 --- /dev/null +++ b/doc/kmplot/dcop.docbook @@ -0,0 +1,612 @@ +<chapter id="dcop"> + <title>Scripting &kmplot;</title> + + <para>A new feature in &kde; 3.4 is that you can write scrips for &kmplot; with &DCOP;. For example, if you want to define a new function <userinput>f(x)=2sin x+3cos x</userinput>, set its line width to 20 and then draw it, you type in a console:</para> + <para><command>dcop kmplot-PID Parser addFunction "f(x)=2sin x+3cos x"</command> + As a result, the new function's id number will be returned, or -1 if the function could not be defined.</para> + <para><command>>dcop kmplot-PID Parser setFunctionFLineWidth 20 ID</command> + This command sets the function with the id number ID the line width to 20.</para> + <para><command>>dcop kmplot-PID View drawPlot</command> + This command repaints the window so that the function get visible.</para> +<para> + A list over the available functions: + <variablelist> + <varlistentry> + <term> + KmPlotShell fileOpen &url + </term> + <listitem> + <para>Load the file <parameter>url</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg isModified + </term> + <listitem> + <para>Returns true if any changes are done.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg editColors + </term> + <listitem> + <para>Opens the color edit dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg editAxes + </term> + <listitem> + <para>Opens the coordinate system edit dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg editScaling + </term> + <listitem> + <para>Opens the scaling edit dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg editFonts + </term> + <listitem> + <para>Opens the fonts edit dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg editConstants + </term> + <listitem> + <para>Opens the constants edit dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg newFunction + </term> + <listitem> + <para>Opens the new function plot dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg newParametric + </term> + <listitem> + <para>Opens the new parametric plot dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg newPolar + </term> + <listitem> + <para>Opens the new polar plot dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg toggleShowSlider0 + </term> + <listitem> + <para>Shows/hides parameter slider window number 1.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg toggleShowSlider1 + </term> + <listitem> + <para>Shows/hides parameter slider window number 2.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg toggleShowSlider2 + </term> + <listitem> + <para>Shows/hides parameter slider window number 3.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg toggleShowSlider3 + </term> + <listitem> + <para>Shows/hides parameter slider window number 4.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotSave + </term> + <listitem> + <para>Saves the functions (opens the save dialog if it is a new file).</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotSaveas + </term> + <listitem> + <para>The same as choosing <menuchoice><guimenu>File</guimenu><guimenuitem>Save As</guimenuitem></menuchoice> in the menu.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotEditPlots + </term> + <listitem> + <para>Opens the edit plots dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotPrint + </term> + <listitem> + <para>Opens the print dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotExport + </term> + <listitem> + <para>Opens the export dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotSettings + </term> + <listitem> + <para>Opens the settings dialog.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotNames + </term> + <listitem> + <para>Shows a list of predefined math functions.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotCoord1 + </term> + <listitem> + <para>Coordinate System I.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotCoord2 + </term> + <listitem> + <para>Coordinate System II.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg slotCoord3 + </term> + <listitem> + <para>Coordinate System III.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg getYValue + </term> + <listitem> + <para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Get y-Value...</guimenuitem></menuchoice> in the menu.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg findMinimumValue + </term> + <listitem> + <para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Search for Minimum Value...</guimenuitem></menuchoice> in the menu.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg findMaximumValue + </term> + <listitem> + <para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Search for Maximum Value...</guimenuitem></menuchoice> in the menu.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + MainDlg graphArea + </term> + <listitem> + <para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Calculate Integral</guimenuitem></menuchoice> in the menu.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser addFunction f_str + </term> + <listitem> + <para>Adds a new function with the expression <parameter>f_str</parameter>. If the expression does not contain a function name, it will be auto-generated. The id number of the new function is returned, or -1 if the function couln't be defined.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser delfkt id + </term> + <listitem> + <para>Removes the function with the id number <parameter>id</parameter>. If the function could not be deleted, false is returned, otherwise true.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionExpression f_str id + </term> + <listitem> + <para>Sets the expression for the function with the id number <parameter>id</parameter> to <parameter>f_str</parameter>. Returns true if it succeed, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser countFunctions + </term> + <listitem> + <para>Returns the number of functions (parametric functions are calculated as two).</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser listFunctionNames + </term> + <listitem> + <para>Returns a list with all functions.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser fnameToId f_str + </term> + <listitem> + <para>Returns the id number of <parameter>f_str</parameter> or -1 if the function name <parameter>f_str</parameter> was not found.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser id x + </term> + <listitem> + <para>Calculates the value <parameter>x</parameter> for the function with the ID <parameter>id</parameter> or returns 0.0 if <parameter>id</parameter> does not exist.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionFVisible id + </term> + <listitem> + <para>Returns true if the function with the ID <parameter>id</parameter> is visible, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF1Visible id + </term> + <listitem> + <para>Returns true if the first derivative of the function with the ID <parameter>id</parameter> is visible, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF2Visible id + </term> + <listitem> + <para>Returns true if the second derivative of the function with the ID <parameter>id</parameter> is visible, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionIntVisible id + </term> + <listitem> + <para>Returns true if the integral of the function with the ID <parameter>id</parameter> is visible, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionFVisible visible id + </term> + <listitem> + <para>Shows the function with the ID <parameter>id</parameter> if <parameter>visible</parameter> is true. If <parameter>visible</parameter> is false, the function will be hidden. True is returned if the function exists, otherwise false</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF1Visible visible id + </term> + <listitem> + <para>Shows the first derivative of the function with the ID <parameter>id</parameter> if <parameter>visible</parameter> is true. If <parameter>visible</parameter> is false, the function will be hidden. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF2Visible visible id + </term> + <listitem> + <para>Shows the second derivative of the function with the ID <parameter>id</parameter> if <parameter>visible</parameter> is true. If <parameter>visible</parameter> is false, the function will be hidden. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionIntVisible visible id + </term> + <listitem> + <para>Shows the integral of the function with the ID <parameter>id</parameter> if <parameter>visible</parameter> is true. If <parameter>visible</parameter> is false, the function will be hidden. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionStr id + </term> + <listitem> + <para>Returns the function expression of the function with the ID <parameter>id</parameter>. If the function not exists, an empty string is returned instead.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionFColor id + </term> + <listitem> + <para>Returns the color of the function with the ID <parameter>id</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF1Color id + </term> + <listitem> + <para>Returns the color of the first derivative of the function with the ID <parameter>id</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF2Color id + </term> + <listitem> + <para>Returns the color of the second derivative of the function with the ID <parameter>id</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionIntColor id + </term> + <listitem> + <para>Returns the color of the integral of the function with the ID <parameter>id</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionFColor color id + </term> + <listitem> + <para>Sets the color of the function with the ID <parameter>id</parameter> to <parameter>color</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF1Color color id + </term> + <listitem> + <para>Sets the color of the first derivative of the function with the ID <parameter>id</parameter> to <parameter>color</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF2Color color id + </term> + <listitem> + <para>Sets the color of the second derivative of the function with the ID <parameter>id</parameter> to <parameter>color</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionIntColor color id + </term> + <listitem> + <para>Sets the color of the integral of the function with the ID <parameter>id</parameter> to <parameter>color</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionFLineWidth id + </term> + <listitem> + <para>Returns the line width of the function with the ID <parameter>id</parameter>. If the function not exists, 0 is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF1LineWidth id + </term> + <listitem> + <para>Returns the line width of the first derivative of the function with the ID <parameter>id</parameter>. If the function not exists, 0 is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionF2LineWidth id + </term> + <listitem> + <para>Returns the line width of the first derivative of the function with the ID <parameter>id</parameter>. If the function not exists, 0 is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionIntLineWidth id + </term> + <listitem> + <para>Returns the line width of the integral of the function with the ID <parameter>id</parameter>. If the function not exists, 0 is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionFLineWidth linewidth id + </term> + <listitem> + <para>Sets the line width of the function with the ID <parameter>id</parameter> to <parameter>linewidth</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF1LineWidth linewidth id + </term> + <listitem> + <para>Sets the line width of the first derivative of the function with the ID <parameter>id</parameter> to <parameter>linewidth</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionF2LineWidth linewidth id + </term> + <listitem> + <para>Sets the line width of the second derivative of the function with the ID <parameter>id</parameter> to <parameter>linewidth</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionIntLineWidth linewidth id + </term> + <listitem> + <para>Sets the line width of the integral of the function with the ID <parameter>id</parameter> to <parameter>linewidth</parameter>. True is returned if the function exists, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionParameterList id + </term> + <listitem> + <para>Returns a list with all the parameter values for the function with the ID <parameter>id</parameter>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionAddParameter new_parameter id + </term> + <listitem> + <para>Adds the parameter value <parameter>new_parameter</parameter> to the function with the ID <parameter>id</parameter>. True is returned if the operation succeed, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionRemoveParameter remove_parameter id + </term> + <listitem> + <para>Removes the parameter value <parameter>remove_parameter</parameter> from the function with the ID <parameter>id</parameter>. True is returned if the operation succeed, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionMinValue id + </term> + <listitem> + <para>Returns the minimum plot range value of the function with the ID <parameter>id</parameter>. If the function not exists or if the minimum value is not definied, an empty string is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionMaxValue id + </term> + <listitem> + <para>Returns the maximum plot range value of the function with the ID <parameter>id</parameter>. If the function not exists or if the maximum value is not definied, an empty string is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionMinValue min id + </term> + <listitem> + <para>Sets the minimum plot range value of the function with the ID <parameter>id</parameter> to <parameter>min</parameter>. True is returned if the function exists and the expression is valid, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionMaxValue max id + </term> + <listitem> + <para>Sets the maximum plot range value of the function with the ID <parameter>id</parameter> to <parameter>max</parameter>. True is returned if the function exists and the expression is valid, otherwise false.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + Parser functionStartXValue id + </term> + <listitem> + <para>Returns the initial x point for the integral of the function with the ID <parameter>id</parameter>. If the function not exists or if the x-point-expression is not definied, an empty string is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser functionStartYValue id + </term> + <listitem> + <para>Returns the initial y point for the integral of the function with the ID <parameter>id</parameter>. If the function not exists or if the y-point-expression is not definied, an empty string is returned.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionStartXValue min id + </term> + <listitem> + <para>Sets the initial x point for the integral of the function with the ID <parameter>id</parameter> to <parameter>x</parameter>. True is returned if the function exists and the expression is valid, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + Parser setFunctionStartYValue max id + </term> + <listitem> + <para>Sets the initial y point for the integral of the function with the ID <parameter>id</parameter> to <parameter>y</parameter>. True is returned if the function exists and the expression is valid, otherwise false.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + View stopDrawing + </term> + <listitem> + <para>If &kmplot; currently is drawing a function, the procedure will stop.</para> + </listitem> + </varlistentry> + <varlistentry> + <term> + View drawPlot + </term> + <listitem> + <para>Redraws all functions.</para> + </listitem> + </varlistentry> + </variablelist> +</para> +</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: + -->
\ No newline at end of file diff --git a/doc/kmplot/developer.docbook b/doc/kmplot/developer.docbook new file mode 100644 index 00000000..64c4ee90 --- /dev/null +++ b/doc/kmplot/developer.docbook @@ -0,0 +1,18 @@ +<chapter id="developers"> +<title>Developer's Guide to &kmplot;</title> + +<para>If you want to contribute to &kmplot; feel free to send a mail to +&Klaus-Dieter.Moeller.mail; or <email>f_edemar@linux.se</email> </para> +</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: +--> + diff --git a/doc/kmplot/edu-logo.png b/doc/kmplot/edu-logo.png Binary files differnew file mode 100644 index 00000000..d1234fd8 --- /dev/null +++ b/doc/kmplot/edu-logo.png diff --git a/doc/kmplot/firststeps.docbook b/doc/kmplot/firststeps.docbook new file mode 100644 index 00000000..5595ecbc --- /dev/null +++ b/doc/kmplot/firststeps.docbook @@ -0,0 +1,70 @@ +<chapter id="first-steps"> +<title>First Steps With &kmplot;</title> + +<sect1 id="simple-function-plot"> +<title>Simple Function Plot</title> + +<para> +In the main toolbar there is a simple text box in which you can enter +a function expression. Simply enter: +<screen><userinput>x^2</userinput></screen> and press &Enter;. This +will draw the plot of y=x^2 in the coordinate system. Enter another +expression in the text box like +<screen><userinput>5*sin(x)</userinput></screen> and another plot will +be added. +</para> + +<para>Click on one of the lines you have just plotted. Now the cross +hair gets the color of the plot and is attached to the plot. You can +use the mouse to move the cross hair along the plot. In the status +bar at the bottom of the window the coordinates of the current +position is displayed. Note that if the plot touches the x-axis the +root will be displayed in the status bar, too.</para> + +<para>Click the mouse again and the cross hair will be detached from +the plot.</para> +</sect1> + +<sect1 id="edit-properties"> +<title>Edit Properties</title> + +<para>Let us make some changes to the function and change the color of +the plot.</para> + +<para>You can edit all functions with the +<menuchoice><guimenu>Plot</guimenu><guimenuitem>Edit +Plots...</guimenuitem> </menuchoice> menu entry. A dialog appears +which lists all the functions that you have plotted. Notice that +&kmplot; has automatically found a unique function name for your +expressions and completed the expression to a function +equation.</para> + +<para>Select <guilabel>f(x)=x^2</guilabel> in the list. A double click +or pressing the <guibutton>Edit</guibutton> button will show you a +dialog window. Here you have access to a lot of options. Let us rename +the function and move the plot 5 units down. Change the function +equation to <screen><userinput>parabola(x)=x^2-5</userinput></screen> +</para> + +<para>To select another color for the plot click into the +<guilabel>Color:</guilabel> box. Finally press +<guibutton>OK</guibutton> and your changes take effect in the +coordinate system.</para> + +<note><para>All changes can be undone until you press +<guibutton>OK</guibutton> in the <guilabel>Edit Plots</guilabel> +dialog.</para> +</note> + +</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: +--> diff --git a/doc/kmplot/index.docbook b/doc/kmplot/index.docbook new file mode 100644 index 00000000..d8fb0fed --- /dev/null +++ b/doc/kmplot/index.docbook @@ -0,0 +1,98 @@ +<?xml version="1.0" ?> +<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" +"dtd/kdex.dtd" [ + <!ENTITY kappname "&kmplot;"><!-- replace kmplot here --> + <!ENTITY package "kdeedu"> + <!ENTITY introduction SYSTEM "introduction.docbook"> + <!ENTITY firststeps SYSTEM "firststeps.docbook"> + <!ENTITY using SYSTEM "using.docbook"> + <!ENTITY commands SYSTEM "commands.docbook"> + <!ENTITY developer SYSTEM "developer.docbook"> + <!ENTITY credits SYSTEM "credits.docbook"> + <!ENTITY install SYSTEM "install.docbook"> + <!ENTITY reference SYSTEM "reference.docbook"> + <!ENTITY configuration SYSTEM "configuration.docbook"> + <!ENTITY dcop SYSTEM "dcop.docbook"> + <!ENTITY % addindex "IGNORE"> + <!ENTITY % English "INCLUDE"><!-- change language only here --> +]> +<!-- The language must NOT be changed here. --> + +<book lang="&language;"> + +<bookinfo> +<title>The &kmplot; Handbook</title> +<authorgroup> +<author> +<firstname>Klaus-Dieter</firstname> +<surname>Möller</surname> +<affiliation> +<address>&Klaus-Dieter.Moeller.mail;</address> +</affiliation> +</author> +<author> +&Philip.Rodrigues; &Philip.Rodrigues.mail; +</author> +<!-- TRANS:ROLES_OF_TRANSLATORS --> +</authorgroup> + +<copyright> +<year>2000</year><year>2001</year><year>2002</year> +<holder>Klaus-Dieter Möller</holder> +</copyright> + +<copyright> +<year>2003</year> +<holder>&Philip.Rodrigues; &Philip.Rodrigues.mail;</holder> +</copyright> + +<legalnotice>&FDLNotice;</legalnotice> + +<date>2006-02-24</date> +<releaseinfo>1.2.0</releaseinfo> + +<!-- Abstract about this handbook --> + +<abstract> +<para>&kmplot; is a mathematical function plotter for the &kde; +Desktop.</para> +<para> <inlinemediaobject><imageobject><imagedata +fileref="edu-logo.png" +format="PNG"/></imageobject></inlinemediaobject> &kmplot; is part of +the &kde;-EDU Project: <ulink +url="http://edu.kde.org/">http://edu.kde.org/</ulink></para></abstract> + + +<keywordset> +<keyword>KDE</keyword> +<keyword>KMPlot</keyword> +<keyword>EDU</keyword> +<keyword>edutainment</keyword> +<keyword>plotting</keyword> +<keyword>math</keyword> +</keywordset> + +</bookinfo> + +&introduction; +&firststeps; +&using; +&configuration; +&reference; +&commands; +&dcop; +&developer; +&credits; +&install; + +&documentation.index; +</book> +<!-- +Local Variables: +mode: sgml +sgml-minimize-attributes:nil +sgml-general-insert-case:lower +sgml-indent-step:0 +sgml-indent-data:nil +End: +-->
\ No newline at end of file diff --git a/doc/kmplot/install.docbook b/doc/kmplot/install.docbook new file mode 100644 index 00000000..cea50bd0 --- /dev/null +++ b/doc/kmplot/install.docbook @@ -0,0 +1,34 @@ +<appendix id="installation"> +<title>Installation</title> + +&install.intro.documentation; + +<mediaobject> +<imageobject> +<imagedata fileref="edu-logo.png" format="PNG"/> +</imageobject> +</mediaobject> + +<para>&kmplot; is part of the &kde; EDU Project: <ulink +url="http://edu.kde.org/">http://edu.kde.org/</ulink></para> + +<para>&kmplot; has its own homepage on <ulink +url="http://kmplot.sourceforge.net">SourceForge</ulink>. You can also +find archives of older versions of &kmplot; there, for example, for +&kde; 2.x</para> + +&install.compile.documentation; + +</appendix> +<!-- +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: +--> + + diff --git a/doc/kmplot/introduction.docbook b/doc/kmplot/introduction.docbook new file mode 100644 index 00000000..4aa46d04 --- /dev/null +++ b/doc/kmplot/introduction.docbook @@ -0,0 +1,56 @@ +<chapter id="introduction"> +<title>Introduction</title> + +<para>&kmplot; is a mathematical function plotter for the &kde; +Desktop. It has a powerful built-in parser. You can plot different +functions simultaneously and combine them to build new +functions.</para> + +<screenshot> +<screeninfo>Examples</screeninfo> +<mediaobject> +<imageobject> +<imagedata fileref="threeplots.png" format="PNG"/> +</imageobject> +<textobject> +<phrase>Examples</phrase> +</textobject> +</mediaobject> +</screenshot> + +<para>&kmplot; supports parametric functions and functions in +polar coordinates. Several grid modes are supported. Plots may be +printed with high precision in the correct scale.</para> + +<para>&kmplot; also provides some numerical and visual features like:</para> +<itemizedlist> +<listitem><para>Filling and calculating +the area between the plot and the first axis</para> +</listitem> +<listitem><para>Finding maximum and +minimum values</para> +</listitem> +<listitem><para>Changing function parameters dynamically</para> +</listitem> +<listitem><para>Plotting +derivatives and integral functions.</para> +</listitem> +</itemizedlist> + +<para>These features help in learning the +relationship between mathematical functions and their graphical +representation in a coordinate system.</para> + +</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: +--> diff --git a/doc/kmplot/kfkt.png b/doc/kmplot/kfkt.png Binary files differnew file mode 100644 index 00000000..590fe445 --- /dev/null +++ b/doc/kmplot/kfkt.png diff --git a/doc/kmplot/ksys1.png b/doc/kmplot/ksys1.png Binary files differnew file mode 100644 index 00000000..b0dc2488 --- /dev/null +++ b/doc/kmplot/ksys1.png diff --git a/doc/kmplot/ksys2.png b/doc/kmplot/ksys2.png Binary files differnew file mode 100644 index 00000000..e8c10a68 --- /dev/null +++ b/doc/kmplot/ksys2.png diff --git a/doc/kmplot/ksys3.png b/doc/kmplot/ksys3.png Binary files differnew file mode 100644 index 00000000..0c55562d --- /dev/null +++ b/doc/kmplot/ksys3.png diff --git a/doc/kmplot/main.png b/doc/kmplot/main.png Binary files differnew file mode 100644 index 00000000..cdf9cf45 --- /dev/null +++ b/doc/kmplot/main.png diff --git a/doc/kmplot/man-kmplot.1.docbook b/doc/kmplot/man-kmplot.1.docbook new file mode 100644 index 00000000..27b053fc --- /dev/null +++ b/doc/kmplot/man-kmplot.1.docbook @@ -0,0 +1,66 @@ +<?xml version="1.0" ?> +<!DOCTYPE refentry PUBLIC "-//KDE//DTD DocBook XML V4.2-Based Variant V1.1//EN" "dtd/kdex.dtd" [ +<!ENTITY % English "INCLUDE"> +]> + +<refentry lang="&language;"> +<refentryinfo> +<title>&kde; User's Manual</title> +<author><personname> +<firstname>Ben</firstname> +<surname>Burton</surname> +</personname> +<email>bab@debian.org</email></author> +<date>May 25, 2005</date> +<productname>K Desktop Environment</productname> +</refentryinfo> + +<refmeta> +<refentrytitle><command>kmplot</command></refentrytitle> +<manvolnum>1</manvolnum> +</refmeta> + +<refnamediv> +<refname><command>kmplot</command></refname> +<refpurpose>mathematical function plotter</refpurpose> +</refnamediv> + +<refsynopsisdiv> +<cmdsynopsis> +<command>kmplot</command> +<group choice="opt"><option><replaceable>file</replaceable></option></group> +<arg choice="opt">&kde; Generic Options</arg> +<arg choice="opt">&Qt; Generic Options</arg> +</cmdsynopsis> +</refsynopsisdiv> + +<refsect1> +<title>Description</title> +<para>&kmplot; is a mathematical function plotter for &kde;. It has a powerful built-in parser. You can plot different functions simultaneously and combine them to build new functions.</para><para>&kmplot; supports parametric functions and functions in polar coordinates. Several grid modes are supported. Plots may be printed with high precision in the correct scale.</para><para>&kmplot; also provides some numerical and visual features, like filling and calculating the area between the plot and the first axis, finding maximum and minimum values, changing function parameters dynamically and plotting derivatives and integral functions.</para><para>&kmplot; is part of the &kde; edutainment module.</para> +</refsect1> + +<refsect1> +<title>Options</title> +<variablelist> +<varlistentry><term><option><replaceable>file</replaceable></option></term> +<listitem><para>File to open</para></listitem></varlistentry> +</variablelist> +</refsect1> +<refsect1> +<title>See Also</title> + +<para>More detailed user documentation is available from <ulink +url="help:/kmplot">help:/kmplot</ulink> +(either enter this <acronym>URL</acronym> into &konqueror;, or run +<userinput><command>khelpcenter</command> +<parameter>help:/kmplot</parameter></userinput>).</para> + +<para>There is also further information available at <ulink url="http://edu.kde.org/kmplot/">the &kde; edutainment website</ulink>.</para> +</refsect1> + +<refsect1> +<title>Authors</title> +<para>&kmplot; was written by <personname><firstname>Klaus-Dieter</firstname><surname>Möller</surname></personname> <email>kdmoeller@foni.net</email>, &Matthias.Messmer; &Matthias.Messmer.mail; and <personname><firstname>Fredrik</firstname><surname>Edemar</surname></personname> <email>f_edemar@linux.se</email></para> +</refsect1> + +</refentry> diff --git a/doc/kmplot/reference.docbook b/doc/kmplot/reference.docbook new file mode 100644 index 00000000..96f19adc --- /dev/null +++ b/doc/kmplot/reference.docbook @@ -0,0 +1,339 @@ +<chapter id="reference"> +<title>&kmplot; Reference</title> + +<!-- +<mediaobject> +<imageobject> +<imagedata fileref="kfkt.png" format="PNG"/> +</imageobject> +</mediaobject> + +<para>This menu entry or toolbar button opens the Functions Editor. Here +you can enter up to 10 functions or +function groups. The parser knows <firstterm>explicit</firstterm> and +<firstterm>parametric</firstterm> form. With specific extensions it +is possible to add first and second derivatives and to choose values +for the function group parameter.</para> +--> + +<sect1 id="func-syntax"> +<title>Function Syntax</title> + +<para>Some syntax rules must be complied with:</para> + +<screen> +<userinput>name(var1[, var2])=term [;extensions]</userinput> +</screen> + + +<variablelist> +<varlistentry> +<term>name</term> +<listitem> + +<para>The function name. If the first character is <quote>r</quote> +the parser assumes that you are using polar coordinates. If the first +character is <quote>x</quote> (for instance <quote>xfunc</quote>) the +parser expects a second function with a leading <quote>y</quote> (here +<quote>yfunc</quote>) to define the function in parametric form. +</para> +</listitem> +</varlistentry> +<varlistentry> +<term>var1</term> +<listitem><para>The function's variable</para></listitem> +</varlistentry> +<varlistentry> +<term>var2</term> +<listitem><para> The function <quote>group parameter</quote>. It must be +separated from the function's variable by a comma. You can use the group +parameter to, for example, plot a number of graphs from one function. The parameter values can be selected manually or you can choose to have a slider bar that controls one parameter. By changing the value of the slider the value parameter will be changed. The slider can be set to an integer between 0 and 100.</para></listitem> +</varlistentry> +<varlistentry> +<term>term</term> +<listitem><para>The expression defining the function.</para></listitem> +</varlistentry> +</variablelist> +</sect1> + +<sect1 id="func-predefined"> +<title>Predefined Function Names and Constants</title> + +<para> +All the predefined functions and constants that &kmplot; knows can be shown by +selecting <menuchoice><guimenu>Help</guimenu><guimenuitem>Predefined Math Functions</guimenuitem> +</menuchoice>. They are: + +<variablelist> + +<varlistentry> +<term>sqr, sqrt</term> +<listitem> +<para>Return the square and square root of a number, respectively.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>exp, ln</term> +<listitem> +<para>Return the exponential and natural logarithm of a number, respectively.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>log</term> +<listitem> +<para>Returns the logarithm to base 10 of a number.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>sin, arcsin</term> +<listitem> +<para>Return the sine and inverse sine of a number, respectively. Note that the +argument to sin and the return value of arcsin are in radians.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>cos, arccos</term> +<listitem> +<para>Return the cosine and inverse cosine of a number, respectively. Also in radians.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tan, arctan</term> +<listitem> +<para>Return the tangent and inverse tangent of a number, +respectively. Also in radians.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>sinh, arcsinh</term> +<listitem> +<para>Return the hyperbolic sine and inverse hyperbolic sine of a number, +respectively.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>cosh, arccosh</term> +<listitem> +<para>Return the hyperbolic cosine and inverse hyperbolic cosine of a number, respectively.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>tanh, arctanh</term> +<listitem> +<para>Return the hyperbolic tangent and inverse hyperbolic tangent of a number, +respectively.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>sin, arcsin</term> +<listitem> +<para>Return the sine and inverse sine of a number, respectively. Note that the +argument to sin and the return value of arcsin are in radians.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>cos, arccos</term> +<listitem> +<para>Return the cosine and inverse cosine of a number, respectively. Also in radians.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>pi, e</term> +<listitem> +<para>Constants representing &pgr; (3.14159...) and e (2.71828...), respectively.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> + +<para> +These functions and constants and even all user defined functions can +be used to determine the axes settings as well. See <xref linkend="axes-config"/>. +</para> + +</sect1> + +<sect1 id="func-extension"> + <title>Extensions</title> + <para>An extension for a function is specified by entering a semicolon, + followed by the extension, after the function definition. The extension can either be written in the Quick Edit box or by using the &DCOP; method Parser addFunction. None of the extensions are available for parametric functions but N and D[a,b] work for polar functions too. For example: + <screen> + <userinput> + f(x)=x^2; A1 + </userinput> + </screen> + will show the graph y=x<superscript>2</superscript> with its first + derivative. Supported extensions are described below: + <variablelist> + <varlistentry> + <term>N</term> + <listitem> + <para> + The function will be stored but not be drawn. + It can be used like any other user-defined or predefined function. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>A1</term> + <listitem> + <para> + The graph of the derivative of the function will be drawn + additionally with the same color but less line width. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>A2</term> + <listitem> + <para> + The graph of the second derivative of the function will be + drawn additionally with the same color but less line width. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>D[a,b]</term> + <listitem> + <para> + Sets the domain for which the function will be displayed. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term>P[a{,b...}]</term> + <listitem> + <para> + Give a set of values of a group parameter for which the function should be + displayed. For example: <userinput>f(x,k)=k*x;P[1,2,3]</userinput> will plot + the functions f(x)=x, f(x)=2*x and f(x)=3*x. You can also use functions as the + arguments to the P option. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Please note that you can do all of these operations by using the function editor dialog too. +</para> +</sect1> + +<sect1 id="math-syntax"> +<title>Mathematical Syntax</title> +<para>&kmplot; uses a common way of expressing mathematical functions, so you +should have no trouble working it out. The operators &kmplot; understands are, +in order of decreasing precedence: +<variablelist> + +<varlistentry> +<term>^</term> +<listitem><para>The caret symbol performs exponentiation. ⪚, +<userinput>2^4</userinput> returns 16.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>*, /</term> +<listitem> +<para>The asterisk and slash symbols perform multiplication and +division . ⪚, +<userinput>3*4/2</userinput> returns 6.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term>+, -</term> +<listitem><para>The plus and minus symbols perform addition and +subtraction. ⪚, <userinput>1+3-2</userinput> returns 2.</para> +</listitem> +</varlistentry> + +</variablelist> +</para> +<para> +Note the precedence, which means that if parentheses are not used, +exponentiation is performed before multiplication/division, which is performed +before addition/subtraction. So <userinput>1+2*4^2</userinput> returns 33, and +not, say 144. To override this, use parentheses. To use the above example, +<userinput>((1+2)*4)^2</userinput> <emphasis>will</emphasis> return 144. +</para> +</sect1> + +<!-- +<sect1 id="coord-system"> +<title>Coordinate Systems</title> + +<para><inlinemediaobject> +<imageobject> +<imagedata fileref="ksys1.png" format="PNG"/> +</imageobject> +</inlinemediaobject></para> + +<para> +<inlinemediaobject> +<imageobject> +<imagedata fileref="ksys2.png" format="PNG"/> +</imageobject> +</inlinemediaobject></para> + +<para> +<inlinemediaobject> +<imageobject> +<imagedata fileref="ksys3.png" format="PNG"/> +</imageobject> +</inlinemediaobject></para> +--> +<sect1 id="coord-area"><title>Plotting Area</title> +<para> +By default, explicitly given functions are plotted for the whole of the visible part of the +x-axis. You can specify an other range in the edit-dialog for the function. For every pixel on the x-axis &kmplot; calculates a function value. +If the plotting area contains the resulting point it is connected to the last +drawn point by a line. +</para> +<para> +Parametric functions are plotted for parameter values from 0 up to 2&pgr;. +You can set the plotting range in the dialog for the function too. +</para> +</sect1> + +<sect1 id="coord-cross"> +<title>Cross Hair Cursor</title> +<para> +While the mouse cursor is over the plotting area the cursor changes to a cross hair. The current coordinates can be seen at the intersections with the coordinate axes and also in the status bar at the bottom of the main window. +</para> +<para> +You can trace a function's values more precisely by clicking onto or next to a graph. The selected function is shown in the status bar in the right column. The cross hair then will be caught and be colored in the same color as the graph. If the graph has the same color as the background color, the cross hair will have the inverted color of the background. When moving the mouse or pressing the keys Left or Right the cross hair will follow the function and you see the current x- and y-value. If the cross hair is close to y-axis, the root-value is shown in the statusbar. You can switch function with the Up and Down keys. A second click anywhere in the window or pressing any non-navigating key will leave this trace mode. +</para> +<para> +Note that tracing is only possible with explicitly given functions. +The coordinates are always displayed according to a Cartesian system of +coordinates. Neither non-single-point parametric functions nor functions given in polar +coordinates can be traced in this way. +</para> + +</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: +--> diff --git a/doc/kmplot/settings-colors.png b/doc/kmplot/settings-colors.png Binary files differnew file mode 100644 index 00000000..54a2c289 --- /dev/null +++ b/doc/kmplot/settings-colors.png diff --git a/doc/kmplot/settings-fonts.png b/doc/kmplot/settings-fonts.png Binary files differnew file mode 100644 index 00000000..735ccac6 --- /dev/null +++ b/doc/kmplot/settings-fonts.png diff --git a/doc/kmplot/settings-scaling.png b/doc/kmplot/settings-scaling.png Binary files differnew file mode 100644 index 00000000..442e56d7 --- /dev/null +++ b/doc/kmplot/settings-scaling.png diff --git a/doc/kmplot/settingsdlg.png b/doc/kmplot/settingsdlg.png Binary files differnew file mode 100644 index 00000000..388c23ea --- /dev/null +++ b/doc/kmplot/settingsdlg.png diff --git a/doc/kmplot/threeplots.png b/doc/kmplot/threeplots.png Binary files differnew file mode 100644 index 00000000..867c224a --- /dev/null +++ b/doc/kmplot/threeplots.png diff --git a/doc/kmplot/using.docbook b/doc/kmplot/using.docbook new file mode 100644 index 00000000..88092ad8 --- /dev/null +++ b/doc/kmplot/using.docbook @@ -0,0 +1,321 @@ +<chapter id="using-kmplot"> +<title>Using &kmplot;</title> + +<para>&kmplot; deals with named functions, which can be specified in +terms of Cartesian coordinates (called <quote>explicit +functions</quote>), polar coordinates or as parametric functions. To +enter a function, choose +<menuchoice><guimenu>Plot</guimenu><guimenuitem>Edit +Plots...</guimenuitem> </menuchoice>. You can also enter new functions +in the <guilabel>Function equation</guilabel> text box in the main +&kmplot; window. The text box can handle explicit and polar +functions. Each function you enter must have a unique name (&ie;, a +name that is not taken by any of the existing functions displayed in +the list box). A function name will be automatically generated if you +do not specify one.</para> + +<para>For more information on &kmplot; functions, see <xref +linkend="reference"/>. +</para> + +<screenshot> +<screeninfo>Here is a screenshot of the &kmplot; welcome window</screeninfo> + <mediaobject> + <imageobject> + <imagedata fileref="main.png" format="PNG"/> + </imageobject> + <textobject> + <phrase>Screenshot</phrase> + </textobject> + </mediaobject> +</screenshot> + +<sect1 id="function-types"> +<title>Function Types</title> + +<sect2 id="explicit-functions"> +<title>Explicit Functions</title> +<para>To enter an explicit function (&ie;, a function in the form y=f(x)) into &kmplot;, just enter it in the +following form: +<screen> +<userinput><replaceable>f</replaceable>(<replaceable>x</replaceable>)=<replaceable>expression</replaceable></userinput> +</screen> +Where: +<itemizedlist> +<listitem><para> + <replaceable>f</replaceable> is the name of the function, and can be any +string of letters and numbers you like, provided it does not start with any of +the letters x, y or r (since these are used for parametric and polar +functions).</para> +</listitem> + +<listitem><para> +<replaceable>x</replaceable> is the x-coordinate, to be used in the expression +following the equals sign. It is in fact a dummy variable, so you can use any +variable name you like, but the effect will be the same.</para> +</listitem> + +<listitem> +<para><replaceable>expression</replaceable> is the expression to be plotted, +given in appropriate syntax for &kmplot;. See <xref linkend="math-syntax"/>. +</para> +</listitem> + +</itemizedlist> +</para> +<para>As an example, to draw the graph of y=x<superscript>2</superscript>+2x, +enter the following into the functions dialog of &kmplot;: +<screen> +f(x)=x^2+2x +</screen> +</para> +</sect2> + +<sect2 id="parametric-functions"> +<title>Parametric Functions</title> +<para>Parametric functions are those in which the x and y coordinates are +defined by separate functions of another variable, often called t. To enter a +parametric function in &kmplot;, follow the procedure as for an explicit +function, but prefix the name of the function describing the x-coordinate with +the letter x, and the function describing the y-coordinate with the letter +y. As with explicit functions, you may use any variable name you wish for the +parameter. To draw a parametric function, you must go to <guimenu>Plot</guimenu><guimenuitem>New Parametric Plot...</guimenuitem>. A function name will be created automatic if you do not specify one.</para> +<para>As an example, suppose you want to draw a circle, which has parametric +equations x=sin(t), y=cos(t). In the &kmplot; functions dialog, do the +following: +<orderedlist> +<listitem><para>Open the parametric plot dialog with +<menuchoice><guimenu>Plot</guimenu><guimenuitem>New Parametric Plot...</guimenuitem> +</menuchoice>.</para> +</listitem> +<listitem><para>Enter a name for the function, say, +<userinput>circle</userinput>, in the <guilabel>Name</guilabel> +box. The names of the x and y functions change to match this name: the +x function becomes <guilabel>xcircle(t)</guilabel> and the y function +becomes <guilabel>ycircle(t)</guilabel>.</para> +</listitem> +<listitem> +<para>In the x and y boxes, enter the appropriate equations, &ie;, +<guilabel>xcircle(t)=</guilabel><userinput>sin(t)</userinput> and +<guilabel>ycircle(t)=</guilabel><userinput>cos(t)</userinput>.</para> +</listitem> +</orderedlist> +Click on <guibutton>OK</guibutton> and the function will be drawn. +</para> +<para>You can set some further options for the plot in this dialog: +<variablelist> + +<varlistentry> +<term><guilabel>Hide</guilabel></term> +<listitem> +<para>If this option is selected, the plot is not drawn, but &kmplot; +remembers the function definition, so you can use it to define other +functions.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Custom plot minimum-range</guilabel></term> +<term><guilabel>Custom plot maximum-range</guilabel></term> +<listitem> +<para>If this options are selected, you can change the maximum and +minimum values of the parameter t for which the function is plotted +using the <guilabel>Min:</guilabel> and <guilabel>Max:</guilabel> +boxes.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Line width:</guilabel></term> +<listitem> +<para>With this option you can set the width of the line drawn on the +plot area, in units of 0.1mm.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><guilabel>Color:</guilabel></term> +<listitem> +<para>Click on the color box and pick a color in the dialog that +appears. The line on the plot will be drawn in this color.</para> +</listitem> +</varlistentry> +</variablelist> +</para> +</sect2> + +<sect2 id="polar-functions"> +<title>Entering Functions in Polar Coordinates</title> + +<para>Polar coordinates represent a point by its distance from the origin +(usually called r), and the angle a line from the origin to the point makes +with the x-axis (usually represented by the Greek letter theta). To enter +functions in polar coordinates, use the menu entry +<menuchoice><guimenu>Plot</guimenu><guimenuitem>New Polar Plot...</guimenuitem> +</menuchoice>. In the box labeled <guilabel>r</guilabel>, complete the +function definition, including the name of the theta variable you want +to use, ⪚, to draw the Archimedes' spiral r=theta, enter: +<screen> +<userinput> +(theta)=theta +</userinput> +</screen> +so that the whole line reads <quote>r(theta)=theta</quote>. Note that +you can use any name for the theta variable, so +<quote>r(foo)=foo</quote> would have produced exactly the same output. +</para> + +</sect2> + +</sect1> + +<sect1 id="combining-functions"> +<title>Combining Functions</title> +<para>Functions can be combined to produce new ones. Simply enter the functions +after the equals sign in an expression as if the functions were variables. For +example, if you have defined functions f(x) and g(x), you can plot the sum of f +and g with: +<screen> +<userinput> +sum(x)=f(x)+g(x) +</userinput> +</screen> +</para> +<para>Note that you can only combine functions of the same type, ⪚ an +explicit function cannot be combined with a polar function.</para> +</sect1> + +<sect1 id="function-appearance"> +<title>Changing the appearance of functions</title> + +<para>To change the appearance of a function's graph on the main plot +window, select the function in the <guilabel>Edit Plots</guilabel> +dialog, and click on the <guibutton>Edit</guibutton> button. In the +dialog which appears, you can change the line width in the text box, +and the color of the function's graph by clicking on the color button +at the bottom. If you are editing an explicit function, you will see a +dialog with three tabs. In the first one you specify the equation of +the function. The <guilabel>Derivatives</guilabel> tab lets you draw +the first and second derivative to the function. With the +<guilabel>Integral</guilabel> tab you can draw the integral of the +function which is calculated using Euler's method. </para> +<para>Another way to edit a function is to right click on the +graph. In the popup menu that appears, choose +<guibutton>Edit</guibutton></para> + +<para>For more information on the popup menu, see <xref +linkend="popupmenu"/>. +</para> +</sect1> + +<sect1 id="popupmenu"> +<title>Popup menu</title> + +<para>When right-clicking on a plot function or a single-point parametric plot function a popup menu will appear. +In the menu there are five items available:</para> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenuitem>Hide</guimenuitem> +</menuchoice></term> +<listitem> +<para>Hides the selected graph. Other plots of the graph's function will still be shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Remove</guimenuitem> +</menuchoice></term> +<listitem> +<para>Removes the function. All its graphs will disappear.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Edit</guimenuitem> +</menuchoice></term> +<listitem> +<para>Shows the editor dialog for the selected function.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Copy</guimenuitem> +</menuchoice></term> +<listitem> +<para>Copies the graph to another running &kmplot; instance.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Move</guimenuitem> +</menuchoice></term> +<listitem> +<para>Moves the graph to another running &kmplot; instance.</para> +</listitem> +</varlistentry> +</variablelist> + +<para>For plot functions the following four items are also available:</para> + +<variablelist> +<varlistentry> +<term><menuchoice><guimenuitem>Get y-Value</guimenuitem> +</menuchoice></term> +<listitem> +<para>Opens a dialog in which you can find the y-value corresponding to +a specific x-value. The selected graph will be highlighted in the +dialog. Enter an x value in the <guilabel>X:</guilabel> box, and click +on <guibutton>Calculate</guibutton> (or press &Enter;). The corresponding y +value will be shown under <guilabel>Y:</guilabel>. +</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Search for Minimum Value</guimenuitem> +</menuchoice></term> +<listitem> +<para>Find the minimum value of the graph in a specified range. The +selected graph will be highlighted in the dialog that appears. Enter +the lower and upper boundaries of the region in which you want to +search for a minimum, and click <guibutton>Find</guibutton>. The x and +y values at the minimum will be shown.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Search for Maximum Value</guimenuitem> +</menuchoice></term> +<listitem> +<para>This is the same as <guimenuitem>Search for Minimum +Value</guimenuitem> above, but finds maximum values instead of minima. </para> +</listitem> +</varlistentry> + +<varlistentry> +<term><menuchoice><guimenuitem>Calculate Integral</guimenuitem> +</menuchoice></term> +<listitem> +<para>Select the x-values for the graph in the new dialog that appears. +Calulates the integral and draws the area between the graph and the x-axis in the +selected range in the color of the graph.</para> +</listitem> +</varlistentry> +</variablelist> + + +</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: +--> |
