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

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:
-->
<chapter id="dcop">
<title>Scripting &kmplot;</title>
<para>A new feature in &kde; 3.4 is that you can write scripts for &kmplot; using &DBus; in &kde; 4. 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>qdbus org.kde.kmplot-PID /parser org.kde.kmplot.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>qdbus org.kde.kmplot-PID /parser org.kde.kmplot.Parser.setFunctionFLineWidth ID 20</command>
This command sets the function with the id number ID the line width to 20.</para>
<para><command>qdbus org.kde.kmplot-PID /view org.kde.kmplot.View.drawPlot</command>
This command repaints the window so that the function get visible.</para>
<para>
A list of the available functions:
<variablelist>
<varlistentry>
<term>
/kmplot org.kde.kmplot.KmPlot.fileOpen url
</term>
<listitem>
<para>Load the file <parameter>url</parameter>.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.isModified
</term>
<listitem>
<para>Returns true if any changes are done.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.checkModified
</term>
<listitem>
<para>If there are any unsaved changes, a dialog appears to save, discard or cancel the plots.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.editAxes
</term>
<listitem>
<para>Opens the coordinate system edit dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.toggleShowSlider
</term>
<listitem>
<para>Shows/hides parameter slider window.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.slotSave
</term>
<listitem>
<para>Saves the functions (opens the save dialog if it is a new file).</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.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 org.kde.kmplot.MainDlg.slotPrint
</term>
<listitem>
<para>Opens the print dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.slotResetView
</term>
<listitem>
<para>The same as choosing <menuchoice><guimenu>View</guimenu><guimenuitem>Reset View</guimenuitem></menuchoice> in the menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.slotExport
</term>
<listitem>
<para>Opens the export dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.slotSettings
</term>
<listitem>
<para>Opens the settings dialog.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.slotNames
</term>
<listitem>
<para>Shows the predefined math functions in the handbook.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.findMinimumValue
</term>
<listitem>
<para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Minimum Value...</guimenuitem></menuchoice> in the menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.findMaximumValue
</term>
<listitem>
<para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Maximum Value...</guimenuitem></menuchoice> in the menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.graphArea
</term>
<listitem>
<para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Plot Area</guimenuitem></menuchoice> in the menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/maindlg org.kde.kmplot.MainDlg.calculator
</term>
<listitem>
<para>The same as choosing <menuchoice><guimenu>Tools</guimenu><guimenuitem>Calculator</guimenuitem></menuchoice> in the menu.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/parser org.kde.kmplot.Parser.addFunction f_str0 f_fstr1
</term>
<listitem>
<para>Adds a new function with the expressions <parameter>f_str0</parameter> and <parameter>f_str1</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 could not be defined.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/parser org.kde.kmplot.Parser.removeFunction 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 org.kde.kmplot.Parser.setFunctionExpression id eq f_str
</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 org.kde.kmplot.Parser.countFunctions
</term>
<listitem>
<para>Returns the number of functions (parametric functions are calculated as two).</para>
</listitem>
</varlistentry>
<!-- method double org.kde.kmplot.Parser.fkt(uint id, uint eq, double eq) what is this?-->
<varlistentry>
<term>
/parser org.kde.kmplot.Parser.listFunctionNames
</term>
<listitem>
<para>Returns a list with all functions.</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
/parser org.kde.kmplot.Parser.fnameToID f_str
</term>
<listitem>