Skip to content

GitLab

gnome-calculator
gnome-calculator
Commit 81a050a7 authored by Pranali Deshmukh's avatar Pranali Deshmukh
Browse files
Options

Adds a new Operations Modes section 

Modifies the index page to add a new Operations Modes section;
Moves the financial and programming mode documents within the
Operations mode section and removes the financial calculations
section; Renames the financial page to mode-financial to
maintain a simple naming convention.

Ref: #185
parent b6daebf2
Hide whitespace changes
Inline Side-by-side
Showing with 156 additions and 95 deletions
help/C/conv-currency.page
View file @ 81a050a7
......@@ -26,7 +26,7 @@
<title>Currency</title>
<p>To convert currencies, enter the <link xref="financial">financial
<p>To convert currencies, enter the <link xref="mode-financial">financial
mode</link>, and use the currency controls.</p>
<steps>
......
help/C/financial.page deleted 100644 → 0
View file @ b6daebf2
<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 financial mode 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>
help/C/index.page
View file @ 81a050a7
......@@ -8,6 +8,13 @@
<name>Robert Ancell</name>
<email>robert.ancell@gmail.com</email>
</credit>
<credit type="editor">
<name>Pranali Deshmukh</name>
<email>pranali21293@gmail.com</email>
<years>2020</years>
</credit>
<include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />
</info>
......@@ -16,6 +23,10 @@
<section id="ui" style="2column">
<title>User Interface</title>
</section>
<section id="modes" style="2column">
<title>Operation Modes</title>
</section>
<section id="equation" style="2column">
<title>Equations</title>
......@@ -28,8 +39,4 @@
<section id="conversion" style="2column">
<title>Conversions</title>
</section>
<section id="financial" style="2column">
<title>Financial Calculations</title>
</section>
</page>
help/C/mode-financial.page 0 → 100644
View file @ 81a050a7
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="mode-financial">
<info>
<link type="guide" xref="index#modes"/>
<revision pkgversion="3.38.0" date="2020-10-26" status="review"/>
<credit type="editor">
<name>Pranali Deshmukh</name>
<email>pranali21293@gmail.com</email>
<years>2020</years>
</credit>
<desc>Perform calculations using financial functions.</desc>
</info>
<title>Financial Mode</title>
<p>
<gui style="menuitem">Financial mode</gui> provides the tools required for financial calculations
and currency conversion. For example, the financial mode makes performing financial calculations
very easy with the presence function buttons for common operations like <gui>Ctrm</gui>,
<gui>Gpm</gui>, <gui>Rate</gui>, etc. A currency toggle button for easy interconversion of monetary
values between multiple international currencies.
</p>
<p>
When in financial mode 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>
help/C/mode-programming.page
View file @ 81a050a7
......@@ -3,42 +3,39 @@
id="mode-programming">
<info>
<link type="guide" xref="index#number"/>
<link type="guide" xref="index#modes"/>
<revision pkgversion="3.38.0" date="2020-10-26" status="review"/>
<credit type="editor">
<name>Pranali Deshmukh</name>
<email>pranali21293@gmail.com</email>
<years>2020</years>
</credit>
<desc>Perform mathematical operations useful for software development.</desc>
</info>
<title>Programming Mode</title>
<title>Programming Mode</title>
<p>
<gui style="menuitem">Programming mode</gui> provides the tools required for common mathematical operations in software development. For example, programming mode makes math on hexadecimal numbers very easy. It also supports common boolean functions like <gui>NOT</gui>, <gui>AND</gui>, <gui>OR</gui>, etc. A binary view for numbers up to 64 bits long is displayed, where the user can manually toggle each bit using the mouse cursor.
<gui style="menuitem">Programming mode</gui> provides the tools required for common mathematical operations in software development. For example, programming mode makes math on hexadecimal numbers very easy. It also supports common boolean functions like <gui>NOT</gui>, <gui>AND</gui>, <gui>OR</gui>, etc. A binary view for numbers up to 64 bits long is displayed, where the user can manually toggle each bit using the mouse cursor.
</p>
<p>
Additionally, bit-shifting operations are possible by using the <gui>≪</gui> and <gui>≫</gui> buttons. Modulo arithmetic can be accomplished using the <gui>mod</gui> button.
Additionally, bit-shifting operations are possible by using the <gui>≪</gui> and <gui>≫</gui> buttons. Modulo arithmetic can be accomplished using the <gui>mod</gui> button.
</p>
<p>
The default word size for boolean, one's complement, and two's complement functions can be changed both in the <gui style="menuitem">Preferences</gui> menu, or by using the word size button in the top right of the keypad while in programming mode. This will affect how results from these functions are shown. For example, here we show the two's complement of the number 6B in 64 bit and 16 bit word sizes:
The default word size for boolean, one's complement, and two's complement functions can be changed both in the <gui style="menuitem">Preferences</gui> menu, or by using the word size button in the top right of the keypad while in programming mode. This will affect how results from these functions are shown. For example, here we show the two's complement of the number 6B in 64 bit and 16 bit word sizes:
</p>
<example>
<p>
64 bit:
</p>
<p>
twos 6B
</p>
<p>
FFFFFFFFFFFFFF95
</p>
<p>
16 bit:
</p>
<p>
twos 6B
</p>
<p>
FF95
</p>
</example>
<note style="warning">
<example>
<p>64 bit:</p>
<p>twos 6B</p>
<p>FFFFFFFFFFFFFF95</p>
<p>16 bit:</p>
<p>twos 6B</p>
<p>FF95</p>
</example>
<note style="warning">
<p>Attempting to enter a larger number than will fit in the selected word size will result in an Overflow error.</p>
</note>
</note>
</page>
help/C/mouse.page
View file @ 81a050a7
......@@ -23,7 +23,7 @@
</tr>
<tr>
<td><p>Financial</p></td>
<td><p>Provides buttons suitable for <link xref="financial">financial equations</link></p></td>
<td><p>Provides buttons suitable for <link xref="mode-financial">financial equations</link></p></td>
</tr>
<tr>
<td><p>Programming</p></td>
......
help/meson.build
View file @ 81a050a7
......@@ -12,13 +12,15 @@ gnome_calculator_help_pages = [
'equation.page',
'factorial.page',
'factorize.page',
'financial.page',
'functions.page',
'history.page',
'index.page',
'keyboard.page',
'legal.xml',
'logarithm.page',
'mode-financial.page',
'mode-overview.page',
'mode-programming.page',
'modulus.page',
'mouse.page',
'number-display.page',
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment