diff options
Diffstat (limited to 'doc/kmplot/configuration.docbook')
| -rw-r--r-- | doc/kmplot/configuration.docbook | 237 |
1 files changed, 237 insertions, 0 deletions
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: +--> |