Git commit 8b2f1e0d6d402e92ad954e860369e12014f78317 by Burkhard L?ck. Committed on 23/08/2013 at 13:21. Pushed by lueck into branch 'master'.
update to 4.11, new pngs M +27 -199 doc/commands.docbook M +13 -6 doc/configuration.docbook M +1 -1 doc/firststeps.docbook M +2 -2 doc/index.docbook M +14 -14 doc/reference.docbook M +- -- doc/settings-colors.png M +- -- doc/settings-constants.png M +- -- doc/settings-coords.png M +- -- doc/settings-diagram.png M +- -- doc/settings-fonts.png M +- -- doc/settings-general.png M +4 -4 doc/using.docbook http://commits.kde.org/kmplot/8b2f1e0d6d402e92ad954e860369e12014f78317 diff --git a/doc/commands.docbook b/doc/commands.docbook index 87ef007..dfd6136 100644 --- a/doc/commands.docbook +++ b/doc/commands.docbook @@ -1,127 +1,32 @@ <chapter id="commands"> <title>Command Reference</title> -<sect1 id="a-file-menu"> - <title>The <guimenu>File</guimenu> Menu</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> - <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> - <guisubmenu>Open Recent</guisubmenu> - </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>Exports</action> the plotted graphs to an image file.</para></listitem> + <listitem><para><action>Exports</action> the plotted graphs to an image file in all formats supported by &kde;.</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> +</sect2> -<sect1 id="a-edit-menu"> - <title>The <guimenu>Edit</guimenu> Menu</title> - +<sect2 id="a-edit-menu"> + <title>The Edit Menu</title> <variablelist> <varlistentry> - <term><menuchoice> - <shortcut> - <keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo> - </shortcut> - <guimenu>Edit</guimenu><guimenuitem>Undo</guimenuitem> - </menuchoice></term> - <listitem><para>Undo the last command.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><menuchoice> - <shortcut> - <keycombo action="simul">&Ctrl;&Shift;<keycap>Z</keycap></keycombo> - </shortcut> - <guimenu>Edit</guimenu><guimenuitem>Redo</guimenuitem> - </menuchoice></term> - <listitem><para>Redo the last command that was undone.</para> - </listitem> - </varlistentry> - - <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"/>. @@ -129,10 +34,10 @@ </listitem> </varlistentry> </variablelist> -</sect1> +</sect2> -<sect1 id="a-view-menu"> - <title>The <guimenu>View</guimenu> Menu</title> +<sect2 id="a-view-menu"> + <title>The View Menu</title> <para>The first three items in the menu are related to zooming.</para> <variablelist> @@ -206,10 +111,10 @@ </varlistentry> </variablelist> -</sect1> +</sect2> -<sect1 id="a-tools-menu"> - <title>The <guimenu>Tools</guimenu> Menu</title> +<sect2 id="a-tools-menu"> + <title>The Tools Menu</title> <para>This menu contains some tools for the functions that can be useful:</para> @@ -229,9 +134,9 @@ <guimenuitem>Plot Area...</guimenuitem> </menuchoice></term> <listitem> - <para>Select a graph and the x-values in the new dialog that appears. - Calculates 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> + <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> @@ -254,86 +159,12 @@ </varlistentry> </variablelist> -</sect1> - -<sect1 id="a-settings-menu"> - <title>The <guimenu>Settings</guimenu> Menu</title> - - <variablelist> - <varlistentry> - <term><menuchoice><guimenu>Settings</guimenu> - <guimenuitem>Show 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 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>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> +</sect2> -<sect1 id="a-help-menu"> - <title>The <guimenu>Help</guimenu> Menu</title> +<sect2 id="a-help-menu"> + <title>The Help Menu</title> - <para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> as described - below, with one addition:</para> + <para>&kmplot; has a standard &kde; <guimenu>Help</guimenu> with one addition:</para> <variablelist> <varlistentry> @@ -347,10 +178,7 @@ </varlistentry> </variablelist> - <para>The standard &kde; <guimenu>Help</guimenu> entries are:</para> - - &help.menu.documentation; - +</sect2> </sect1> diff --git a/doc/configuration.docbook b/doc/configuration.docbook index 7d49a5a..f7405fc 100644 --- a/doc/configuration.docbook +++ b/doc/configuration.docbook @@ -2,13 +2,13 @@ <title>Configuring &kmplot;</title> <para>To access the &kmplot; configuration dialog, select <menuchoice><guimenu>Settings</guimenu><guimenuitem>Configure - &kmplot;...</guimenuitem></menuchoice>. + &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><guilabel>General</guilabel> Configuration</title> + <title>General Configuration</title> <screenshot> <screeninfo>Screenshot of the General Settings dialog</screeninfo> @@ -26,7 +26,7 @@ </sect1> <sect1 id="diagram-config"> - <title><guilabel>Diagram</guilabel> Configuration</title> + <title>Diagram Configuration</title> <screenshot> <screeninfo>Screenshot of the Diagram Appearance dialog</screeninfo> @@ -78,6 +78,13 @@ <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> @@ -108,7 +115,7 @@ <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> + <para>If checked, the names of the axes are shown on the plot and the axes' tics are labeled.</para> </listitem> </varlistentry> @@ -132,7 +139,7 @@ </sect1> <sect1 id="colors-config"> - <title><guilabel>Colors</guilabel> Configuration</title> + <title>Colors Configuration</title> <screenshot> <screeninfo>Screenshot of the Colors dialog</screeninfo> @@ -156,7 +163,7 @@ </sect1> <sect1 id="font-config"> - <title><guilabel>Fonts</guilabel> Configuration</title> + <title>Fonts Configuration</title> <screenshot> <screeninfo>Screenshot of the Fonts dialog</screeninfo> diff --git a/doc/firststeps.docbook b/doc/firststeps.docbook index 7322a6e..6e89499 100644 --- a/doc/firststeps.docbook +++ b/doc/firststeps.docbook @@ -19,7 +19,7 @@ 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 x-axis the + 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 diff --git a/doc/index.docbook b/doc/index.docbook index af5d179..f47d098 100644 --- a/doc/index.docbook +++ b/doc/index.docbook @@ -57,8 +57,8 @@ <legalnotice>&FDLNotice;</legalnotice> -<date>2008-02-09</date> -<releaseinfo>1.2.0</releaseinfo> +<date>2013-08-23</date> +<releaseinfo>1.2.1 (&kde; 4.11)</releaseinfo> <!-- Abstract about this handbook --> diff --git a/doc/reference.docbook b/doc/reference.docbook index b4a0327..b35abf0 100644 --- a/doc/reference.docbook +++ b/doc/reference.docbook @@ -422,7 +422,7 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam <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. + horizontal axis. You can specify an other range in the edit-dialog for the function. If the plotting area contains the resulting point it is connected to the last drawn point by a line. </para> @@ -438,7 +438,7 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam While the mouse cursor is over the plotting area the cursor changes to a crosshair. 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 crosshair 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 crosshair will have the inverted color of the background. When moving the mouse or pressing the keys Left or Right the crosshair will follow the function and you see the current x- and y-value. If the crosshair 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. + 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 crosshair 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 crosshair will have the inverted color of the background. When moving the mouse or pressing the keys Left or Right the crosshair will follow the function and you see the current horizontal and vertical value. If the crosshair is close to vertical 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> For more advanced tracing, open up the configuration dialog, and select <guilabel>Draw tangent and normal when tracing</guilabel> from the <guilabel>General Settings</guilabel> page. This option will draw the tangent, normal and oscillating circle of the plot currently being traced. @@ -447,8 +447,8 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam </sect1> <sect1 id="coords-config"> - <title><guimenuitem>Coordinate System</guimenuitem> Configuration</title> - <para>To open this dialog select <menuchoice><guimenu>View</guimenu><guimenuitem>Coordinate System..</guimenuitem></menuchoice> from the menubar.</para> + <title>Coordinate System Configuration</title> + <para>To open this dialog select <menuchoice><guimenu>View</guimenu><guimenuitem>Coordinate System...</guimenuitem></menuchoice> from the menubar.</para> <screenshot> <screeninfo>Screenshot of the Coordinate System dialog</screeninfo> <mediaobject> @@ -462,14 +462,14 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam </screenshot> <sect2 id="axes-config"> - <title><guilabel>Axes</guilabel> Configuration</title> + <title>>Axes Configuration</title> <para> <variablelist> <varlistentry> - <term><guilabel>X-axis Range</guilabel></term> + <term><guilabel>Horizontal axis Range</guilabel></term> <listitem> - <para>Sets the range for the x-axis scale. + <para>Sets the range for the horizontal axis scale. Note that you can use the predefined functions and constants (see <xref linkend="func-predefined"/>) as the extremes of the range (⪚, set <guilabel>Min:</guilabel> to @@ -482,14 +482,14 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam </varlistentry> <varlistentry> - <term><guilabel>Y-axis Range</guilabel></term> + <term><guilabel>Vertical axis Range</guilabel></term> <listitem> - <para>Sets the range for the y-axis. See <quote>X-axis Range</quote> above.</para> + <para>Sets the range for the vertical axis. See <quote>Horizontal axis Range</quote> above.</para> </listitem> </varlistentry> <varlistentry> - <term><guilabel>X-axis Grid Spacing</guilabel></term> + <term><guilabel>Horizontal axis Grid Spacing</guilabel></term> <listitem> <para>This controls the spacing between grid lines in the horizontal direction. If <guilabel>Automatic</guilabel> is selected, then &kmplot; will try to find a grid line spacing of about two centimeters that is also numerically nice. @@ -499,10 +499,10 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam </varlistentry> <varlistentry> - <term><guilabel>Y-axis Grid Spacing</guilabel></term> + <term><guilabel>Vertical axis Grid Spacing</guilabel></term> <listitem> <para>This controls the spacing between grid lines in the vertical direction. - See <quote>X-axis Grid Spacing</quote> above. + See <quote>Horizontal axis Grid Spacing</quote> above. </para> </listitem> </varlistentry> @@ -514,8 +514,8 @@ for parametric functions but N and D[a,b] work for polar functions too. For exam </sect1> <sect1 id="constants-config"> - <title><guimenuitem>Constants</guimenuitem> Configuration</title> - <para>To open this dialog select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Constants..</guimenuitem></menuchoice> from the menubar.</para> + <title>Constants Configuration</title> + <para>To open this dialog select <menuchoice><guimenu>Edit</guimenu><guimenuitem>Constants...</guimenuitem></menuchoice> from the menubar.</para> <screenshot> <screeninfo>Screenshot of the Constants dialog</screeninfo> diff --git a/doc/settings-colors.png b/doc/settings-colors.png index 0d7751b..febff30 100644 Binary files a/doc/settings-colors.png and b/doc/settings-colors.png differ diff --git a/doc/settings-constants.png b/doc/settings-constants.png index a6bd9ed..c174098 100644 Binary files a/doc/settings-constants.png and b/doc/settings-constants.png differ diff --git a/doc/settings-coords.png b/doc/settings-coords.png index bbf5544..6c9aa85 100644 Binary files a/doc/settings-coords.png and b/doc/settings-coords.png differ diff --git a/doc/settings-diagram.png b/doc/settings-diagram.png index 8aac7c3..8132712 100644 Binary files a/doc/settings-diagram.png and b/doc/settings-diagram.png differ diff --git a/doc/settings-fonts.png b/doc/settings-fonts.png index 249d19c..9151a86 100644 Binary files a/doc/settings-fonts.png and b/doc/settings-fonts.png differ diff --git a/doc/settings-general.png b/doc/settings-general.png index 8ce54db..48bd7ab 100644 Binary files a/doc/settings-general.png and b/doc/settings-general.png differ diff --git a/doc/using.docbook b/doc/using.docbook index a6c8074..6ef0ea4 100644 --- a/doc/using.docbook +++ b/doc/using.docbook @@ -56,7 +56,7 @@ </listitem> <listitem><para> - <replaceable>x</replaceable> is the x-coordinate, to be used in the expression + <replaceable>x</replaceable> is the horizontal coordinate, to be used in the expression following the equals sign. It is a dummy variable, so you can use any variable name you like to achieve the same effect.</para> </listitem> @@ -101,7 +101,7 @@ <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 &thgr; the Greek letter theta). To enter + with the horizontal axis (usually represented by &thgr; the Greek letter theta). To enter functions in polar coordinates, click the <guilabel>Create</guilabel> button and select <guilabel>Polar Plot</guilabel> from the list. In the definition box, complete the function definition, including the name of the theta variable you want @@ -241,8 +241,8 @@ <term><menuchoice><guimenuitem>Plot Area...</guimenuitem> </menuchoice></term> <listitem> - <para>Select the minimum and maximum x-values for the graph in the new dialog that appears. - Calculates the integral and draws the area between the graph and the x-axis in the + <para>Select the minimum and maximum horizontal values for the graph in the new dialog that appears. + Calculates the integral and draws the area between the graph and the horizontal axis in the selected range in the color of the graph. </para> </listitem>
