[gcalctool] Wrote new help document in Mallard format
- From: Robert Ancell <rancell src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gcalctool] Wrote new help document in Mallard format
- Date: Thu, 18 Feb 2010 04:31:34 +0000 (UTC)
commit 5d9395d0236ebb5a02c34fe24d20557dbd0d7486
Author: Robert Ancell <robert ancell gmail com>
Date: Thu Feb 18 15:24:37 2010 +1100
Wrote new help document in Mallard format
ChangeLog | 4 +
help/C/absolute.page | 22 +
help/C/base.page | 35 +
help/C/boolean.page | 31 +
help/C/complex.page | 14 +
help/C/conv-base.page | 14 +
help/C/conv-character.page | 19 +
help/C/conv-currency.page | 27 +
help/C/conv-length.page | 30 +
help/C/conv-time.page | 24 +
help/C/conv-weight.page | 24 +
help/C/equation.page | 46 +
help/C/factorial.page | 20 +
help/C/factorize.page | 15 +
help/C/figures/gcalctool_advanced_window.png | Bin 7677 -> 0 bytes
help/C/figures/gcalctool_basic_window.png | Bin 13260 -> 0 bytes
help/C/figures/gcalctool_financial_window.png | Bin 4515 -> 0 bytes
help/C/figures/gcalctool_menu_symbol.png | Bin 246 -> 0 bytes
help/C/figures/gcalctool_programming_window.png | Bin 12077 -> 0 bytes
help/C/figures/gcalctool_scientific_window.png | Bin 11563 -> 0 bytes
help/C/financial.page | 60 +
help/C/functions.page | 91 +
help/C/gcalctool.xml | 2802 -----------
help/C/index.page | 34 +
help/C/keyboard.page | 42 +
help/C/l10n.txt | 130 -
help/C/legal.xml | 85 +-
help/C/logarithm.page | 43 +
help/C/modulus.page | 19 +
help/C/mouse.page | 37 +
help/C/number-display.page | 43 +
help/C/percentage.page | 32 +
help/C/power.page | 55 +
help/C/scientific.page | 40 +
help/C/superscript.page | 33 +
help/C/trigonometry.page | 46 +
help/C/variables.page | 56 +
help/Makefile.am | 42 +-
help/bg/.gitignore | 2 -
help/bg/bg.po | 4423 -----------------
help/bg/figures/gcalctool_advanced_window.png | Bin 30171 -> 0 bytes
help/bg/figures/gcalctool_basic_window.png | Bin 21246 -> 0 bytes
help/bg/figures/gcalctool_financial_window.png | Bin 7053 -> 0 bytes
help/bg/figures/gcalctool_menu_symbol.png | Bin 273 -> 0 bytes
help/bg/figures/gcalctool_scientific_window.png | Bin 55347 -> 0 bytes
help/ca/.gitignore | 2 -
help/ca/ca.po | 5134 --------------------
help/ca/figures/gcalctool_advanced_window.png | Bin 7854 -> 0 bytes
help/ca/figures/gcalctool_basic_window.png | Bin 13977 -> 0 bytes
help/ca/figures/gcalctool_financial_window.png | Bin 4757 -> 0 bytes
help/ca/figures/gcalctool_menu_symbol.png | Bin 185 -> 0 bytes
help/ca/figures/gcalctool_scientific_window.png | Bin 19773 -> 0 bytes
help/cs/.gitignore | 2 -
help/cs/cs.po | 5198 --------------------
help/cs/figures/gcalctool_basic_window.png | Bin 15442 -> 0 bytes
help/cs/figures/gcalctool_scientific_window.png | Bin 10808 -> 0 bytes
help/de/.gitignore | 2 -
help/de/de.po | 5397 ---------------------
help/de/figures/gcalctool_advanced_window.png | Bin 22219 -> 0 bytes
help/de/figures/gcalctool_basic_window.png | Bin 14940 -> 0 bytes
help/de/figures/gcalctool_financial_window.png | Bin 27508 -> 0 bytes
help/de/figures/gcalctool_programming_window.png | Bin 81413 -> 0 bytes
help/de/figures/gcalctool_scientific_window.png | Bin 62464 -> 0 bytes
help/el/.gitignore | 2 -
help/el/el.po | 5364 ---------------------
help/es/.gitignore | 2 -
help/es/es.po | 5480 ----------------------
help/es/figures/gcalctool_advanced_window.png | Bin 6698 -> 0 bytes
help/es/figures/gcalctool_basic_window.png | Bin 11536 -> 0 bytes
help/es/figures/gcalctool_financial_window.png | Bin 4522 -> 0 bytes
help/es/figures/gcalctool_scientific_window.png | Bin 20066 -> 0 bytes
help/eu/.gitignore | 2 -
help/eu/eu.po | 3352 -------------
help/eu/figures/gcalctool_basic_window.png | Bin 15399 -> 0 bytes
help/eu/figures/gcalctool_scientific_window.png | Bin 19460 -> 0 bytes
help/fr/.gitignore | 2 -
help/fr/figures/gcalctool_advanced_window.png | Bin 5685 -> 0 bytes
help/fr/figures/gcalctool_basic_window.png | Bin 14939 -> 0 bytes
help/fr/figures/gcalctool_financial_window.png | Bin 6359 -> 0 bytes
help/fr/figures/gcalctool_menu_symbol.png | Bin 203 -> 0 bytes
help/fr/figures/gcalctool_programming_window.png | Bin 16121 -> 0 bytes
help/fr/figures/gcalctool_scientific_window.png | Bin 9926 -> 0 bytes
help/fr/fr.po | 5071 --------------------
help/gcalctool.omf.in | 11 -
help/it/.gitignore | 2 -
help/it/gcalctool.old.xml | 2564 ----------
help/it/it.po | 3564 --------------
help/ja/.gitignore | 2 -
help/ja/ja.po | 4028 ----------------
help/ko/.gitignore | 2 -
help/ko/figures/gcalctool_basic_window.png | Bin 15671 -> 0 bytes
help/ko/figures/gcalctool_scientific_window.png | Bin 25646 -> 0 bytes
help/ko/ko.po | 4744 -------------------
help/oc/.gitignore | 2 -
help/oc/oc.po | 4370 -----------------
help/pt_BR/.gitignore | 2 -
help/pt_BR/pt_BR.po | 4643 ------------------
help/ru/.gitignore | 2 -
help/ru/figures/gcalctool_advanced_window.png | Bin 6749 -> 0 bytes
help/ru/figures/gcalctool_basic_window.png | Bin 13123 -> 0 bytes
help/ru/figures/gcalctool_financial_window.png | Bin 3829 -> 0 bytes
help/ru/figures/gcalctool_scientific_window.png | Bin 16827 -> 0 bytes
help/ru/ru.po | 4584 ------------------
help/sv/.gitignore | 2 -
help/sv/figures/gcalctool_basic_window.png | Bin 14146 -> 0 bytes
help/sv/figures/gcalctool_financial_window.png | Bin 7204 -> 0 bytes
help/sv/figures/gcalctool_scientific_window.png | Bin 23448 -> 0 bytes
help/sv/sv.po | 4088 ----------------
help/zh_CN/.gitignore | 2 -
help/zh_CN/zh_CN.po | 4031 ----------------
help/zh_HK/.gitignore | 2 -
help/zh_HK/zh_HK.po | 3956 ----------------
help/zh_TW/.gitignore | 2 -
help/zh_TW/zh_TW.po | 3956 ----------------
114 files changed, 997 insertions(+), 87012 deletions(-)
---
diff --git a/ChangeLog b/ChangeLog
index b2d5221..554e321 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -7,6 +7,10 @@
gcalctool change history.
=========================
+2010-02-18 Robert Ancell <robert ancell gmail com>
+
+ * Wrote new help document in Mallard format
+
2010-02-11 Robert Ancell <robert ancell gmail com>
* Switch recall and store button labels
diff --git a/help/C/absolute.page b/help/C/absolute.page
new file mode 100644
index 0000000..d954b7e
--- /dev/null
+++ b/help/C/absolute.page
@@ -0,0 +1,22 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="absolute">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Absolute Values</title>
+
+ <p>
+ Absolute values are calculated using the | symbol or abs <link xref="function">function</link>.
+ </p>
+ <example>
+ <p>
+ |â??1|
+ </p>
+ <p>
+ abs (â??1)
+ </p>
+ </example>
+</page>
diff --git a/help/C/base.page b/help/C/base.page
new file mode 100644
index 0000000..65c193b
--- /dev/null
+++ b/help/C/base.page
@@ -0,0 +1,35 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="base">
+
+ <info>
+ <link type="guide" xref="index#number"/>
+ </info>
+
+ <title>Number Bases</title>
+
+ <p>
+ To enter numbers in a particular number base use <link xref="superscript">subscript numbers</link>.
+ The following numbers are equivalent.
+ </p>
+ <example>
+ <p>
+ 1001011â??
+ </p>
+ <p>
+ 113â??
+ </p>
+ <p>
+ 75
+ </p>
+ <p>
+ 4Bâ??â??
+ </p>
+ </example>
+ <p>
+ When in <link xref="mouse">programming mode</link> there are buttons for binary, octal and hexadecimal.
+ </p>
+ <p>
+ To set the base that results are shown in change the <link xref="number-display">result format</link>.
+ </p>
+</page>
diff --git a/help/C/boolean.page b/help/C/boolean.page
new file mode 100644
index 0000000..263a121
--- /dev/null
+++ b/help/C/boolean.page
@@ -0,0 +1,31 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="boolean">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Boolean Algebra</title>
+
+ <p>
+ Boolean algebra can be calculated using the and, or and xor operators.
+ </p>
+ <example>
+ <p>
+ 010011â?? and 110101â??
+ </p>
+ </example>
+ <p>
+ Buttons for these symbols are available in <link xref="mouse">programming mode</link>.
+ </p>
+ <p>
+ The not <link xref="function">function</link> inverts the bits in a number.
+ The word size is set from the <guiseq><gui>Calculator</gui><gui>Preferences</gui></guiseq> menu.
+ </p>
+ <example>
+ <p>
+ not 010011â??
+ </p>
+ </example>
+</page>
diff --git a/help/C/complex.page b/help/C/complex.page
new file mode 100644
index 0000000..aaec96f
--- /dev/null
+++ b/help/C/complex.page
@@ -0,0 +1,14 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="complex">
+
+ <info>
+ <link type="guide" xref="index#number"/>
+ </info>
+
+ <title>Complex Numbers</title>
+
+ <p>
+ Complex numbers are not supported in <app>GCalctool</app>.
+ </p>
+</page>
diff --git a/help/C/conv-base.page b/help/C/conv-base.page
new file mode 100644
index 0000000..1917d42
--- /dev/null
+++ b/help/C/conv-base.page
@@ -0,0 +1,14 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-base">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Number Bases</title>
+
+ <p>
+ To convert between number bases enter a number (or solve an equation) and change the <link xref="number-display">result format</link> from the <guiseq><gui>Calculator</gui><gui>Preferences</gui></guiseq> menu.
+ </p>
+</page>
diff --git a/help/C/conv-character.page b/help/C/conv-character.page
new file mode 100644
index 0000000..790b137
--- /dev/null
+++ b/help/C/conv-character.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-character">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Character Codes</title>
+
+ <p>
+ When in <link xref="mouse">programming mode</link> the <gui>á</gui> button opens a dialog to convert characters to character codes.
+ </p>
+ <note>
+ <p>
+ Characters cannot be converted using the keyboard.
+ </p>
+ </note>
+</page>
diff --git a/help/C/conv-currency.page b/help/C/conv-currency.page
new file mode 100644
index 0000000..d70e149
--- /dev/null
+++ b/help/C/conv-currency.page
@@ -0,0 +1,27 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-currency">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Currency</title>
+
+ <p>
+ To convert currencies press the <gui>¤$�</gui> button in <link xref="superscript">financial mode</link>.
+ </p>
+ <p>
+ You can also convert currencies using the keyboard and the <em>in</em> operator.
+ </p>
+ <example>
+ <p>
+ 13.65 USD in GBP
+ </p>
+ </example>
+ <note>
+ <p>
+ Currency information is approximate and should not be used for making financial decisions.
+ </p>
+ </note>
+</page>
diff --git a/help/C/conv-length.page b/help/C/conv-length.page
new file mode 100644
index 0000000..d51380b
--- /dev/null
+++ b/help/C/conv-length.page
@@ -0,0 +1,30 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-length">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Length/Area/Volume</title>
+
+ <p>
+ To convert between length, area and volume units use the <em>in</em> operator.
+ </p>
+ <example>
+ <p>
+ 6 meters in inches
+ </p>
+ <p>
+ 1 acre in cm²
+ </p>
+ <p>
+ 1 pint in mL
+ </p>
+ </example>
+ <note>
+ <p>
+ Length/Area/Volume conversions must be performed using the keyboard.
+ </p>
+ </note>
+</page>
diff --git a/help/C/conv-time.page b/help/C/conv-time.page
new file mode 100644
index 0000000..3779c96
--- /dev/null
+++ b/help/C/conv-time.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-time">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Time</title>
+
+ <p>
+ To convert between time use the <em>in</em> operator.
+ </p>
+ <example>
+ <p>
+ 3 years in hours
+ </p>
+ </example>
+ <note>
+ <p>
+ Time conversions must be performed using the keyboard.
+ </p>
+ </note>
+</page>
diff --git a/help/C/conv-weight.page b/help/C/conv-weight.page
new file mode 100644
index 0000000..fa5e0d4
--- /dev/null
+++ b/help/C/conv-weight.page
@@ -0,0 +1,24 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="conv-weight">
+
+ <info>
+ <link type="guide" xref="index#conversion"/>
+ </info>
+
+ <title>Mass</title>
+
+ <p>
+ To convert between mass use the <em>in</em> operator.
+ </p>
+ <example>
+ <p>
+ 1kg in pounds
+ </p>
+ </example>
+ <note>
+ <p>
+ Mass conversions must be performed using the keyboard.
+ </p>
+ </note>
+</page>
diff --git a/help/C/equation.page b/help/C/equation.page
new file mode 100644
index 0000000..a0d8292
--- /dev/null
+++ b/help/C/equation.page
@@ -0,0 +1,46 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="equation">
+
+ <info>
+ <!-- Place this at the start of the section -->
+ <title type="sort">0</title>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Basic Equations</title>
+
+ <p>
+ Equations are entered in standard mathematical form.
+ For example to add 7 and 2 enter the following:
+ </p>
+ <example>
+ <p>
+ 7+2
+ </p>
+ </example>
+ <p>
+ To solve, press the <gui>=</gui> button with your mouse or the <key>Enter</key> key on your keyboard.
+ </p>
+ <p>
+ Calculations are performed in mathematical order - multiplication and division are performed before addition and subtraction.
+ The following equation solves to 1 (3Ã?2 = 6, 9â??7 = 1).
+ </p>
+ <example>
+ <p>
+ 7â??3Ã?2
+ </p>
+ </example>
+ <p>
+ To change the order of calculation use parenthesis.
+ The following equation solves to 8 (7â??3 = 4, 4Ã?2 = 8).
+ </p>
+ <example>
+ <p>
+ (7â??3)Ã?2
+ </p>
+ </example>
+ <p>
+ To clear the display press the <gui>Clr</gui> button or <key>Escape</key>.
+ </p>
+</page>
diff --git a/help/C/factorial.page b/help/C/factorial.page
new file mode 100644
index 0000000..ec90906
--- /dev/null
+++ b/help/C/factorial.page
@@ -0,0 +1,20 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="factorial">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Factorials</title>
+
+ <p>
+ Factorials are entered using the ! symbol.
+ To calculate the factorial of 6 enter the following.
+ </p>
+ <example>
+ <p>
+ 6!
+ </p>
+ </example>
+</page>
diff --git a/help/C/factorize.page b/help/C/factorize.page
new file mode 100644
index 0000000..4094d60
--- /dev/null
+++ b/help/C/factorize.page
@@ -0,0 +1,15 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="factorize">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Factorization</title>
+
+ <p>
+ You can factorize the number currently displayed by pressing the <gui>fact</gui> button.
+ This button is visible in <link xref="mouse">programming mode</link>.
+ </p>
+</page>
diff --git a/help/C/financial.page b/help/C/financial.page
new file mode 100644
index 0000000..edc0d75
--- /dev/null
+++ b/help/C/financial.page
@@ -0,0 +1,60 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="financial">
+
+ <info>
+ <link type="guide" xref="index#financial"/>
+ </info>
+
+ <title>Financial Functions</title>
+ <p>
+ When in <link xref="superscript">financial mode</link> the following buttons are available.
+ </p>
+ <table>
+ <tr>
+ <td><p>Ctrm</p></td>
+ <td><p>Calculate the number of compounding periods necessary to increase an investment of present value to a future value, at a fixed interest rate per compounding period.</p></td>
+ </tr>
+ <tr>
+ <td><p>Ddb</p></td>
+ <td><p>Calculate the depreciation allowance on an asset for a specified period of time, using the double-declining balance method.</p></td>
+ </tr>
+ <tr>
+ <td><p>Fv</p></td>
+ <td><p>Calculate the future value of an investment based on a series of equal payments at a periodic interest rate over the number of payment periods in the term.</p></td>
+ </tr>
+ <tr>
+ <td><p>Gpm</p></td>
+ <td><p>Calculate the resale price of a product, based on the product cost and the wanted gross profit margin.</p></td>
+ </tr>
+ <tr>
+ <td><p>Pmt</p></td>
+ <td><p>Calculate the amount of the periodic payment of a loan, where payments are made at the end of each payment period.</p></td>
+ </tr>
+ <tr>
+ <td><p>Pv</p></td>
+ <td><p>Calculate the present value of an investment based on a series of equal payments discounted at a periodic interest rate over the number of payment periods in the term.</p></td>
+ </tr>
+ <tr>
+ <td><p>Rate</p></td>
+ <td><p>Calculate the periodic interest necessary to increase an investment to a future value, over the number of compounding periods.</p></td>
+ </tr>
+ <tr>
+ <td><p>Sln</p></td>
+ <td><p>Calculate the straight-line depreciation of an asset for one period. The straight-line method of depreciation divides the depreciable cost evenly over the useful life of an asset. The useful life is the number of periods, typically years, over which an asset is depreciated.</p></td>
+ </tr>
+ <tr>
+ <td><p>Syd</p></td>
+ <td><p>Calculate the depreciation allowance on an asset for a specified period of time, using the Sum-of-the-Years'-Digits method. This method of depreciation accelerates the rate of depreciation, so that more depreciation expense occurs in earlier periods than in later ones. The useful life is the number of periods, typically years, over which an asset is depreciated.</p></td>
+ </tr>
+ <tr>
+ <td><p>Term</p></td>
+ <td><p>Calculate the number of payment periods that are necessary during the term of an ordinary annuity, to accumulate a future value, at a periodic interest rate.</p></td>
+ </tr>
+ </table>
+ <note>
+ <p>
+ Financial functions cannot be performed using the keyboard.
+ </p>
+ </note>
+</page>
diff --git a/help/C/functions.page b/help/C/functions.page
new file mode 100644
index 0000000..426d523
--- /dev/null
+++ b/help/C/functions.page
@@ -0,0 +1,91 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="function">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Functions</title>
+
+ <p>
+ Functions can be used by inserting the name of the function followed by the function argument.
+ If the argument is not a number or <link xref="variable">variable</link> then use parenthesis around the argument.
+ </p>
+ <example>
+ <p>
+ sin 30
+ </p>
+ <p>
+ abs (5â??9)
+ </p>
+ </example>
+ <p>
+ The following functions are defined.
+ </p>
+ <table>
+ <tr>
+ <td><p>abs</p></td>
+ <td><p><link xref="absolute">Absolute Value</link></p></td>
+ </tr>
+ <tr>
+ <td><p>cos</p></td>
+ <td><p><link xref="trigonometry">Cosine</link></p></td>
+ </tr>
+ <tr>
+ <td><p>cosh</p></td>
+ <td><p><link xref="trigonometry">Hyperbolic Cosine</link></p></td>
+ </tr>
+ <tr>
+ <td><p>frac</p></td>
+ <td><p>Fractional Component</p></td>
+ </tr>
+ <tr>
+ <td><p>int</p></td>
+ <td><p>Integer Component</p></td>
+ </tr>
+ <tr>
+ <td><p>ln</p></td>
+ <td><p><link xref="logarithm">Natural Logarithm</link></p></td>
+ </tr>
+ <tr>
+ <td><p>log</p></td>
+ <td><p><link xref="logarithm">Logarithm</link></p></td>
+ </tr>
+ <tr>
+ <td><p>not</p></td>
+ <td><p><link xref="boolean">Boolean NOT</link></p></td>
+ </tr>
+ <tr>
+ <td><p>ones</p></td>
+ <td><p>Ones complement</p></td>
+ </tr>
+ <tr>
+ <td><p>sin</p></td>
+ <td><p><link xref="trigonometry">Sine</link></p></td>
+ </tr>
+ <tr>
+ <td><p>sinh</p></td>
+ <td><p><link xref="trigonometry">Hyperbolic Sine</link></p></td>
+ </tr>
+ <tr>
+ <td><p>sqrt</p></td>
+ <td><p><link xref="power">Square Root</link></p></td>
+ </tr>
+ <tr>
+ <td><p>tan</p></td>
+ <td><p><link xref="trigonometry">Tangent</link></p></td>
+ </tr>
+ <tr>
+ <td><p>tanh</p></td>
+ <td><p><link xref="trigonometry">Hyperbolic Tangent</link></p></td>
+ </tr>
+ <tr>
+ <td><p>twos</p></td>
+ <td><p>Twos complement</p></td>
+ </tr>
+ </table>
+ <p>
+ <app>GCalctool</app> does not support user-defined functions.
+ </p>
+</page>
diff --git a/help/C/index.page b/help/C/index.page
new file mode 100644
index 0000000..0af5fd7
--- /dev/null
+++ b/help/C/index.page
@@ -0,0 +1,34 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="index">
+
+ <info>
+ <credit type="author">
+ <name>Robert Ancell</name>
+ <email>robert ancell gmail com</email>
+ </credit>
+ <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude"; />
+ </info>
+
+ <title>GCalctool Help</title>
+
+ <section id="ui" style="2column">
+ <title>User Interface</title>
+ </section>
+
+ <section id="equation" style="2column">
+ <title>Equations</title>
+ </section>
+
+ <section id="number" style="2column">
+ <title>Numbers</title>
+ </section>
+
+ <section id="conversion" style="2column">
+ <title>Conversions</title>
+ </section>
+
+ <section id="financial" style="2column">
+ <title>Financial Calculations</title>
+ </section>
+</page>
diff --git a/help/C/keyboard.page b/help/C/keyboard.page
new file mode 100644
index 0000000..a522201
--- /dev/null
+++ b/help/C/keyboard.page
@@ -0,0 +1,42 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="keyboard">
+
+ <info>
+ <link type="guide" xref="index#ui"/>
+ </info>
+
+ <title>Using the Keyboard</title>
+
+ <p>
+ All mathematical equations can be entered using the keyboard.
+ </p>
+ <p>
+ The following key combinations can be used to enter keys that may not be available on your keyboard.
+ </p>
+ <table>
+ <tr>
+ <td><p>Ã?</p></td>
+ <td><p><key>*</key></p></td>
+ </tr>
+ <tr>
+ <td><p>÷</p></td>
+ <td><p><key>/</key></p></td>
+ </tr>
+ <tr>
+ <td><p>^</p></td>
+ <td><p><key>*</key> twice</p></td>
+ </tr>
+ <tr>
+ <td><p>â??</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>R</key></keyseq></p></td>
+ </tr>
+ <tr>
+ <td><p>Ï?</p></td>
+ <td><p><keyseq><key>Ctrl</key><key>P</key></keyseq></p></td>
+ </tr>
+ </table>
+ <p>
+ To enter <link xref="superscript">superscript numbers</link> use <keyseq><key>Ctrl</key>number</keyseq>, for subscript use <keyseq><key>Alt</key>number</keyseq>.
+ </p>
+</page>
diff --git a/help/C/legal.xml b/help/C/legal.xml
index ac97e1d..86d6173 100644
--- a/help/C/legal.xml
+++ b/help/C/legal.xml
@@ -1,76 +1,9 @@
- <legalnotice id="legalnotice">
- <para>
- Permission is granted to copy, distribute and/or modify this
- document under the terms of the GNU Free Documentation
- License (GFDL), Version 1.1 or any later version published
- by the Free Software Foundation with no Invariant Sections,
- no Front-Cover Texts, and no Back-Cover Texts. You can find
- a copy of the GFDL at this <ulink type="help"
- url="ghelp:fdl">link</ulink> or in the file COPYING-DOCS
- distributed with this manual.
- </para>
- <para> This manual is part of a collection of GNOME manuals
- distributed under the GFDL. If you want to distribute this
- manual separately from the collection, you can do so by
- adding a copy of the license to the manual, as described in
- section 6 of the license.
- </para>
-
- <para>
- Many of the names used by companies to distinguish their
- products and services are claimed as trademarks. Where those
- names appear in any GNOME documentation, and the members of
- the GNOME Documentation Project are made aware of those
- trademarks, then the names are in capital letters or initial
- capital letters.
- </para>
-
- <para>
- DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT ARE PROVIDED
- UNDER THE TERMS OF THE GNU FREE DOCUMENTATION LICENSE
- WITH THE FURTHER UNDERSTANDING THAT:
-
- <orderedlist>
- <listitem>
- <para>DOCUMENT IS PROVIDED ON AN "AS IS" BASIS,
- WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR
- IMPLIED, INCLUDING, WITHOUT LIMITATION, WARRANTIES
- THAT THE DOCUMENT OR MODIFIED VERSION OF THE
- DOCUMENT IS FREE OF DEFECTS MERCHANTABLE, FIT FOR
- A PARTICULAR PURPOSE OR NON-INFRINGING. THE ENTIRE
- RISK AS TO THE QUALITY, ACCURACY, AND PERFORMANCE
- OF THE DOCUMENT OR MODIFIED VERSION OF THE
- DOCUMENT IS WITH YOU. SHOULD ANY DOCUMENT OR
- MODIFIED VERSION PROVE DEFECTIVE IN ANY RESPECT,
- YOU (NOT THE INITIAL WRITER, AUTHOR OR ANY
- CONTRIBUTOR) ASSUME THE COST OF ANY NECESSARY
- SERVICING, REPAIR OR CORRECTION. THIS DISCLAIMER
- OF WARRANTY CONSTITUTES AN ESSENTIAL PART OF THIS
- LICENSE. NO USE OF ANY DOCUMENT OR MODIFIED
- VERSION OF THE DOCUMENT IS AUTHORIZED HEREUNDER
- EXCEPT UNDER THIS DISCLAIMER; AND
- </para>
- </listitem>
- <listitem>
- <para>UNDER NO CIRCUMSTANCES AND UNDER NO LEGAL
- THEORY, WHETHER IN TORT (INCLUDING NEGLIGENCE),
- CONTRACT, OR OTHERWISE, SHALL THE AUTHOR,
- INITIAL WRITER, ANY CONTRIBUTOR, OR ANY
- DISTRIBUTOR OF THE DOCUMENT OR MODIFIED VERSION
- OF THE DOCUMENT, OR ANY SUPPLIER OF ANY OF SUCH
- PARTIES, BE LIABLE TO ANY PERSON FOR ANY
- DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR
- CONSEQUENTIAL DAMAGES OF ANY CHARACTER
- INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS
- OF GOODWILL, WORK STOPPAGE, COMPUTER FAILURE OR
- MALFUNCTION, OR ANY AND ALL OTHER DAMAGES OR
- LOSSES ARISING OUT OF OR RELATING TO USE OF THE
- DOCUMENT AND MODIFIED VERSIONS OF THE DOCUMENT,
- EVEN IF SUCH PARTY SHALL HAVE BEEN INFORMED OF
- THE POSSIBILITY OF SUCH DAMAGES.
- </para>
- </listitem>
- </orderedlist>
- </para>
- </legalnotice>
-
+<license xmlns="http://projectmallard.org/1.0/";
+ href="http://creativecommons.org/licenses/by-sa/3.0/";>
+<p>This work is licensed under a
+<link href="http://creativecommons.org/licenses/by-sa/3.0/";>Creative Commons
+Attribution-Share Alike 3.0 Unported License</link>.</p>
+<p>As a special exception, the copyright holders give you permission to copy,
+modify, and distribute the example code contained in this document under the
+terms of your choosing, without restriction.</p>
+</license>
diff --git a/help/C/logarithm.page b/help/C/logarithm.page
new file mode 100644
index 0000000..1f4646e
--- /dev/null
+++ b/help/C/logarithm.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="logarithm">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Logarithms</title>
+
+ <p>
+ Logarithms can be calculated using the log <link xref="function">function</link>.
+ </p>
+ <example>
+ <p>
+ log 100
+ </p>
+ </example>
+ <p>
+ To calculate a logarithm in a different base use a <link xref="superscript">subscript number</link> after the function.
+ </p>
+ <example>
+ <p>
+ logâ?? 32
+ </p>
+ </example>
+ <p>
+ To calculate a natural logarithm use the ln function.
+ </p>
+ <example>
+ <p>
+ ln 1.32
+ </p>
+ </example>
+ <p>
+ Eulers number can be entered by using the <link xref="variable">variable</link> e.
+ </p>
+ <example>
+ <p>
+ e^1.32
+ </p>
+ </example>
+</page>
diff --git a/help/C/modulus.page b/help/C/modulus.page
new file mode 100644
index 0000000..b95823f
--- /dev/null
+++ b/help/C/modulus.page
@@ -0,0 +1,19 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="modulus">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Modulus Division</title>
+
+ <p>
+ Modulus division is performed using the mod operator.
+ </p>
+ <example>
+ <p>
+ 9 mod 5
+ </p>
+ </example>
+</page>
diff --git a/help/C/mouse.page b/help/C/mouse.page
new file mode 100644
index 0000000..4ab6d56
--- /dev/null
+++ b/help/C/mouse.page
@@ -0,0 +1,37 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="mouse">
+
+ <info>
+ <link type="guide" xref="index#ui"/>
+ </info>
+
+ <title>Using the Mouse</title>
+
+ <p>
+ All equations can be entered using the mouse.
+ To access all buttons there are a number of modes that can be selected from the <gui>View</gui> menu.
+ </p>
+ <table>
+ <tr>
+ <td><p>Basic</p></td>
+ <td><p>Provides buttons suitable for <link xref="equation">basic equations</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Advanced</p></td>
+ <td><p>Provides buttons suitable for advanced mathematics</p></td>
+ </tr>
+ <tr>
+ <td><p>Scientific</p></td>
+ <td><p>Provides buttons suitable for <link xref="trigonometry">trigonometry</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Financial</p></td>
+ <td><p>Provides buttons suitable for <link xref="financial">financial equations</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Programming</p></td>
+ <td><p>Provides buttons suitable for computer programmers</p></td>
+ </tr>
+ </table>
+</page>
diff --git a/help/C/number-display.page b/help/C/number-display.page
new file mode 100644
index 0000000..9d3a377
--- /dev/null
+++ b/help/C/number-display.page
@@ -0,0 +1,43 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="number-display">
+
+ <info>
+ <link type="guide" xref="index#number"/>
+ </info>
+
+ <title>Result Format</title>
+
+ <p>
+ The format used to display results can be changed from the <guiseq><gui>Calculator</gui><gui>Preferences</gui></guiseq> menu.
+ </p>
+ <table>
+ <tr>
+ <td><p>Decimal</p></td>
+ <td><p>Results are displayed as decimal numbers</p></td>
+ </tr>
+ <tr>
+ <td><p>Scientific</p></td>
+ <td><p>Results are displayed in <link xref="scientific">scientific notation</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Engineering</p></td>
+ <td><p>Results are displayed in scientific notation except the exponent is always a multiple of three</p></td>
+ </tr>
+ <tr>
+ <td><p>Binary</p></td>
+ <td><p>Results are displayed as <link xref="base">binary numbers</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Octal</p></td>
+ <td><p>Results are displayed as <link xref="base">octal numbers</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Hexadecimal</p></td>
+ <td><p>Results are displayed as <link xref="base">hexadecimal numbers</link></p></td>
+ </tr>
+ </table>
+ <p>
+ The number of decimal places, if trailing zeroes and if thousands separators are shown can also be configured.
+ </p>
+</page>
diff --git a/help/C/percentage.page b/help/C/percentage.page
new file mode 100644
index 0000000..e3157c9
--- /dev/null
+++ b/help/C/percentage.page
@@ -0,0 +1,32 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="percentage">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Percentages</title>
+
+ <p>
+ Percentages are calculated using the % symbol.
+ </p>
+ <p>
+ When added or subtracted the percentage symbol solves to percentage of the value being added or subtracted from.
+ The following equation calculates the price of a $140 item with 15% tax (140 + (15÷100)�140).
+ </p>
+ <example>
+ <p>
+ 140+15%
+ </p>
+ </example>
+ <p>
+ In all other cases the percentage symbol solves to a fraction out of 100.
+ The following equation calculates one quarter of 80 apples ((25÷100)�80).
+ </p>
+ <example>
+ <p>
+ 25%Ã?80
+ </p>
+ </example>
+</page>
diff --git a/help/C/power.page b/help/C/power.page
new file mode 100644
index 0000000..58b2179
--- /dev/null
+++ b/help/C/power.page
@@ -0,0 +1,55 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="power">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Powers and Roots</title>
+
+ <p>
+ Powers are entered by putting a <link xref="superscript">superscript number</link> after the value.
+ </p>
+ <example>
+ <p>
+ 5²
+ </p>
+ </example>
+ <p>
+ The inverse of a number can be entered using the inverse symbol �¹ (<keyseq><key>Ctrl</key><key>I</key></keyseq>).
+ </p>
+ <example>
+ <p>
+ 3�¹
+ </p>
+ </example>
+ <p>
+ Powers can also be calculated using the ^ symbol.
+ This allows the power to be an equation.
+ </p>
+ <example>
+ <p>
+ 5^(6â??2)
+ </p>
+ </example>
+ <p>
+ If your keyboard does not have a <key>^</key> key you can use <key>*</key> twice.
+ </p>
+ <p>
+ Square roots can be calculated using the symbol (<keyseq><key>Ctrl</key><key>R</key></keyseq>).
+ </p>
+ <example>
+ <p>
+ â??2
+ </p>
+ </example>
+ <p>
+ n-th roots can be calculated by putting a <link xref="superscript">subscript number</link> before the root sign.
+ </p>
+ <example>
+ <p>
+ â??â??2
+ </p>
+ </example>
+</page>
diff --git a/help/C/scientific.page b/help/C/scientific.page
new file mode 100644
index 0000000..d6956c5
--- /dev/null
+++ b/help/C/scientific.page
@@ -0,0 +1,40 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="scientific">
+
+ <info>
+ <link type="guide" xref="index#number"/>
+ </info>
+
+ <title>Scientific Notation</title>
+
+ <p>
+ To enter numbers in scientific format use the <gui>Ã?10x</gui> button (<keyseq><key>Ctrl</key><key>E</key></keyseq>).
+ The <link xref="superscript">number mode</link> automatically changes to superscript.
+ To enter 2�10¹��, start by entering the mantissa (2):
+ </p>
+ <example>
+ <p>
+ 2
+ </p>
+ </example>
+ <p>
+ Then press the scientific notation button (or press <keyseq><key>Ctrl</key><key>E</key></keyseq>):
+ </p>
+ <example>
+ <p>
+ 2Ã?10
+ </p>
+ </example>
+ <p>
+ Then enter the exponent (100):
+ </p>
+ <example>
+ <p>
+ 2�10¹��
+ </p>
+ </example>
+ <p>
+ To show results in scientific form change the <link xref="number-display">result format</link>.
+ </p>
+</page>
diff --git a/help/C/superscript.page b/help/C/superscript.page
new file mode 100644
index 0000000..f76175d
--- /dev/null
+++ b/help/C/superscript.page
@@ -0,0 +1,33 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="superscript">
+
+ <info>
+ <!-- Place this at the end of the section -->
+ <title type="sort">_</title>
+ <link type="guide" xref="index#ui"/>
+ </info>
+
+ <title>Superscript and Subscript</title>
+
+ <p>
+ Some equations may require numbers to be entered in superscript or subscript form. e.g.
+ </p>
+ <example>
+ <p>
+ x³+2x²â??5
+ </p>
+ </example>
+ <p>
+ To enter superscript numbers with the mouse select the number mode using the the <gui>â??â?¿</gui> and <gui>â??n</gui> buttons.
+ When one of these modes is active clicking the number buttons will enter numbers in superscript or subscript.
+ To return to normal number mode click the active button.
+ </p>
+ <p>
+ To enter superscipt numbers with the keyboard hold down <key>Ctrl</key> while entering the number.
+ Hold <key>Alt</key> for subscript.
+ </p>
+ <p>
+ The number mode returns to normal when entering the next non-number character (e.g. +).
+ </p>
+</page>
diff --git a/help/C/trigonometry.page b/help/C/trigonometry.page
new file mode 100644
index 0000000..bca5ecf
--- /dev/null
+++ b/help/C/trigonometry.page
@@ -0,0 +1,46 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="trigonometry">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Trigonometry</title>
+
+ <p>
+ Trigonometry can be performed using the sin, cos, and tan <link xref="function">function</link>.
+ </p>
+ <example>
+ <p>
+ sin 45
+ </p>
+ </example>
+ <p>
+ The angle units used can be changed from the <guiseq><gui>Calculator</gui><gui>Preferences</gui></guiseq> menu.
+ Trigonometry buttons are visible when in <link xref="mouse">scientific mode</link>.
+ </p>
+ <p>
+ Hyperbolic functions are available by adding "h" to the end of a function.
+ </p>
+ <example>
+ <p>
+ sinh 0.34
+ </p>
+ </example>
+ <p>
+ Inverse functions are entered either using the inverse symbol �¹ (<keyseq><key>Ctrl</key><key>I</key></keyseq>) or the "a" form of the function.
+ The following two equations are equivalent.
+ </p>
+ <example>
+ <p>
+ sin�¹ 0.5
+ </p>
+ <p>
+ asin 0.5
+ </p>
+ </example>
+ <p>
+ To enter <link xref="variable">Ï?</link> with the keyboard use <keyseq><key>Ctrl</key><key>P</key></keyseq>.
+ </p>
+</page>
diff --git a/help/C/variables.page b/help/C/variables.page
new file mode 100644
index 0000000..a5e7ed6
--- /dev/null
+++ b/help/C/variables.page
@@ -0,0 +1,56 @@
+<page xmlns="http://projectmallard.org/1.0/";
+ type="guide"
+ id="variable">
+
+ <info>
+ <link type="guide" xref="index#equation"/>
+ </info>
+
+ <title>Variables</title>
+
+ <p>
+ To assign a value to a variable use the = symbol or choose the variable to assign to with the <gui>â??R</gui> button in <link xref="mouse">advanced mode</link>.
+ A variable name must only upper or lower characters.
+ </p>
+ <example>
+ <p>
+ x=5
+ </p>
+ <p>
+ value=82
+ </p>
+ </example>
+ <p>
+ Variables can be used in any equation and are substituted for their assigned value.
+ Variables can inserted using the <gui>â??R</gui> button.
+ </p>
+ <example>
+ <p>
+ 6x+3
+ </p>
+ <p>
+ xyâ??3x+7yâ??21
+ </p>
+ </example>
+ <p>
+ The following variables are always defined.
+ </p>
+ <table>
+ <tr>
+ <td><p>ans</p></td>
+ <td><p>Result of previous calculation</p></td>
+ </tr>
+ <tr>
+ <td><p>e</p></td>
+ <td><p><link xref="logarithm">Euler's Number</link></p></td>
+ </tr>
+ <tr>
+ <td><p>Ï?</p></td>
+ <td><p><link xref="trigonometry">Pi</link></p></td>
+ </tr>
+ <tr>
+ <td><p>rand</p></td>
+ <td><p>Random value in the range [0,1] (changes on each read)</p></td>
+ </tr>
+ </table>
+</page>
diff --git a/help/Makefile.am b/help/Makefile.am
index 5692e14..429e80f 100644
--- a/help/Makefile.am
+++ b/help/Makefile.am
@@ -1,14 +1,36 @@
include $(top_srcdir)/gnome-doc-utils.make
+
dist-hook: doc-dist-hook
-DOC_MODULE = gcalctool
-DOC_ENTITIES = legal.xml
-DOC_INCLUDES =
-DOC_FIGURES = figures/gcalctool_advanced_window.png \
- figures/gcalctool_basic_window.png \
- figures/gcalctool_financial_window.png \
- figures/gcalctool_menu_symbol.png \
- figures/gcalctool_scientific_window.png \
- figures/gcalctool_programming_window.png
+DOC_ID = gcalctool
+DOC_INCLUDES = legal.xml
+DOC_FIGURES =
+DOC_PAGES = absolute.page \
+ base.page \
+ boolean.page \
+ complex.page \
+ conv-base.page \
+ conv-character.page \
+ conv-currency.page \
+ conv-length.page \
+ conv-time.page \
+ conv-weight.page \
+ equation.page \
+ factorial.page \
+ factorize.page \
+ financial.page \
+ functions.page \
+ index.page \
+ keyboard.page \
+ logarithm.page \
+ modulus.page \
+ mouse.page \
+ number-display.page \
+ percentage.page \
+ power.page \
+ scientific.page \
+ superscript.page \
+ trigonometry.page \
+ variables.page
-DOC_LINGUAS = bg ca cs de el es eu fr it ja ko oc pt_BR ru sv zh_CN zh_HK zh_TW
+DOC_LINGUAS =
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
