[office/kmymoney/update-docs] doc: Update two more chapters to 5.1
Jack Ostroff
null at kde.org
Tue Aug 9 17:44:47 BST 2022
Git commit 8dec88a5562d23b55e37699799ab1965811f90e3 by Jack Ostroff.
Committed on 08/08/2022 at 21:58.
Pushed by ostroffjh into branch 'update-docs'.
Update two more chapters to 5.1
M +49 -36 doc/details-currencies.docbook
M +70 -28 doc/details-reconciliation.docbook
M +3 -3 doc/whatsnew.docbook
https://invent.kde.org/office/kmymoney/commit/8dec88a5562d23b55e37699799ab1965811f90e3
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index ae6a1870e..753fa9006 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -4,9 +4,10 @@
<authorgroup>
<author> &Thomas.Baumgart; &Thomas.Baumgart.mail; </author>
<author>&Michael.Carpino; &Michael.Carpino.mail;</author>
+ <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
</authorgroup>
- <date>2020-02-20</date>
- <releaseinfo>5.0.8</releaseinfo>
+ <date>2022-08-08</date>
+ <releaseinfo>5.1.3</releaseinfo>
</chapterinfo>
<title>Currencies</title>
@@ -21,12 +22,14 @@
<title>Base currency</title>
<para>
- During the initial &kmymoney; New File Setup, you will be asked to select the
- base currency. Usually, the base currency is the currency you use in your
- country. The base currency is the one that all income and expense categories
- use and that reports will be based on. When you set up a new account &kmymoney;
- will automatically default to the base currency. If your account requires you
- to use a different currency, you can change it during the New Account Setup.
+ During the initial &kmymoney; <link linkend="firsttime.3">New File
+ Setup</link>, you will be asked to select the base currency. Usually, the
+ base currency is the currency you use in your country. The base currency is
+ the one that all income and expense categories use and that reports will be
+ based on. When you set up a new account, &kmymoney; will automatically default
+ to the base currency. If your account requires you to use a different
+ currency, you can change it during the <link
+ linkend="details.accounts.create">New Account Setup.</link>
</para>
<para>
@@ -57,12 +60,16 @@
<para>
To manually add a currency, select the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Currencies...</guimenuitem></menuchoice>
- menu item to display the <guilabel>Currencies</guilabel> dialog, as shown above. Right
- click on any existing currency and select <guimenuitem>New currency</guimenuitem>
- from the <guimenu>Currency Options</guimenu> context menu. Enter the official code for the
- currency and click <guilabel>OK</guilabel>. The currency will be created with
- the name <quote>New Currency</quote>. To change the name, either press
- <keycap>F2</keycap> or right click and select <guimenuitem>Rename currency</guimenuitem>.
+ menu item to display the <guilabel>Currencies</guilabel> dialog, as shown
+ above. Either click on the <guibutton>+ Add</guibutton> button or right click
+ on any existing currency and select <guimenuitem>New currency</guimenuitem>
+ from the <guimenu>Currency Options</guimenu> context menu. That will bring up
+ a dialog where you can enter the ISO Code, Name, and other details about the
+ currency. When you are ready, click <guilabel>OK</guilabel>. The currency
+ will be created with the specified name. To change the name or other details
+ later, click the <guibutton>Edit</guibutton> button. You can also change the
+ name by either pressing <keycap>F2</keycap> or right clicking the currency and
+ selecting <guimenuitem>Rename currency</guimenuitem>.
</para>
</sect2>
</sect1>
@@ -72,10 +79,12 @@
<para>
When you create a new account, you specify the currency in which it will be
- managed. The New Account wizard defaults this setting to the <link
+ managed. The New Account wizard defaults this setting to the <link
linkend="details.currencies.basecurrency">base currency</link>. If you
require a different currency, you need to select it during this initial setup.
The ledger for the account will then show all values in the selected currency.
+ You cannot change the currency of an account once the account has been
+ created.
</para>
</sect1>
@@ -83,12 +92,14 @@
<title>Entering transactions using different currencies</title>
<para>
- Whenever a transaction is entered that refers to more than one currency, the
- exchange rate editor pops up and allows you to enter an exchange
- rate. Initially, the current price available from the price database will be
- used as exchange rate. See <link linkend="details.currencies.prices">Entering
- exchange rates for currencies</link> for more information on how to provide
- exchange rates manually and obtain online price information.
+ Whenever a transaction is entered that refers to more than one currency, which
+ includes using a currency other than the default currency of the account, the
+ exchange rate editor pops up and allows you to enter an exchange rate to be
+ used for that transaction. Initially, the current price available from the
+ price database will be used as exchange rate. See <link
+ linkend="details.currencies.prices">Entering exchange rates for
+ currencies</link> for more information on how to provide exchange rates
+ manually and obtain online price information.
</para>
<para>
@@ -104,8 +115,8 @@
<title>Entering prices manually</title>
<para>
- The price database editor allows you to enter exchange rates between
- currencies or prices for investments. You can pull it up using the
+ The <guilabel>Price Editor</guilabel> allows you to enter exchange rates
+ between currencies or prices for investments. You can pull it up using the
<menuchoice><guimenu>Tools</guimenu><guimenuitem>Prices...</guimenuitem></menuchoice>
menu item.
</para>
@@ -124,18 +135,19 @@
</para>
<para>
- In &kmymoney; a <quote>Price</quote> is the price of one currency in terms of
- a second currency. For example, as I write this, the price of 1 USD in terms
- of 1 EUR is 0.83; that is, 1 USD costs 0.83 EUR. The first currency is the
- one being bought or sold, and the second one is the currency used to buy or
- sell it.
+ In &kmymoney; a <quote>Price</quote> is the cost of one currency in terms of a
+ second currency. For example, as I write this, the price of 1 USD in terms of
+ 1 EUR is 0.83; that is, 1 USD costs 0.83 EUR. The first currency is the one
+ being bought or sold, and the second one is the currency used to buy or sell
+ it.
</para>
<para>
- When you press the <guibutton>New</guibutton> button, you get the New Price
- Entry dialog. Enter the first currency (USD in the example above) in the
- Security field. Enter the second currency (EUR in the example above) in the
- Currency field. Enter the effective date of the price in the Date field.
+ When you press the <guibutton>New</guibutton> button, you get the
+ <guilabel>New Price Entry</guilabel> dialog. Enter the first currency (USD in
+ the example above) in the Security field. Enter the second currency (EUR in
+ the example above) in the Currency field. Enter the effective date of the
+ price in the Date field.
</para>
<para>
@@ -156,14 +168,15 @@
<title>Online currency updates</title>
<para>
- &kmymoney; will fetch currency conversions from the web. Once you have
- entered a single price for a pair of currencies, the online quote feature will
- always list that pair amongst its options.
+ &kmymoney; can fetch currency conversions from the web. Once you have entered
+ a single price for a pair of currencies, the online quote feature will always
+ list that pair among its options.
</para>
<para>
See the section on <link linkend="details.investments.onlinequotes">Online
- Price Quotes</link> in the Investments chapter for more details.
+ Price Quotes</link> in the <guilabel>Investments</guilabel> chapter for more
+ details.
</para>
</sect2>
</sect1>
diff --git a/doc/details-reconciliation.docbook b/doc/details-reconciliation.docbook
index 1432104a1..73454016c 100644
--- a/doc/details-reconciliation.docbook
+++ b/doc/details-reconciliation.docbook
@@ -3,8 +3,9 @@
<chapterinfo>
<authorgroup>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
+ <author>&Jack.H.Ostroff; &Jack.H.Ostroff.mail;</author>
</authorgroup>
- <date>2010-07-21</date>
+ <date>2022-08-08</date>
<releaseinfo>4.5</releaseinfo>
</chapterinfo>
@@ -24,21 +25,23 @@
</para>
<para>
- To reconcile an account, choose your account from the drop down box and click
- on the <guiicon><inlinemediaobject><imageobject><imagedata fileref="reconcile.png"
- format="PNG"/></imageobject></inlinemediaobject></guiicon> reconcile icon, select
- the <menuchoice><guimenu>Account</guimenu> <guimenuitem>Reconcile...</guimenuitem>
- </menuchoice> menu item or use the <keycombo>&Ctrl;&Shift;<keycap>R</keycap></keycombo>
- shortcut.
+ To reconcile an account, display that account in the ledger and click on the
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="reconcile.png"
+ format="PNG"/></imageobject></inlinemediaobject></guiicon>Reconcile icon,
+ select the <menuchoice><guimenu>Account</guimenu>
+ <guimenuitem>Reconcile...</guimenuitem> </menuchoice> menu item, or use the
+ <keycombo>&Ctrl;&Shift;<keycap>R</keycap></keycombo> shortcut. You can also
+ right click the account in the <guilabel>Accounts</guilabel> View and select
+ <guimenuitem>Reconcile...</guimenuitem> from the context menu.
</para>
</sect1>
<sect1 id="details.reconcile.wizard">
<title>The reconciliation wizard</title>
<para>
- This will open the reconciliation wizard. The first page of the wizard
- briefly describes the process you will follow. Click
- on <guibutton>Next</guibutton> to actually start the wizard.
+ Any of the spcified actions will open the reconciliation wizard. The first
+ page of the wizard briefly describes the process you will follow. Click on
+ <guibutton>Next</guibutton> to actually start the wizard.
</para>
<para>
@@ -59,10 +62,7 @@
<title>Statement details</title>
<para>
The statement date, starting balance, and ending balance can be found in your
- statement. Make sure that the figures match and click on
- the <guibutton>Next</guibutton> button. If the figures do not match then
- enter the figures as listed on your statement and click on
- the <guibutton>Next</guibutton> button.
+ statement. The default values displayed by the wizard are determined by your data.
</para>
<para>
@@ -78,19 +78,61 @@
</mediaobject>
</screenshot>
</para>
+
+<para>
+ The default value for the statement date is 30 days after the prior
+ reconciliation, so you will often need to adjust this by one or two days. You
+ may need to adjust it by two months if you only receive quarterly statement
+ from the Institution for this Account.
+</para>
+
+<para>
+ The starting balance shown is the balance on the date of the previous
+ reconciliation. The ending balance is the cleared balance at the end of the
+ Statement date. This is the starting balance with the values of all cleared
+ transactions between the previous reconciliation and the statement date added
+ or subtracted as appropriate.
+</para>
+
+<para>
+ If the values all match, click on the <guibutton>Next</guibutton> button.
+</para>
+
+<para>
+ If the figures do not match there are two paths you can take. The first is to
+ cancel the reconciliation, resolve any discrepancies between your data and the
+ information shown on the statement, and then start the reconciliation again.
+ The second is to adjust the ending balance to match the value on the
+ statement, and then click on the <guibutton>Next</guibutton> button. You will
+ have an opportunity to resolve any discrepancies during the next step of the
+ reconciliation process.
+</para>
+
+<para>
+ Note that you cannot adjust the starting balance. If the amount diplayed does
+ not match the amount on your statement, it indicates there is a problem with
+ the previous reconciliation, or maybe even an earlier one. In this case, you
+ need to cancel the reconciliation and start again after fixing any problems
+ with your data. The most common reason for this situation is that some time
+ after the prior reconciliation, you have inadvertently edited a transaction
+ propr to that date. There are plans to make &kmymoney; more resistant to this
+ problem, but for now, you need to work your way back to find the earliest
+ reconciliation which does match as the problem is most likely with one or more
+ transactions between that date and the prior reconciliation.
+</para>
</sect2>
<sect2 id="details.reconcile.wizard.interest">
<title>Interest</title>
<para>
- If the statement reconciliation is on a bank account or any account with
- interest and/or charges fees, then enter these values in the appropriate
- fields. A category can be assigned for each of these amounts.
+ If you are reconciling a bank account or any account which pays interest
+ and/or charges fees, then enter these values in the appropriate fields. A
+ category must be assigned for each of these amounts.
</para>
<note>
<para>
- The interest field is for interest you gained. If you have to pay interest,
+ The interest field is for interest you gained. If you have to pay interest,
⪚, for a credit card account, this has to be entered as a charge.
</para>
</note>
@@ -111,21 +153,21 @@
<para>
Click on <guibutton>Continue</guibutton> to start matching your statement to
- what you have entered. Note that this completes the Reconciliation Wizard,
- but not the process of reconciliation. It also changes the ledger display by
- only showing transactions that have not already been marked as reconciled. As
- described below, you still need to clear transactions and then tell &kmymoney;
- that the account is reconciled.
+ what you have entered. Note that this is the last screen of the
+ Reconciliation Wizard, but it is not the end of the process of reconciliation.
+ It also changes the ledger display by only showing transactions that have not
+ already been marked as reconciled. As described below, you still need to
+ clear transactions and then tell &kmymoney; that the account is reconciled.
</para>
</sect2>
<sect2 id="details.reconcile.wizard.clearing">
<title>Clearing transactions</title>
<para>
- During the reconciliation, any transaction can be edited to make it match the
- statement, and new transactions can be created as usual. To mark a
- transaction as cleared, click on the <guilabel>C</guilabel> column in the list
- view. A transaction is cleared when it matches the transaction on your
+ During the reconciliation process, any transaction can be edited to make it
+ match the statement, and new transactions can be created as usual. To mark a
+ transaction as cleared, click on the <guilabel>C</guilabel> column in the
+ ledger. A transaction is cleared when it matches the transaction on your
statement.
</para>
@@ -176,7 +218,7 @@
<sect3 id="details.reconcile.postpone">
<title>Postponing Reconciliation</title>
<para>
- If you're having trouble completing the reconciliation, or you need to gather
+ If you are having trouble completing the reconciliation, or you need to gather
some additional information before you can complete the process, you can
postpone the process to a later time by clicking on the
<guibutton>Postpone</guibutton> button. When you do this, &kmymoney; remembers
diff --git a/doc/whatsnew.docbook b/doc/whatsnew.docbook
index 17b403bc2..c83471b09 100644
--- a/doc/whatsnew.docbook
+++ b/doc/whatsnew.docbook
@@ -85,9 +85,11 @@
<member><link linkend="details.categories">Categories</link></member>
<member><link linkend="details.tags">Tags</link></member>
<member><link linkend="details.payees">Payees</link></member>
- <member><link linkend="details.reconcile">Schedules</link></member>
+ <member><link linkend="details.schedules">Schedules</link></member>
<member><link linkend="details.ledgers">Ledgers</link></member>
<member><link linkend="details.investments">Investments</link></member>
+ <member><link linkend="details.currencies">Currencies</link></member>
+ <member><link linkend="details.reconcile">Reconciliation</link></member>
<member><link linkend="details.impexp">Importing and Exporting</link></member>
<member><link linkend="details.settings">Settings</link></member>
<member><link linkend="reference.menus">Reference: Menus</link></member>
@@ -96,8 +98,6 @@
</entry>
<entry valign="top">
<simplelist>
- <member><link linkend="details.currencies">Currencies</link></member>
- <member><link linkend="details.reconcile">Reconciliation</link></member>
<member><link linkend="details.reports">Reports</link></member>
<member><link linkend="details.loans">Loans</link></member>
<member><link linkend="details.budgets">Budgets</link></member>
More information about the kde-doc-english
mailing list