Commit 14dd2625 authored by Matthias Messmer's avatar Matthias Messmer

index splitted into several docs, chaper by chapter

added some illustrating snapshots and images

svn path=/trunk/kdeedu/doc/kmplot/; revision=163219
parent ac7e9a03
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="kmplot-mainwindow">
<title>The main &kmplot; window</title>
<screenshot>
<screeninfo>Here's a screenshot of the &kmplot; main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Here's a screenshot of the &kmplot; main window</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="functions">
<title>The <guimenu>Functions</guimenu> Menu</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="kfkt.png" format="PNG"/>
</imageobject>
</inlinemediaobject>
This menu entry or tool button opens the Functions Editor.
Here you can enter the functions' equations of 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
derivation and to choose values for the function group parameter.
</para>
<sect2 id="func_syntax"><title>Syntax</title>
<para>
Some syntax rules must be complied with:
<screen width="20">
<userinput>
name(var1[, var2])=term [;extensions]
</userinput>
</screen>
</para>
<variablelist>
<varlistentry>
<term>name</term>
<listitem><para>
The functions name.
If the first character is "r" the parser assumes that you
use polar coordinates.
If the first character is "x" (for instance "xfunc") the parser
expects a second
function with a leading "y" (here "yfunc") to define the function in
paramtric form.
</para></listitem>
</varlistentry>
<varlistentry>
<term>var1</term>
<listitem><para>The functions variable</para></listitem>
</varlistentry>
<varlistentry>
<term>var2</term>
<listitem><para>
The function group parameter. It must be seperated by a comma.
</para></listitem>
</varlistentry>
<varlistentry>
<term>term</term>
<listitem><para>The function's term</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="func_predefined"><title>Predefined Function Names and Constants</title>
<screenshot>
<screeninfo>Names</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="namesdlg.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>
Predefined function names and constants are shown in this window.
</phrase>
</textobject>
</mediaobject>
</screenshot>
<para>
These functions and constants and even all user defined functions
can be used to determine the
axes settings as well.
</para>
</sect2>
<sect2 id="func_dialog"><title>Functions Dialog Window</title>
<para>...</para>
</sect2>
<sect2 id="func_extension"><title>Extensions</title>
<variablelist>
<varlistentry>
<term>N</term>
<listitem>
<para>
The function will be stored but not be drawn.
So 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.
This extension has no effect on functions defined in
parametric form.
</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.
This extension has no effect on functions defined in
parametric form.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>D[a,b]</term>
<listitem>
<para>
...
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>P[a{,b}]</term>
<listitem>
<para>
With this extension you can give a list of values for the
parameter of a function group of which the graph should be drawn.
Also terms are allowed.
The use of this extension presumes that the parameter is given as a
second function variable.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="coord_system"><title>Coordinate Systems</title>
<para>
<inlinemediaobject>
<imageobject>
<imagedata fileref="ksys1.png" format="PNG"/>
</imageobject>
</inlinemediaobject>&nbsp;
<inlinemediaobject>
<imageobject>
<imagedata fileref="ksys2.png" format="PNG"/>
</imageobject>
</inlinemediaobject>&nbsp;
<inlinemediaobject>
<imageobject>
<imagedata fileref="ksys3.png" format="PNG"/>
</imageobject>
</inlinemediaobject>&nbsp;
...
</para>
<sect2 id="coord_area"><title>Plotting Area</title>
<para>
By default explicitly given functions are plotted for visible part of the x-axis.
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. In the functions dialog window the interval, in which the
graph shall be plotted, can be changed manually.
</para>
<para>
Parametric functions are plotted for parameter values from 0 upto 2&pgr;.
This range can be set in the functions dialog window manually, too.
</para>
</sect2>
<sect2 id="coord_cross"><title>Cross Hair Cursor</title>
<para>
During the mouse cursor points to the plotting area the cursor changes to a
cross hair. The current coordinates can be found at the intersections with the
coordinate axes and also in the status bar at the bottom edge of the main window.
</para>
<para>
You can trace the functions values more precisely by clicking onto or next to a
graph. The cross hair then will be catched and be colored in the same color as the
graph. A second click anywhere in the window will leave this trace mode.
</para>
<para>
Please notice that tracing is only possible with explicitly given functions.
The coordinates are allways displayed according to cartesian system of coordinates.
Neither parametric functions, nor functions given in polar coordinates,
nor derivatives can not be traced this way.
</para>
</sect2>
<sect2 id="coord_types"><title>Types of Coordinate Systems</title>
<para>
As you can define the functions with cartesian or polar coordinates
the grid can be displayed cartesian or polar divisions.
Please choose the style for the cartesian grid between lines and little crosses in
the grid dialog window.
</para>
</sect2>
</sect1>
<sect1 id="scale_print"><title>Scaling and Printing</title>
<para>...</para>
</sect1>
</chapter>
<chapter id="credits">
<title>Credits and License</title>
<para>
&kmplot;
</para>
<para>
Program copyright 2000-2002 Klaus-Dieter M&ouml;ller <email>kd.moeller@t-online.de</email>
</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 <email>bmlmessmer@web.de</email></para>
</listitem>
</itemizedlist>
<para>
Documentation copyright 2000--2002 by Klaus-Dieter M&ouml;ller <email>kd.moeller@t-online.de</email>
</para>
<!-- TRANS:CREDIT_FOR_TRANSLATORS -->
&underFDL; <!-- FDL: do not remove. Commercial development should
-->
&underGPL; <!-- GPL License -->
</chapter>
<chapter id="developers">
<title>Developer's Guide to &kmplot;</title>
<para>If you want to contribute &kmplot; feel free to send me a mail
<email>kd.moeller@t-online.de</email></para>
</chapter>
<?xml version="1.0" encoding="ISO-8859-1" ?>
<!DOCTYPE book PUBLIC "-//KDE//DTD DocBook XML V4.1.2-Based Variant V1.1//EN"
"dtd/kdex.dtd" [
"dtd/kdex.dtd" [
<!ENTITY kappname "&kmplot;"><!-- replace kmplot here -->
<!ENTITY package "kdeedu">
<!ENTITY introduction SYSTEM "introduction.docbook">
<!ENTITY using SYSTEM "using.docbook">
<!ENTITY commands SYSTEM "commands.docbook">
<!ENTITY menu SYSTEM "menu.docbook">
<!ENTITY developer SYSTEM "developer.docbook">
<!ENTITY credits SYSTEM "credits.docbook">
<!ENTITY install SYSTEM "install.docbook">
<!ENTITY % addindex "IGNORE">
<!ENTITY % English "INCLUDE"><!-- change language only here -->
]>
......@@ -10,509 +17,78 @@
<book lang="&language;">
<bookinfo>
<title>The &kmplot; Handbook</title>
<authorgroup>
<author>
<firstname>Klaus-Dieter</firstname>
<othername></othername>
<surname>M&ouml;ller</surname>
<affiliation>
<address><email>kd.moeller@t-online.de</email></address>
</affiliation>
</author>
</authorgroup>
<!-- TRANS:ROLES_OF_TRANSLATORS -->
<copyright>
<year>2000</year><year>2001</year><year>2002</year>
<holder>Klaus-Dieter M&ouml;ller</holder>
</copyright>
<legalnotice>&FDLNotice;</legalnotice>
<date>2002-02-10</date>
<releaseinfo>0.4.0</releaseinfo>
<!-- Abstract about this handbook -->
<abstract>
<para>
&kmplot; is a mathematical function plotter for the &kde; Desktop.
</para>
</abstract>
<keywordset>
<keyword>KDE</keyword>
<keyword>KMPlot</keyword>
<keyword>EDU</keyword>
<keyword>edutainment</keyword>
<keyword>plotting</keyword>
<keyword>math</keyword>
</keywordset>
</bookinfo>
<chapter id="introduction">
<title>Introduction</title>
<para>
&kmplot; is a mathematical function plotter for the &kde; Desktop.
It has built in a powerful parser.
You can plot different functions simultaneously and combine their function
terms to build new functions.
</para>
<para>&kmplot; supports functions with parameters and functions in
polar coordinates. Several grid modes are possible. Plots may be
printed with high precision in correct scale. </para>
</chapter>
<chapter id="using-kmplot">
<title>Using &kmplot;</title>
<para>The welcome window lets you choose the type of task by clicking
on one of the buttons. The buttons are labeled with the value
omitted in the tasks.</para>
<screenshot>
<screeninfo>Here's 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="kmplot-features">
<title>More &kmplot; features</title>
<para>
...
</para>
</sect1>
</chapter>
<chapter id="commands">
<title>Command Reference</title>
<sect1 id="kmplot-mainwindow">
<title>The main &kmplot; window</title>
<screenshot>
<screeninfo>Here's a screenshot of the &kmplot; main window</screeninfo>
<mediaobject>
<imageobject>
<imagedata fileref="main.png" format="PNG"/>
</imageobject>
<textobject>
<phrase>Here's a screenshot of the &kmplot; main window</phrase>
</textobject>
</mediaobject>
</screenshot>
</sect1>
<sect1 id="functions">
<title>The <guimenu>Functions</guimenu> Menu</title>
<para>
This menu entry or tool button opens the Functions Editor.
Here you can enter the functions' equations of 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
derivation and to choose values for the function group parameter.
</para>
<sect2 id="func_syntax"><title>Syntax</title>
<para>
Some syntax rules must be complied with:
<screen width="20">
<userinput>
name(var1[, var2])=term [;extensions]
</userinput>
</screen>
</para>
<variablelist>
<varlistentry>
<term>name</term>
<listitem><para>
The functions name.
If the first character is "r" the parser assumes that you
use polar coordinates.
If the first character is "x" (for instance "xfunc") the
parser expects a second function with a leading "y" (here "yfunc") to define the function in
paramtric form.
</para></listitem>
</varlistentry>
<varlistentry>
<term>var1</term>
<listitem><para>The functions variable</para></listitem>
</varlistentry>
<varlistentry>
<term>var2</term>
<listitem><para>
The function group parameter. It must be seperated by a comma.
</para></listitem>
</varlistentry>
<varlistentry>
<term>term</term>
<listitem><para>The function's term</para></listitem>
</varlistentry>
</variablelist>
</sect2>
<sect2 id="func_predefined"><title>Predefined Function Names and Constants</title>
<para>...</para>
</sect2>
<sect2 id="func_dialog"><title>Functions Dialog Window</title>
<para>...</para>
</sect2>
<sect2 id="func_extension"><title>Extensions</title>
<variablelist>
<varlistentry>
<term>N</term>
<listitem>
<para>
The function will be stored but not be drawn.
So 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.
This extension has no effect on functions defined in
parametric form.
</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.
This extension has no effect on functions defined in
parametric form.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>D[a,b]</term>
<listitem>
<para>
...
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>P[a{,b}]</term>
<listitem>
<para>
With this extension you can give a list of values for the
parameter of a function group of which the graph should be drawn.
Also terms are allowed.
The use of this extension presumes that the parameter is given as a
second function variable.
</para>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>
<sect1 id="coord_system"><title>Coordinate Systems</title>
<para>...</para>
<sect2 id="coord_area"><title>Plotting Area</title>
<para>...</para>
</sect2>
<sect2 id="coord_cross"><title>Cross Hair Cursor</title>
<para>...</para>
</sect2>
<sect2 id="coord_types"><title>Types of Coordinate Systems</title>
<para>...</para>
</sect2>
</sect1>
<sect1 id="scale_print"><title>Scaling and Printing</title>
<para>...</para>
</sect1>
</chapter>
<chapter id="menuentries">
<title>The Menu Entries</title>
<sect1>
<title>The <guimenu>File</guimenu> Menu</title>
<para>
<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>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 to a specific file</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 the printer or to a file</action></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>Quits</action> &kmplot;</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</sect1>
<sect1 id="func_menu">
<title>The <guimenu>Functions</guimenu> Menu</title>
<variablelist>
<varlistentry>
<term>
<menuchoice>
<guimenu>Functions</guimenu>
<guimenuitem>Functions</guimenuitem>
</menuchoice>
</term>
<listitem>
<para><action>Shows the Functions
Dialog Window where you can enter the function equations
and some attributes of the plot.</action></para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
<sect1 id="settings_menu">
<title>The <guimenu>Settings</guimenu> Menu</title>