[kde-doc-english] [kcalc] doc: doc update for 4.11, thanks to our famous yurchor for his help
Burkhard Lück
lueck at hube-lueck.de
Sat May 25 18:22:19 UTC 2013
Git commit c10b8fdc1acd0c48b884df9485c756a431712fb1 by Burkhard Lück.
Committed on 25/05/2013 at 20:22.
Pushed by lueck into branch 'master'.
doc update for 4.11, thanks to our famous yurchor for his help
M +9 -124 doc/commands.docbook
M +90 -19 doc/index.docbook
http://commits.kde.org/kcalc/c10b8fdc1acd0c48b884df9485c756a431712fb1
diff --git a/doc/commands.docbook b/doc/commands.docbook
index 5131ee6..f092816 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -2,99 +2,10 @@
<title>Command Reference</title>
-<sect1 id="filemenu">
-<title>The File Menu</title>
-<para>
-<variablelist>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>Q</keycap></keycombo>
-</shortcut>
-<guimenu>File</guimenu>
-<guimenuitem>Quit</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Quit</action> &kcalc;.</para></listitem>
-</varlistentry>
-</variablelist>
-</para>
-
-</sect1>
-
-<sect1 id="editmenu">
-<title>The Edit Menu</title>
-<para>
-<variablelist>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>Z</keycap></keycombo>
-</shortcut>
-<guimenu>Edit</guimenu>
-<guimenuitem>Undo</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Go back in the result
-stack.</action></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><action>Go forward in the result
-stack.</action>
-</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>X</keycap></keycombo>
-</shortcut>
-<guimenu>Edit</guimenu>
-<guimenuitem>Cut</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Delete the displayed result and copy it to the
-clipboard.</action></para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>C</keycap></keycombo>
-</shortcut>
-<guimenu>Edit</guimenu>
-<guimenuitem>Copy</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Copy the displayed result to the
-clipboard.</action></para></listitem>
-</varlistentry>
+<sect1 id="menus">
+<title>Menu Items</title>
-<varlistentry>
-<term><menuchoice>
-<shortcut>
-<keycombo action="simul">&Ctrl;<keycap>V</keycap></keycombo>
-</shortcut>
-<guimenu>Edit</guimenu>
-<guimenuitem>Paste</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Insert the cut or copied result in the
-display.</action></para></listitem>
-</varlistentry>
-
-</variablelist>
-</para>
-</sect1>
-
-<sect1 id="viewmenu">
-<title>The Constants Menu</title>
-<para>
+ <para>A brief overview of some special menu items in &kcalc;:</para>
<variablelist>
<varlistentry>
@@ -145,14 +56,6 @@ Constant, Stefan-Boltzmann Constant or Avogadro's Number.</action>
</para></listitem>
</varlistentry>
-</variablelist>
-</para>
-</sect1>
-
-<sect1 id="settingsmenu">
-<title>The Settings Menu</title>
-<para><variablelist>
-
<varlistentry>
<term><menuchoice>
<guimenu>Settings</guimenu>
@@ -211,33 +114,15 @@ buttons</link> and allows changing the numeral system.</action>
</para></listitem>
</varlistentry>
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure Shortcuts...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Configure the keyboard shortcuts used by &kcalc;.
-</action>
-</para></listitem>
-</varlistentry>
-
-<varlistentry>
-<term><menuchoice>
-<guimenu>Settings</guimenu>
-<guimenuitem>Configure &kcalc;...</guimenuitem>
-</menuchoice></term>
-<listitem><para><action>Display</action> the &kcalc; settings dialog.
-</para></listitem>
-</varlistentry>
-
</variablelist>
-</para>
-</sect1>
-<sect1 id="helpmenu">
-<title>The Help Menu</title>
+<para>
+Additionally &kcalc; has the common &kde; <guimenu>File</guimenu>, <guimenu>Edit</guimenu>,
+<guimenu>Settings</guimenu> and <guimenu>Help</guimenu> menu items, for more information
+read the sections about the <ulink url="help:/fundamentals/ui.html#menus">Menus</ulink>
+in the &kde; Fundamentals.
-&help.menu.documentation;
+</para>
</sect1>
diff --git a/doc/index.docbook b/doc/index.docbook
index 4a5b092..27a0193 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -37,8 +37,8 @@
<legalnotice>&FDLNotice;</legalnotice>
-<date>2010-05-13</date>
-<releaseinfo>2.7 (&kde; 4.5)</releaseinfo>
+<date>2013-05-24</date>
+<releaseinfo>2.13 (&kde; 4.11)</releaseinfo>
<abstract><para>&kcalc; is a scientific calculator for &kde;</para></abstract>
@@ -52,7 +52,7 @@
<chapter id="introduction">
<title>Introduction</title>
-<para>This document describes &kcalc; version 2.7.</para>
+<para>This document describes &kcalc; version 2.13.</para>
<para>&kcalc; offers many more mathematical functions than meet the eye
on a first glance. Please study the section on keyboard accelerators and
@@ -167,8 +167,8 @@ slightly change as &kcalc; evolves.</para>
<varlistentry>
<term>Button Layout</term>
<listitem>
-<para>To give easy access to all the functions in &kcalc;, many keys have a second layout. Click
-on <guibutton>&Shift;</guibutton> or press the shortcut <keycap>I</keycap> to make
+<para>To give easy access to all the functions in advanced modes in &kcalc;, many keys have a second layout. Click
+on <guibutton>&Shift;</guibutton> or press the shortcut <keycombo action="simul">&Ctrl;<keycap>2</keycap></keycombo> to make
the second layout of the buttons visible.</para>
</listitem>
</varlistentry>
@@ -205,32 +205,78 @@ sinh</entry></row>
<row><entry><guibutton>Sin</guibutton></entry>
<entry>Compute the sine</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Sin</guibutton></entry>
+<row><entry>&Shift; <guibutton>Sin</guibutton> or <guibutton>Asin</guibutton></entry>
<entry>Compute the inverse sine</entry></row>
<row><entry><guibutton>Cos</guibutton></entry>
<entry>Compute the cosine</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Cos</guibutton></entry>
+<row><entry>&Shift; <guibutton>Cos</guibutton> or <guibutton>Acos</guibutton></entry>
<entry>Compute the inverse cosine</entry></row>
<row><entry><guibutton>Tan</guibutton></entry>
<entry>Compute the tangent</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Tan</guibutton></entry>
+<row><entry>&Shift; <guibutton>Tan</guibutton> or <guibutton>Atan</guibutton></entry>
<entry>Compute the inverse tangent</entry></row>
<row><entry><guibutton>Log</guibutton></entry>
<entry>Compute the Log base 10</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Log</guibutton></entry>
+<row><entry>&Shift; <guibutton>Log</guibutton> or 10<superscript>x</superscript></entry>
<entry>Compute 10 to the power of x</entry></row>
<row><entry><guibutton>Ln</guibutton></entry>
<entry>Compute the natural logarithm. That is the log to base e</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Ln</guibutton></entry>
-<entry>Compute e to the power of x</entry></row>
+<row><entry>&Shift; <guibutton>Ln</guibutton> or e<superscript>x</superscript></entry>
+<entry>Compute e (the base of the natural logarithm) to the power of x</entry></row>
+
+</tbody></tgroup></informaltable>
+
+<para>The second column has buttons for algebraic functions:</para>
+
+<informaltable><tgroup cols="2">
+<thead>
+<row><entry>Buttons</entry>
+<entry>Function</entry></row>
+</thead>
+<tbody>
+<row><entry><guibutton>Mod</guibutton></entry>
+<entry>Compute the remainder in Euclidean division</entry></row>
+
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>Mod</guibutton> or <guibutton>IntDiv</guibutton></entry>
+<entry>Integer division (integer part of the quotient)</entry></row>
+
+<row><entry><guibutton>1/x</guibutton></entry>
+<entry>Compute the reciprocal for a number</entry></row>
+
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>1/x</guibutton> or <guibutton>nCm</guibutton></entry>
+<entry>Compute the number of distinct second-operand-element subsets of it that can be formed for any set containing first operand elements (binomial coefficient)</entry></row>
+
+<row><entry><guibutton>x!</guibutton></entry>
+<entry>Compute the product of all positive integers less than or equal to the current integer operand (factorial)</entry></row>
+
+<row><entry><guibutton>x²</guibutton></entry>
+<entry>Compute the square of x</entry></row>
+
+ <row><entry><guibutton>&Shift;</guibutton> <guibutton>x²</guibutton> or <guibutton>√x</guibutton></entry>
+<entry>Compute the square root of x</entry></row>
+
+<row><entry><guibutton>xʸ</guibutton></entry>
+<entry>x power y</entry></row>
+
+<row><entry>&Shift; x<superscript>y</superscript> or x<superscript>1/y</superscript></entry>
+<entry>x power 1/y</entry></row>
+
+<row><entry><guibutton>x³</guibutton></entry>
+<entry>Computes the third (cubic) power of x</entry></row>
+
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>x³</guibutton> or <guibutton>∛x</guibutton></entry>
+<entry>Computes the third (cubic) root of x</entry></row>
+
+<row><entry><guibutton>x·10ʸ</guibutton></entry>
+<entry>Computes the product of the first operand and decimal exponent of the second operand</entry></row>
</tbody></tgroup></informaltable>
@@ -260,19 +306,19 @@ functions:</para>
<row><entry><guibutton>N</guibutton></entry>
<entry>Recall the number of data items entered</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>N</guibutton></entry>
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>N</guibutton> or <guibutton>&Sgr;x</guibutton></entry>
<entry>Display the sum of all data items entered</entry></row>
<row><entry><guibutton>Mea</guibutton></entry>
<entry>Display the mean of the data items entered</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Mea</guibutton></entry>
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>Mea</guibutton> or <guibutton>&Sgr;x²</guibutton></entry>
<entry>Display the sum of the square of all data items entered</entry></row>
-<row><entry><guibutton>Std</guibutton></entry>
+<row><entry>&sgr;<subscript>N</subscript></entry>
<entry>Display the standard deviation (n)</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Std</guibutton></entry>
+<row><entry><guibutton>&Shift;</guibutton> &sgr;<subscript>N</subscript> or &sgr;<subscript>N-1</subscript> </entry>
<entry>Display the population standard deviation (n-1)</entry></row>
<row><entry><guibutton>Med</guibutton></entry>
@@ -281,7 +327,7 @@ functions:</para>
<row><entry><guibutton>Dat</guibutton></entry>
<entry>Enter a data item</entry></row>
-<row><entry><guibutton>&Shift;</guibutton> <guibutton>Dat</guibutton></entry>
+<row><entry><guibutton>&Shift;</guibutton> <guibutton>Dat</guibutton> or <guibutton>CDat</guibutton></entry>
<entry>Clear last data item entered</entry></row>
<row><entry><guibutton>CSt</guibutton></entry>
@@ -289,6 +335,8 @@ functions:</para>
</tbody></tgroup></informaltable>
+<para>The next two columns hold the buttons with trigonometric and algebraic functions described in the
+<link linkend="science-mode">Science</link> mode section.</para>
</sect1>
@@ -321,12 +369,25 @@ for numbers larger than 9. If you would like to see this number in binary, just
<row><entry><guibutton>XOR</guibutton></entry>
<entry>Two numbers are logically exclusive ored</entry></row>
-</tbody></tgroup></informaltable>
+<row><entry><guibutton>Lsh</guibutton></entry>
+<entry>Left shift the value</entry></row>
+
+<row><entry><guibutton>Rsh</guibutton></entry>
+<entry>Right shift the value</entry></row>
+
+<row><entry><guibutton>Cmp</guibutton></entry>
+<entry>Perform a 1's complement</entry></row>
+</tbody></tgroup></informaltable>
</para>
-</sect1>
+<para>The second columns holds the buttons with algebraic functions described in the
+<link linkend="science-mode">Science</link> mode section.</para>
+<para>The third column with the buttons <guibutton>A</guibutton> to <guibutton>F</guibutton> is
+enabled only in <guilabel>Hex</guilabel> mode.
+</para>
+</sect1>
<!-- end of MODES -->
@@ -387,6 +448,8 @@ item <guilabel>Constants Buttons</guilabel> in the menu
<guimenu>Settings</guimenu> of the menu bar. They are available in <guilabel>Science mode</guilabel>
and <guilabel>Statistics mode</guilabel></para>
+<para>To see the value stored in each constant hoover the button with the mouse ponter.</para>
+
<para>To store the number shown in the &kcalc; display in one of the
six constants, first press <guibutton>&Shift;</guibutton> followed
by the desired button key <guibutton>C1</guibutton> up to
@@ -480,6 +543,10 @@ you want arcsin type <userinput>Ctrl-2 s </userinput></entry></row>
<entry><guibutton>x!</guibutton></entry>
<entry>Factorial</entry></row>
+<row><entry><keysym>E</keysym></entry>
+<entry>x10<superscript>y</superscript></entry>
+<entry>Exponent</entry></row>
+
<row><entry><keysym><</keysym></entry>
<entry><guibutton>Lsh</guibutton></entry>
<entry>Left shift</entry></row>
@@ -520,6 +587,10 @@ you want arcsin type <userinput>Ctrl-2 s </userinput></entry></row>
<entry><guibutton>=</guibutton></entry>
<entry></entry></row>
+<row><entry>&Backspace;</entry>
+<entry><guibutton><=</guibutton></entry>
+<entry>Delete last number</entry></row>
+
<row><entry><keycap>PgUp</keycap></entry>
<entry><guibutton>C</guibutton></entry>
<entry>Clear</entry></row>
@@ -544,7 +615,7 @@ you want arcsin type <userinput>Ctrl-2 s </userinput></entry></row>
<entry><guibutton>AC</guibutton></entry>
<entry>Clear all</entry></row>
-<row><entry>&Shift;+<keycap>:</keycap></entry>
+<row><entry><keycap>:</keycap></entry>
<entry><guibutton>Mod</guibutton></entry>
<entry>remainder of dividing</entry></row>
More information about the kde-doc-english
mailing list