Commit 6e773a0b authored by Burkhard Lück's avatar Burkhard Lück

merge all docbooks into a single index.docbook

parent ba7e0b91
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="menu">
<title>Menu Items</title>
<para>Apart from the common &kde; menus described in the <ulink url="help:/fundamentals/ui.html#menus">Menu</ulink>
chapter of the &kde; Fundamentals documentation &kmplot; has these application specific menu entries:
</para>
<sect2 id="a-file-menu">
<title>The File Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>File</guimenu>
<guimenuitem>Export...</guimenuitem></menuchoice></term>
<listitem><para><action>Exports</action> the plotted graphs to an image file in all formats supported by &kde;.</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="a-edit-menu">
<title>The Edit Menu</title>
<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Edit</guimenu><guimenuitem>Constants...</guimenuitem>
</menuchoice></term>
<listitem><para>Displays the <guilabel>Constants</guilabel> dialog box. See <xref linkend="constants-config"/>.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="a-view-menu">
<title>The View Menu</title>
<para>The first three items in the menu are related to zooming.</para>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>1</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom In</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>This tool can be operator in two different manners. To zoom in on a point on the graph, click on it. To zoom in on a specific section of the graph, hold and drag the mouse to form a rectangle, which will be the new axes ranges when the mouse button is released.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<shortcut>
<keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo>
</shortcut>
<guimenu>View</guimenu>
<guimenuitem>Zoom Out</guimenuitem>
</menuchoice>
</term>
<listitem>
<para>The tool can also be used in two different manners. To zoom out and center on a point, click on that point. To fit the existing view into a rectangle, hold and drag the mouse to form that rectangle.</para></listitem>
</varlistentry>
<varlistentry>
<term>
<menuchoice>
<guimenu>View</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>
<varlistentry>
<term><menuchoice><guimenu>View</guimenu><guimenuitem>Reset View</guimenuitem>
</menuchoice></term>
<listitem><para>Resets the view.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><guimenu>View</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>View</guimenu>
<guimenuitem>Show Sliders</guimenuitem>
</menuchoice></term>
<listitem>
<para><action>Toggles</action> the visibility of the slider dialog.
In the dialog move a slider to change the parameter of the function plot connected to it.</para>
<para>Enable this on the Function tab and select one of the sliders to change the parameter value dynamically. The values vary from 0 (left) to 10 (right) by default, but can be changed in the slider dialog.</para>
<para>For a small tutorial see <ulink url="http://userbase.kde.org/KmPlot/Using_Sliders">Using Sliders</ulink>.</para>
<!--http://forum.kde.org/viewtopic.php?f=21&t=90183 kmplot slider examples
KmPlot supports only one parameter. Feature request on bugs.kde.org: https://bugs.kde.org/show_bug.cgi?id=139097-->
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="a-tools-menu">
<title>The Tools Menu</title>
<para>This menu contains some tools for the functions that can be useful:</para>
<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Calculator</guimenuitem>
</menuchoice></term>
<listitem>
<para>Opens the <guilabel>Calculator</guilabel> dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Plot Area...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Select a graph and the values of the horizontal axis in the new dialog that appears.
Calculates the integral and draws the area between the graph and the horizontal axis in the
range of the selected values in the color of the graph.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><menuchoice><guimenu>Tools</guimenu>
<guimenuitem>Find Minimum...</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>Find Maximum...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Find the maximum value of the graph in a specified range.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="a-help-menu">
<title>The Help Menu</title>
<para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> with one addition:</para>
<variablelist>
<varlistentry>
<term><menuchoice><guimenu>Help</guimenu>
<guimenuitem>Predefined Math Functions...</guimenuitem>
</menuchoice></term>
<listitem>
<para>Opens this handbook with a list of the predefined function names and constants
that &kmplot; knows.</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</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:
-->
<chapter id="configuration">
<title>Configuring &kmplot;</title>
<para>To access the &kmplot; configuration
dialog, select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure
&kmplot;...</guimenuitem></menuchoice>
The settings for <guimenuitem>Constants...</guimenuitem> can only be changed
from the <guimenu>Edit</guimenu> menu and the <guimenuitem>Coordinate System...</guimenuitem> only
from the <guimenu>View</guimenu> menu. </para>
<sect1 id="general-config">
<title>General Configuration</title>
<screenshot>
<screeninfo>Screenshot of the General Settings dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="settings-general.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the General Settings dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>Here you can set global settings which automatic will be saved when you exit &kmplot;. you can set angle-mode (radians and degrees), zoom in and zoom out factors, and whether to show advanced plot tracing. </para>
</sect1>
<sect1 id="diagram-config">
<title>Diagram Configuration</title>
<screenshot>
<screeninfo>Screenshot of the Diagram Appearance dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="settings-diagram.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Diagram Appearance dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<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
(&eg;, (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>Other options for the diagram appearance can also be configured:
<variablelist>
<varlistentry>
<term><guilabel>Axis Labels</guilabel></term>
<listitem>
<para>Sets labels for the horizontal and vertical axes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Axis width:</guilabel></term>
<listitem>
<para>Sets the width of the lines representing the axes.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Line width:</guilabel></term>
<listitem>
<para>Sets the width of the lines used for drawing the grid.</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 of the axes are shown on the plot and the axes' tics are labeled.</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>
</sect1>
<sect1 id="colors-config">
<title>Colors Configuration</title>
<screenshot>
<screeninfo>Screenshot of the Colors dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="settings-colors.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Colors dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
In the <guilabel>Coords</guilabel> section of the <guilabel>Colors</guilabel>
configuration dialog, you can change the colors of the axes, the grid and the background of the
main &kmplot; area.
</para>
<para>The <guilabel>Default Function Colors</guilabel> control which colors are cycled through when creating new functions.</para>
</sect1>
<sect1 id="font-config">
<title>Fonts Configuration</title>
<screenshot>
<screeninfo>Screenshot of the Fonts dialog</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="settings-fonts.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Screenshot of the Fonts dialog</phrase>
</textobject>
</mediaobject>
</screenshot>
<variablelist>
<varlistentry>
<term><guilabel>Axis labels</guilabel></term>
<listitem>
<para>The font used for drawing the axis numbers and x/y labels.</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Diagram label</guilabel></term>
<listitem>
<para>The font used for drawing diagram labels (&eg;, those showing the plot name or extreme points).</para>
</listitem>
</varlistentry>
<varlistentry>
<term><guilabel>Header table</guilabel></term>
<listitem>
<para>The font used for drawing the header when printing a plot.</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:
-->
<chapter id="credits">
<title>Credits and License</title>
<para>
&kmplot;
</para>
<para>
Program copyright 2000-2002 Klaus-Dieter M&ouml;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>
<listitem>
<para>Porting to Qt 4, UI improvements, features: David Saxton <email>david@bluehaze.org</email></para>
</listitem>
</itemizedlist>
<para>
Documentation copyright 2000--2002 by Klaus-Dieter M&ouml;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>
<para>Documentation extended and updated for &kde; 4.0 by David Saxton <email>david@bluehaze.org</email>.</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove. Commercial development should
-->
&underGPL; <!-- GPL License -->
</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:
-->
This diff is collapsed.
<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;, <email>f_edemar@linux.se</email> or <email>david@bluehaze.org</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:
-->
<chapter id="first-steps">
<title>First Steps With &kmplot;</title>
<sect1 id="simple-function-plot">
<title>Simple Function Plot</title>
<para>
In the sidebar on the left, there is the <guilabel>Create</guilabel> button with a drop down menu for creating new plots.
Click on it, and select <guilabel>Cartesian Plot</guilabel>. The text box for editing the current equation will be focused. Replace the default text with
<screen><userinput>y = x^2</userinput></screen>
and press &Enter;.
This will draw the plot of y = x<superscript>2</superscript> in the coordinate system.
Clicking on the <guilabel>Create</guilabel> button again, select <guilabel>Cartesian Plot</guilabel>, and this time enter the text
<screen><userinput>y = 5sin(x)</userinput></screen>
to get another plot.
</para>
<para>Click on one of the lines you have just plotted. Now the crosshair
becomes the color of the current plot and is attached to the it. You can
use the mouse to move the crosshair 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 horizontal axis the
root will be displayed in the status bar, too.</para>
<para>Click the mouse again and the crosshair 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>The <guilabel>Functions</guilabel> sidebar lists all the functions that you have plotted.
If <guilabel>y = x^2</guilabel> isn't already selected, select it.
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> and hit enter.
To select another color for the plot, click the <guilabel>Color</guilabel> button in the section
<guilabel>Appearance</guilabel> at the bottom of the function sidebar and select a new color.
<note>
<para>All changes can be undone via <menuchoice><guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem> </menuchoice>.</para>
</note>
</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:
-->
This diff is collapsed.
<appendix id="installation">
<title>Installation</title>
&install.intro.documentation;
<mediaobject>
<imageobject>
<imagedata fileref="edu-logo.png" format="PNG"/>
</imageobject>
</mediaobject>
<para>&kmplot; itself can be found on the <ulink
url="http://edu.kde.org/kmplot">&kmplot; home page</ulink> and
is part of the &kde;-Edu project</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:
-->
<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 several different types of plots:</para>
<itemizedlist>
<listitem><para>Explicit cartesian plots of the form y = f(x).</para></listitem>
<listitem><para>Parametric plots, where the x and y components are specified as functions of an independent variable.</para></listitem>
<listitem><para>Polar plots of the form r = r(&thgr;).</para></listitem>
<listitem><para>Implicit plots, where the x and y coordinates are related by an expression.</para></listitem>
<listitem><para>Explicit differential plots.</para></listitem>
</itemizedlist>
<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:
-->
This diff is collapsed.
This diff is collapsed.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment