[office/kmymoney/Handbook-5.2] /: Completed first pass at several additional chapters, plus various
Jack Ostroff
null at kde.org
Wed Aug 30 20:10:08 BST 2023
Git commit e6d75f1c62d01c6141ac93e66dbfa7b74a092030 by Jack Ostroff.
Committed on 30/08/2023 at 21:09.
Pushed by ostroffjh into branch 'Handbook-5.2'.
Completed first pass at several additional chapters, plus various
other fixes and consistency impprovements.
M +104 -19 README-CONTRIBUTORS
M +353 -274 doc/details-accounts.docbook
M +99 -66 doc/details-categories.docbook
M +7 -6 doc/details-currencies.docbook
M +3 -3 doc/details-impexp-csv.docbook
M +2 -2 doc/details-impexp.docbook
M +1 -82 doc/details-institutions.docbook
M +1 -4 doc/details-investments.docbook
M +9 -11 doc/details-ledgers.docbook
M +157 -129 doc/details-payees.docbook
M +177 -179 doc/details-schedules.docbook
M +1 -1 doc/details-search.docbook
M +8 -12 doc/details-settings.docbook
M +77 -60 doc/details-tags.docbook
M +1 -1 doc/firsttime.docbook
M +1 -1 doc/index.docbook
https://invent.kde.org/office/kmymoney/-/commit/e6d75f1c62d01c6141ac93e66dbfa7b74a092030
diff --git a/README-CONTRIBUTORS b/README-CONTRIBUTORS
index ca1e7eafe..d89b1873f 100644
--- a/README-CONTRIBUTORS
+++ b/README-CONTRIBUTORS
@@ -8,26 +8,27 @@ If you are interested in contributing, please contact
ostroffjh at users.sourceforge.net so multiple people are not working on the
same chapters at the same time.
-I expect that there will be changes ONLY in the doc subdirectory.
+This branch should have changes ONLY in the doc subdirectory.
Update of screenshots will be left for later in the process, but
descriptions of what changes or new screenshots are needed can/should be
placed below the existing or target location.
-At some point, I will add to this doc a list of which chapters have and have
-not been edited yet, and not use the list used for the 4 -> 5 changes in the
-What's New section.
+At some point, I will add to this doc a list of which chapters have and have not been
+edited yet, and not use the list used for the 4 -> 5 changes in the What's New
+section. However, on further thought, that should not be necessary, as this should
+not be released with 5.2 until it is fully updated for that version.
This is in the order pulled in from index.docbook, with brief note on state of update
<!ENTITY introduction SYSTEM "introduction.docbook">
- prelim update
+ prelim update done
<!ENTITY whatsnew SYSTEM "whatsnew.docbook">
- prelim update
+ prelim update done
<!ENTITY makemostof SYSTEM "makemostof.docbook">
- prelim update - possibly need a complete replacement of this
+ prelim update - probably need a complete replacement of this
<!ENTITY firsttime SYSTEM "firsttime.docbook">
prelim update complete
@@ -36,32 +37,61 @@ This is in the order pulled in from index.docbook, with brief note on state of u
prelim update complete
<!ENTITY details-accounts SYSTEM "details-accounts.docbook">
- prelim update started
+ prelim update complete
<!ENTITY details-categories SYSTEM "details-categories.docbook">
+ prelim update complete
+
<!ENTITY details-tags SYSTEM "details-tags.docbook">
+ prelim update complete
+
<!ENTITY details-payees SYSTEM "details-payees.docbook">
+ prelim update complete
+
<!ENTITY details-schedules SYSTEM "details-schedules.docbook">
+ prelim update complete
+
<!ENTITY details-ledgers SYSTEM "details-ledgers.docbook">
+ prelim update begun
+
<!ENTITY details-investments SYSTEM "details-investments.docbook">
+
<!ENTITY details-currencies SYSTEM "details-currencies.docbook">
+
<!ENTITY details-reconciliation SYSTEM "details-reconciliation.docbook">
+
<!ENTITY details-reports SYSTEM "details-reports.docbook">
+
<!ENTITY details-impexp SYSTEM "details-impexp.docbook">
+
<!ENTITY details-impexp-csv SYSTEM "details-impexp-csv.docbook">
+
<!ENTITY details-impexp-csvexp SYSTEM "details-impexp-csvexp.docbook">
+
<!ENTITY details-impexp-woob SYSTEM "details-impexp-woob.docbook">
+
<!ENTITY details-loans SYSTEM "details-loans.docbook">
+
<!ENTITY details-budgets SYSTEM "details-budgets.docbook">
+
<!ENTITY details-forecast SYSTEM "details-forecast.docbook">
+
<!ENTITY details-settings SYSTEM "details-settings.docbook">
+
<!ENTITY details-search SYSTEM "details-search.docbook">
+
<!ENTITY details-formats SYSTEM "details-formats.docbook">
+
<!ENTITY details-database SYSTEM "details-database.docbook">
+
<!ENTITY faq SYSTEM "faq.docbook">
+
<!ENTITY reference SYSTEM "reference.docbook">
+
<!ENTITY details-widgets SYSTEM "details-widgets.docbook">
+
<!ENTITY credits SYSTEM "credits.docbook">
+
<!-- no longer used? <!ENTITY details-hbciofx SYSTEM "details-hbciofx.docbook"> -->
<!-- not directly included in docbook "man-kmymoney.1.docbook" -->
@@ -73,9 +103,6 @@ multiple places.
- Need consistency in capitalization of Xxx View. What about View Selector?
-- columns which may be displayed in various Views by right clicking in header and
- selecting. Mention for each view, but is there a general place? FAQ?
-
- In Institutuions and Accounts Views, balance is in currency of the account, total
value is in base currency. Need to confirm, and see how/if this affects roll-up.
@@ -97,31 +124,80 @@ multiple places.
others?) Also not sure where to mention that sql storage is treated as another
type of file.
+- Where are config files located? Handbook currently says $KDEHOME/share/config, but
+ I find it $KDEHOME/kmymoney where $KDEHOME is ~/.config) and other stuff in
+ ~/.local/share/kmymoney.
+
- is there a "man file" equivalent on Mac and Windows? (referenced in Launching
section of Firsttime.
- running 'kmymoney path-to-file' says can import a gnucash file. Import or open
into kmm format?
-- Where are config files located? Handbook currently says $KDEHOME/share/config, but
- I find it $KDEHOME/kmymoney where $KDEHOME is ~/.config) and other stuff in
- ~/.local/share/kmymoney.
-
- why is account type column not shown in Institutions View?
- Confirm IBAN, Bank Code, SWIFT/BIC only apply to accounts, not institutions, and
explain only to the bank where the account is.
-- Deleting an Institution orphans any accounts without warning, and they do not appear
- under the "Institution for accounts with no institution" until after a reboot.
+- Deleting an Institution orphans any accounts without warning, and they do not
+ appear under the "Institution for accounts with no institution" until after a
+ restart of KMM.
- "...all the..." or "...all your..."
- In Accounts View, the type of "Favorite" is "Asset" instead of "Favorite" or blank.
+- Be consistent: click something or click on something?
+- Why do we mix "preferred" and "favorite" account designation? Are they any different?
-----------------
+- do we still have the issue that you cannot edit a loan account, only the schedule
+ which was created for paying the loan?
+
+- Are loans with 0% now allowed? Need to know for wording about loan accounts.
+
+- do we want to talk about stock as an account type?
+
+- Bug 272737 is that categories and account hierarchies cannot be dragged to new
+ location. It seems this is still not implemented. Will it ever be? I'm not sure
+ it's really needed, since you just click on the new parent and click OK (or Apply?)
+
+- There are several tabs in the Edit Account dialog which are not included in the New
+ Account dialog. Should these also be there?
+
+- Confirm wording of VAT percentage in Edit Account section.
+
+- Is CC (cost center) used for anything? Does it occur anywhere except Categories
+ (which is only that cc is required)
+
+- In New Category dialog, Price entry dropdown is disabled. Is there any condition
+ under which it is enabled? If so, need to add to handbook.
+
+- TMTOWTDI: right-click here, click there. Do we put multiple ways in lots of
+ places, or just a first description and then single way in most descriptions?
+
+- do we need a Tags main menu item?
+
+- confirm which import methods are or are not able to import tags.
+
+- do we want to be consistent about whether descriptions are above/below/or mixed in
+ relation to the screenshot they describe?
+
+- in Tabbed sections, the sect titles are sometimes just the tab title, but sometimes
+ more descriptive (see Payees Details) Do we want this to be consistent?
+
+- The handbook uses "Schedules" as the formal name, but the View Selector says
+ "Scheduled transactions" We should be consistent.
+
+- On schecule frequency, should we comment on possibly odd combinations of frequency
+ and the interval? What happens if you say 2 Once? Is 2 Month the same as 1 Every
+ half month or 1 Every two months?
+
+- Price downloads allow you to specify data (date range?) yet this is never used in
+ actually fetching prices (stocks or currency.) Should we just drop the field, or
+ at least note it is ignored? IS there any way to retreive historic prices?
+
+ ----------------
This is a list of potential enhancements I came up with while reviewing the handbook,
but have not yet posted either as wishlist bugs, entries to any Issue on invent, or
@@ -135,7 +211,7 @@ elsewhere.
header row.
- Do we want to allow selecting right v left justification of any columns? (mainly
- thinking of date in Schedule T View.
+ thinking of date in Schedules View.
- In multi column views, allow not forcing use of full width, i.e., don't force
rightmost column to right edge of window.
@@ -143,3 +219,12 @@ elsewhere.
- Consider reordering the View Selector. Categories right after Accounts, move
Schedules down directly above Ledgers? Payees above Tags
+- Should the Account View (Institutions also?) include Currency column?
+
+- New Schedule dialog is still titled "Edit Scheduled transaction"
+
+- should register be replaced with ledger wherever it is used?
+
+
+
+
diff --git a/doc/details-accounts.docbook b/doc/details-accounts.docbook
index 03ca4a487..b8e1e3ead 100644
--- a/doc/details-accounts.docbook
+++ b/doc/details-accounts.docbook
@@ -6,7 +6,7 @@
<author> &Roger.Lum; &Roger.Lum.mail; </author>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2023-08-20</date>
+ <date>2023-08-30</date>
<releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
@@ -21,7 +21,7 @@
<para>
There are two other account types: <quote>Income</quote> and
- <quote>Expense</quote>. These accounts are <quote>Categories,</quote> and are a way
+ <quote>Expense.</quote> These accounts are <quote>Categories,</quote> and are a way
to organize your transactions. They are treated internally by &kmymoney; as
accounts, and are described in more detail in the section on <link
linkend="details.categories">Categories</link>. Income and Expense accounts are
@@ -33,12 +33,12 @@
<para>
You may also see <quote>Equity</quote> as an account type. Any account of this
type is a special account in &kmymoney;, used to hold the opening balance
- transactions of all other accounts.
+ transactions of other accounts.
</para>
<para>
The final type, although it is displayed first on the list, is
- <quote>Favorite</quote>. These are accounts of any other type which you have
+ <quote>Favorite.</quote> These are accounts of any other type which you have
indicated are <quote>favorite</quote> accounts in the details when creating or
editing that account.
</para>
@@ -47,30 +47,31 @@
<title>The Accounts View</title>
<para>
-<screenshot>
- <screeninfo>account view</screeninfo>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <screeninfo>account view</screeninfo>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="account_view.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>account view</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
The Accounts View provides a summary of all the accounts. It is similar to the
Institutions View, except accounts are grouped by the type of account. The list of
- accounts under any account type can be expanded or collapsed by clicking on the
- arrow to the left of the type.
+ accounts under any account type (or under the parent acccount for any subaccounts)
+ can be expanded or collapsed by clicking on the arrow to the left of the type or
+ name.
</para>
<para>
Similar to the Institutions View, the Accounts View displays several columns with
descriptive and summary information about each account. As with the Institutions
- View, you can select which columns are shown by right clicking on any column
+ View, you can select which columns are shown by right-clicking on any column
heading and selecting or unselecting the checkbox next to the name of the column.
</para>
@@ -85,7 +86,7 @@
<term>Name</term>
<listitem>
<para>
- The name of the account. This columns is always displayed.
+ The name of the account. This column is always displayed.
</para>
</listitem>
</varlistentry>
@@ -104,6 +105,9 @@
<listitem>
<para>
An indication whether this account has been configured for online access.
+ The process of configuring accounts for online access is described in the
+ <link linkend="details.impexp">Importing and Exporting Chapter.</link>
+ <!-- FIXME: make this link more specific -->
</para>
</listitem>
</varlistentry>
@@ -142,8 +146,8 @@
<term>Total Value</term>
<listitem>
<para>
- This is the same value as the balance, but always in the base currenct as
- chosen for the data file. These values are summed for the row for the
+ This is the same value as the balance, but always in the base currency chosen
+ when data file was created. These values are summed for the row for the
overall account type.
</para>
</listitem>
@@ -171,7 +175,6 @@
</varlistentry>
</variablelist>
</sect1>
-<!--- done to here! -->
<sect1 id="details.accounts.create">
<title>Creating an Account</title>
@@ -189,7 +192,7 @@
fileref="newacct.png" format="PNG"/></imageobject></inlinemediaobject>
</guiicon> new account icon from the toolbar. You can also create an account
from the Accounts View; click on the Accounts icon in the view selector and
- then right click on the Asset or Liability tree icon and select <guimenuitem>New
+ then right-click on the Asset or Liability tree icon and select <guimenuitem>New
account...</guimenuitem> from the popup menu.
</para>
@@ -224,7 +227,7 @@
url="https://en.wikipedia.org/wiki/International_Bank_Account_Number"><acronym>IBAN</acronym>
(International Bank Account Number)</ulink> are not currently used
by &kmymoney;. These fields may be left blank and filled in at a later time;
- they are only required for online banking.
+ they are only required for online banking. <!-- FIXME: check accuracy -->
</para>
<para>
@@ -237,14 +240,14 @@
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
@@ -253,12 +256,11 @@
</para>
<para>
- Next, select the type of account from one of the types available from the
- dropdown list. Different account types are handled differently within
- &kmymoney;, so it is important to choose the correct type when creating the
- account. Also, different types of accounts require different setup
- information, and may display different pages in the new account setup wizard
- to collect that information.
+ Next, select the type of account from one of the types available from the dropdown
+ list. Different account types are handled differently within &kmymoney;, so it is
+ important to choose the correct type when creating the account. Also, different
+ types of accounts require different setup information, and may display different
+ pages in the new account setup wizard to collect that information.
</para>
<variablelist>
@@ -266,7 +268,7 @@
<term>Checking</term>
<listitem>
<para>
- A normal checking account, the type you get with any bank or credit union.
+ A normal checking account, such as you get with any bank or credit union.
</para>
</listitem>
</varlistentry>
@@ -275,7 +277,7 @@
<term>Savings</term>
<listitem>
<para>
- A normal savings account, the type you get with any bank or credit union.
+ A normal savings account, such as you get with any bank or credit union.
</para>
</listitem>
</varlistentry>
@@ -293,8 +295,8 @@
<term>Cash</term>
<listitem>
<para>
- A general purpose account, typically used for accounts not held at a
- bank, such as the cash in your wallet.
+ A general purpose account, typically used for accounts not held at a bank,
+ such as the cash in your wallet.
</para>
</listitem>
</varlistentry>
@@ -303,11 +305,11 @@
<term>Loan</term>
<listitem>
<para>
- An account to manage a loan for money either borrowed or lent. With a
- Loan account &kmymoney; automatically calculates interest payments to
- help you track the remaining principal on the loan. Loans with no
- interest might use the plain Asset or Liability type below, depending on
- whether the money is lent or borrowed.
+ An account to manage a loan for money either borrowed or lent. With a Loan
+ account, &kmymoney; automatically calculates interest payments to help you
+ track the remaining principal on the loan. Loans with no interest should use
+ the plain Asset or Liability type below, depending on whether the money is
+ lent or borrowed.
</para>
</listitem>
</varlistentry>
@@ -316,8 +318,7 @@
<term>Investment</term>
<listitem>
<para>
- An account to manage an investment such as stocks, bonds, or mutual
- funds.
+ An account to manage an investment such as stocks, bonds, or mutual funds.
</para>
</listitem>
</varlistentry>
@@ -326,8 +327,8 @@
<term>Asset</term>
<listitem>
<para>
- An account to manage an asset that does not fit in one of the above
- types.
+ An account to manage an asset that does not fit in one of the above types.
+ For example, this can be used to track the value of a vehicle.
</para>
</listitem>
</varlistentry>
@@ -336,17 +337,29 @@
<term>Liability</term>
<listitem>
<para>
- An account to manage a money you owe or a future expense that does not
- fit in one of the above types. This is most commonly used for loans
- with no interest. If interest needs to be calculated, you might be
- better using the Loan type above.
+ An account to manage a money you owe or a future expense that does not fit in
+ one of the above types. This is most commonly used for loans with no
+ interest. If interest needs to be calculated, you should use the Loan type
+ above.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>Equity</term>
+ <listitem>
+ <para>
+ Accounts of this type are used for Opening Balance Transactions in other
+ accounts. &kmymoney; automatically creates one account of this type and it
+ is rarely necessary to create another.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
- Select the currency to be used for the account from the dropdown list.
+ Select the currency to be used for the account from the dropdown list. The default
+ is the currency chosen when the data file was created.
</para>
<para>
@@ -357,14 +370,15 @@
</para>
<para>
- Enter the opening balance for the account. If this is an existing bank
- account, this information can be found on your statement. If it is a new
- account, the opening balance can be left at zero.
+ Enter the opening balance for the account. If this is an existing bank account,
+ this information can be found on your statement. If it is a new account, the
+ opening balance can be left at zero.
</para>
<para>
- Selecting the <emphasis>Preferred Account</emphasis> checkbox will allow
- preferred access in some dialogs and views of &kmymoney;.
+ Selecting the <emphasis>Preferred Account</emphasis> checkbox will allow preferred
+ access in some dialogs and views of &kmymoney;. This is also referred to as a
+ <quote>Favorite</quote> account.
</para>
<para>
@@ -377,21 +391,20 @@
<para>
When creating a Credit Card account, after entering the basic information and
- clicking <guibutton>Next</guibutton>, you can optionally have &kmymoney;
- create a <link linkend="details.schedules">scheduled transaction</link> for
- you.
+ clicking <guibutton>Next</guibutton>, you can optionally have &kmymoney; create a
+ <link linkend="details.schedules">Scheduled Transaction</link> for you.
</para>
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz6.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz6.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
@@ -420,25 +433,32 @@
Brokerage account.
</para>
+<para>
+ There have been many requests to let Investment accounts also hold cash, and this
+ will likely be possible in a future version of &kmymoney;, along with other things
+ not currently possible. However, this will involve a significant effort, and is
+ not expected in the near future.
+</para>
+
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz7.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz7.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- It is generally best to create the Brokerage account here, which will be given
- the same name as the Investment account, with "(Brokerage)" appended.
- Currently it is not possible to specify the opening date or balance for the
- Brokerage account at this point; you may do by editing the account details
- after the account has been created.
+ It is generally best to create the Brokerage account here, which will be given the
+ same name as the Investment account, with "(Brokerage)" appended. Currently it is
+ not possible to specify the opening date or balance for the Brokerage account at
+ this point; you may do by editing the account details after the account has been
+ created.
</para>
</sect2>
@@ -446,22 +466,22 @@
<title>Loan Accounts</title>
<para>
- Loan accounts are special accounts used to help you manage Loans with interest
- and scheduled repayments. By providing &kmymoney; with information about the
- loan, &kmymoney; can help you track interest payments and the remaining
- principal of the loan.
+ Loan accounts have special features to help you manage Loans with interest and
+ scheduled repayments. By providing &kmymoney; with information about the loan,
+ &kmymoney; can help you track interest payments and the remaining principal of the
+ loan.
</para>
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_1.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_1.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
@@ -470,32 +490,31 @@
</para>
<para>
- First, select whether you are borrowing or lending money. If you are
- borrowing money the loan will be listed in Accounts under Liabilities. If you
- are lending money the loan will be listed under Assets.
+ First, select whether you are borrowing or lending money. If you are borrowing
+ money the loan will be a Liability account. If you are lending money the loan will
+ be an Asset account.
</para>
<para>
- Next, select the payee or payer of the loan. As always, if the name doesn't
- yet exist in the Payees list, enter it here and &kmymoney; will create it for
- you.
+ Next, select the payee or payer of the loan. As always, if the name doesn't yet
+ exist in the Payees list, enter it here and &kmymoney; will create it for you.
</para>
<para>
- The next three items are for handling Loans on which you've already made
- payments. If you select <guibutton>Yes</guibutton> in the <guilabel>Did you make/receive any
- payments yet?</guilabel> dropdown, you can then select whether you want to
- record all payments or just those from the beginning of the current year. If
- you want to record from the beginning of the current year, you are than asked
- to input the balance at the beginning of this year.
+ The next three items are for handling Loans on which payments have already been
+ made, If you select <guibutton>Yes</guibutton> in the <guilabel>Did you
+ make/receive any payments yet?</guilabel> dropdown, you can then select whether you
+ want to record all payments or just those from the beginning of the current year.
+ If you want to record from the beginning of the current year, you are than asked to
+ input the balance at the beginning of this year.
</para>
<para>
- Next, select how often payments will be made and how often interest is
- compounded. Compounding is where the interest is added to the amount owed on
- the loan so that when the interest is next calculated there will be more
- interest paid on the interest. It's common for interest to be compounded at
- the same frequency that payments are made.
+ Next, select how often payments will be made and how often interest is compounded.
+ Compounding is where the interest is added to the amount owed on the loan so that
+ when the interest is next calculated there will be more interest paid on the
+ interest. It's common for interest to be compounded at the same frequency that
+ payments are made.
</para>
<para>
@@ -505,34 +524,32 @@
<para>
Finally, enter information about how the interest rate varies. If the loan is
fixed-rate there is nothing to do. If the rate varies, select Variable in
- <guilabel>Type of interest rate</guilabel> and then enter the interval
- between interest rate changes and the date the first change of interest rate
- is due: &kmymoney; will ask you to update the interest rate when that date
- arrives. Click <guibutton>Next</guibutton> to continue.
+ <guilabel>Type of interest rate</guilabel> and then enter the interval between
+ interest rate changes and the date the first change of interest rate is due:
+ &kmymoney; will ask you to update the interest rate when that date arrives. Click
+ <guibutton>Next</guibutton> to continue.
</para>
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_2.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_2.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- The Payments page is where you enter the payment and interest values for the
- loan.
+ The Payments page is where you enter the payment and interest values for the loan.
</para>
<para>
- First, select whether the interest rate is calculated when the payment is
- received or when it becomes due. If you don't know, leave it on the default
- value.
+ First, select whether the interest rate is calculated when the payment is received
+ or when it becomes due. If you don't know, leave it on the default value.
</para>
<para>
@@ -550,7 +567,11 @@
<varlistentry>
<term>Interest rate</term>
<listitem>
- <para>The annual percentage interest rate of the loan.</para>
+ <para>
+ The annual percentage interest rate of the loan. This must be a positive
+ number. If there is no interest, then the loan should be created as an Asset
+ or Liability account.
+ </para>
</listitem>
</varlistentry>
@@ -558,8 +579,7 @@
<term>Term</term>
<listitem>
<para>
- The length of the loan. Enter a number and select either Months or
- Years.
+ The length of the loan. Enter a number and select either Months or Years.
</para>
</listitem>
</varlistentry>
@@ -578,10 +598,9 @@
<term>Balloon payment</term>
<listitem>
<para>
- Additional final payment made at the end of the term to pay off the
- remaining principal of the loan. For a repayment loan this is often
- zero. For an interest-only loan this will be the same as the loan
- amount.
+ Additional final payment made at the end of the term to pay off the remaining
+ principal of the loan. For a repayment loan this is often zero. For an
+ interest-only loan this will be the same as the loan amount.
</para>
</listitem>
</varlistentry>
@@ -598,29 +617,29 @@
</para>
<para>
- If you omit one value, &kmymoney; will try to calculate it for you. If you
- have entered all values &kmymoney; will check the values are consistent.
- &kmymoney; will not adjust entered values other than the "Balloon payment",
- which it may adjust slightly to deal with rounding. If the values are
- inconsistent or &kmymoney; cannot calculate the omitted value, &kmymoney; will
- let you know so that you can correct any errors and repeat the calculation.
+ If you omit one value, &kmymoney; will try to calculate it for you. If you have
+ entered all values &kmymoney; will check the values are consistent. &kmymoney;
+ will not adjust entered values other than the "Balloon payment", which it may
+ adjust slightly to deal with rounding. If the values are inconsistent or
+ &kmymoney; cannot calculate the omitted value, &kmymoney; will let you know so that
+ you can correct any errors and repeat the calculation.
</para>
<para>
- Once the values are consistent, the <guibutton>Next</guibutton> button is
- enabled and you can advance to the next page.
+ Once the values are consistent, the <guibutton>Next</guibutton> button is enabled
+ and you can advance to the next page.
</para>
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_3.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_3.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
@@ -638,26 +657,26 @@
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_4.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_4.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- &kmymoney; will create a <link linkend="details.schedules">scheduled
- transaction</link> for your loan. The Schedule page is where you enter the
- remaining details needed to create the schedule.
+ &kmymoney; will create a <link linkend="details.schedules">Scheduled
+ Transaction</link> for your loan. The Schedule page is where you enter the
+ remaining details needed to create the Schedule.
</para>
<para>
- First enter the Category to which loan interest will be assigned. Then enter
- the account from which the loan payment will be made.
+ First enter the Category to which loan interest will be assigned. Then enter the
+ account from which or into which the loan payment will be made.
</para>
<para>
@@ -667,14 +686,14 @@
<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz8_5.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz8_5.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
@@ -710,33 +729,37 @@
<para>
<screenshot>
- <screeninfo>Parent Account</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz10.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Parent Account</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz10.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- This is the penultimate step in creating any new account except a loan.
- Depending on the type of account that is being created, a tree of your Asset
- or Liability accounts will be displayed.
+ This is the penultimate step in creating any new account except a loan. Depending
+ on the type of account that is being created, a tree of your Asset or Liability
+ accounts will be displayed. Most accounts are direct childred of the Asset or
+ Liability account type. However, most accounts may be created as subaccounts,
+ using another account as the parent. There is no financial impact of making an
+ account a subaccount; it is only used for organizing the hierarchical display of
+ accounts in the Institutions View of the Accounts View.
</para>
<para>
- The Parent Account page is not currently shown for Loans because they cannot
- be created as subaccounts. Also, Investment accounts cannot contain other
- accounts so they are not shown in the tree.
+ The Parent Account page is not currently shown for Loans because they cannot be
+ created as subaccounts. Also, Investment accounts cannot contain other accounts so
+ they are not shown in the tree.
</para>
<para>
- Select the account you wish contain the new account. If you do not select a
- parent account, the new account will be created at the top level.
+ Select the account you wish contain the new account. If you do not select a parent
+ account, the new account will be created at the top level.
</para>
</sect2>
@@ -746,29 +769,32 @@
<para>
<screenshot>
- <screeninfo>Review</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="accwiz9.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Account Wizard</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Review</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="accwiz9.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Account Wizard</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<para>
- This is the final step in creating a new account. A summary of the information
- entered is displayed. Review it, and if everything is OK press
- <guibutton>Finish</guibutton>. Otherwise, either press
- <guibutton>Back</guibutton> to make corrections or
- <guibutton>Cancel</guibutton> to abandon creating the new account.
+ This is the final step in creating a new account. A summary of the information
+ entered is displayed. Review it, and if everything is OK press
+ <guibutton>Finish</guibutton>. Otherwise, either press <guibutton>Back</guibutton>
+ to make corrections or <guibutton>Cancel</guibutton> to abandon creating the new
+ account.
</para>
-<note><para>
- The Type and Currency cannot at present be changed after the account is created.
-</para></note>
+<note>
+ <para>
+ The Currency cannot be changed after the account is created. The account type
+ can be changed, but only within a limited set of sufficiently similar type.
+ </para>
+</note>
</sect2>
</sect1>
@@ -776,13 +802,16 @@
<title>Opening / viewing accounts</title>
<para>
- To open an account in the Ledger View you can either click on the link to the
- account from the Home View, or click on the <guiicon><inlinemediaobject>
- <imageobject><imagedata fileref="ledgers_view.png" format="PNG"/></imageobject>
- </inlinemediaobject></guiicon> ledgers icon in the view selector and select the
- account in the drop down box at the top of the view. Alternatively, in the
- <guiicon>Account</guiicon> View, either double-click the account entry or
- right click and select <guimenuitem>Open ledger</guimenuitem>.
+ To open an account in the <link linkend="details.ledgers.view">Ledgers View</link>,
+ you can either click on the link to the account in the Home View, or you can click
+ on the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="ledgers_view.png"
+ format="PNG"/></imageobject></inlinemediaobject></guiicon> ledgers icon in the view
+ selector. If the account is not already displayed there, then click on the
+ <quote>+</quote> in the right-most tab and select the account in the drop down box
+ which appears. Alternatively, in the Accounts View or the Institutionss View,
+ either double-click the account name or right-click and select <guimenuitem>Open
+ ledger</guimenuitem>.
</para>
</sect1>
@@ -790,108 +819,149 @@
<title>Editing Account Information</title>
<para>
- To edit a particular account, right-click that account and choose
- <guimenuitem>Edit account...</guimenuitem> or with that account open in the
- ledger, select <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit
- Account...</guimenuitem></menuchoice>. A window will pop-up with several
- tabs, each allowing you to view and change certain information about the
- account. For more information on any of these details, see the section on
- <link linkend="details.accounts.create">creating a new account</link>.
+ To edit a particular account, right-click the account name in the Accounts View or
+ the Institutions View and choose <guimenuitem>Edit account...</guimenuitem> or with
+ that account open in the ledger, select
+ <menuchoice><guimenu>Account</guimenu><guimenuitem>Edit
+ Account...</guimenuitem></menuchoice>. A window will pop-up with several tabs, each
+ allowing you to view and change certain information about the account. For more
+ information on any of these details, see the section on <link
+ linkend="details.accounts.create">creating a new account</link>.
</para>
<para>
<screenshot>
- <screeninfo>Edit an account</screeninfo>
-
- <mediaobject>
- <imageobject>
- <imagedata fileref="account_edit.png" format="PNG" />
- </imageobject>
-
- <textobject>
- <phrase>Edit account information</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>Edit an account</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="account_edit.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Edit account information</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
<formalpara><title>General</title>
<para>
- View the general information about the account, and change the name,
- start or opening date, as well as some of the other basic settings
- of the account.
+ View the general information about the account, and change the name, start or
+ opening date, as well as some of the other basic settings of the account.
</para>
</formalpara>
<formalpara><title>Institution</title>
<para>
- View and change the associated banking institution and account
- numbers. You can also create a new institution here.
+ View and change the associated banking institution and account numbers. You can
+ also create a new institution here.
</para>
</formalpara>
<formalpara><title>Hierarchy</title>
<para>
-<!-- not ported to kde4 yet, uncomment if that is done,
- see https://bugs.kde.org/show_bug.cgi?id=272737
- You can change the parent account by dragging the account in this
- view of the account hierarchy. Changing the parent account is also
- possible in the main Accounts screen, by dragging the account and
- dropping it on a different parent account.
+<!-- not ported to kde4 or even 5 yet. uncomment if that is done, see
+ https://bugs.kde.org/show_bug.cgi?id=272737 You can change the parent account by
+ dragging the account in this view of the account hierarchy. Changing the parent
+ account is also possible in the main Accounts screen, by dragging the account
+ and dropping it on a different parent account.
-->
- You can change the parent account by clicking on another parent account in
- this view of the account hierarchy.
+ You can change the parent account by clicking the new parent account and then
+ clicking <guibutton>OK</guibutton>.
</para>
</formalpara>
<formalpara><title>Limits</title>
<para>
- This tab is only present for asset and liability accounts. If you
- enter amounts in the available fields, &kmymoney; will warn you when
- the account balance reaches those values.
+ This tab is only present for asset and liability accounts. If you enter amounts in
+ the available fields, &kmymoney; will warn you when the account balance reaches or
+ exceeds those values.
</para>
</formalpara>
<formalpara><title>Tax</title>
<para>
- Here you can check whether this is a VAT account, and whether to
- include this account on tax reports.
+ Here you can check whether this is a VAT account, and can specify the percentage of
+ the VAT. In additon, you can check whether to include this account on tax reports.
</para>
</formalpara>
<formalpara><title>Online Settings</title>
<para>
This tab is only be present if the account has been mapped to an <link
- linkend="details.impexp.ofxdirectconnect">online account</link>. It has
- three subtabs.
+ linkend="details.impexp.ofxdirectconnect">online account</link>. It has three
+ subtabs.
</para>
</formalpara>
<itemizedlist>
<listitem>
<para>
- <emphasis>Account Details</emphasis>: This shows the status of the
- online connection, the bank/broker and account number, and allows
- you to store or change the password for the online account.
+ <emphasis>Account Details</emphasis>: This shows the status of the online
+ connection, the bank/broker, and the account number. It also allows you to store
+ or change the password for the online account.
</para>
</listitem>
<listitem>
<para>
- <emphasis>OFX Details</emphasis>: Here you can adjust certain details
- &kmymoney; uses when it establishes an OFX connection with the
- institution. This should only be necessary if you get certain
- errors when you first set up the online account, or perhaps if your
- institution changes its OFX server software.
+ <emphasis>OFX Details</emphasis>: Here you can adjust certain details &kmymoney;
+ uses when it establishes an OFX connection with the institution. This should only
+ be necessary if you get certain errors when you first set up the online account, or
+ perhaps if your institution changes its OFX server software.
</para>
</listitem>
<listitem>
<para>
- <emphasis>Import Details</emphasis>: Here you can tell &kmymoney;
- what to use as the start date for the import. In addition, starting
- with version 4.6, you can choose whether the payee's name is based
- on the PAYEEID, NAME, or MEMO field of the imported transaction.
+ <emphasis>Import Details</emphasis>: In the upper box, you can tell &kmymoney; what
+ to use as the start date for the import. The lower box has several items
+ &kmymoney; uses when creating transactions from the downloaded data.
+ <itemizedlist>
+ <listitem>
+ <para>
+ You can choose whether the payee's name is based on the PAYEEID, NAME, or
+ MEMO field of the imported transaction. Different institutions use different
+ standards, so you may need to try a different value here if your imported
+ transactions seem to consistently have the wrong Payee.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Some banks do not follow the OFX standard of providing a repeatable, uniqe
+ FITID (Financial Institution Transaction Identification) which can cause
+ duplicate transactions on repeated downloads. If this happens, you can
+ change the method &kmymoney; uses to detect duplicates from the <guilabel>OFX
+ FITID</guilabel> to the internallly calculated <guilabel>KMyMoney
+ ID</guilabel>. This is not frequently necessary.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Importing transactions from an institution in a different timezone can
+ sometimes lead to the wrong date on an imported transaction. If this
+ happens, you can set a <guilabel>Timezone offset</guilabel> to adjust for the
+ difference.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ Very infrequently, an institution will create OFX downloads with the sign of
+ the transaction amount reversed. You can click this checkbox to correct this
+ problem.
+ </para>
+ </listitem>
+
+ <listitem>
+ <para>
+ A similar problem sometimes occurs, but only for the values in investment
+ transacionts, such as the purchase and sale of stocks. Clicking this
+ checkbox corrects this.
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
</listitem>
</itemizedlist>
@@ -901,25 +971,34 @@
<title>Deleting accounts</title>
<para>
- To delete an account, first remove all the transactions from that account in
- the ledger. Next, find the account in the accounts view and after right
- clicking on the entry to show the popup menu select <guimenuitem>Delete
- account...</guimenuitem> from the popup menu.
+ An account can only be deleted if it has no transactions in it, and is not referred
+ to by any other item in the data file. In general, this means you first need to
+ remove all the transactions from that account in the ledger. Then you can select
+ <menuchoice><guimenu>Account</guimenu><guimenuitem>Delete
+ account...</guimenuitem></menuchoice> or right-click the name in the Accounts View
+ and select <guimenuitem>Delete account...</guimenuitem> from the popup menu.
</para>
<para>
- If you are unable to delete an account which looks like it has no transactions
- in it, check your filter. See <menuchoice> <guimenu>Settings</guimenu>
- <guimenuitem>Configure &kmymoney;</guimenuitem>
- <guimenuitem>General</guimenuitem> <guimenuitem>Filter</guimenuitem>
- </menuchoice>. Clear all filters. Set the start date to 1.1.1900 or so.
+ If you are unable to delete an account which looks like it has no transactions in
+ it, there may be transactions which are not displayed in the ledger due to a filter
+ setting. See <menuchoice> <guimenu>Settings</guimenu>
+ <guimenuitem>Configure &kmymoney;...</guimenuitem>
+ <guimenuitem>General</guimenuitem> <guimenuitem>Filter</guimenuitem> </menuchoice>.
+ Clear all filters and set the start date to 1.1.1900 or so.
</para>
<para>
- There may be transactions in your ledger that are not shown, for example, if
+ There may also be transactions in your ledger that are not shown, for example, if
you have inadvertently typed in the wrong year when making an entry so that an
entry remains outside the opening date of &kmymoney;. This appears beneath the
ledger page as remaining funds.
</para>
+
+<para>
+ In some cases, you will be able to select <guimenuitem>Delete
+ account...</guimenuitem>, but will get a popup stating why &kmymoney; cannot delete
+ the account.
+</para>
</sect1>
</chapter>
diff --git a/doc/details-categories.docbook b/doc/details-categories.docbook
index 476121b22..d0cb6d871 100644
--- a/doc/details-categories.docbook
+++ b/doc/details-categories.docbook
@@ -4,58 +4,98 @@
<authorgroup>
<author>&Roger.Lum; &Roger.Lum.mail;</author>
<author>&Michael.Carpino; &Michael.Carpino.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2020-02-06</date>
- <releaseinfo>5.0.8</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>Categories</title>
<para>
- The Categories View provides a summary of all the existing categories in your
- current database. The categories are split into income and expense, sorted
- alphabetically, and shown along with the respective balance for each.
+ Internally, Categories are treated by &kmymoney; as a special type of account, so
+ many of the features of Categories are very similar to those of other Accounts.
</para>
+<sect1 id="details.categories.view">
+<title>Categories View</title>
+
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="categories.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+</para>
+
+<para>
+ The Categories View provides a summary of all the existing categories in your
+ current data file. Similar to the Accounts View, categories are grouped into
+ Income and Expense. As with the Institutions View and Accounts View, the list of
+ categories can be expanded or collapse by clicking on the arrow to the left of the
+ type or name. As with Asset and Liability Accounts, Categories can be considered
+ subcategories, with a parent of another category instead of the top-level Income or
+ Expense.
+</para>
+
+<para>
+ Similar to the Accounts View, the Categories View displays several columns with
+ descriptive and summary information about each category. As with the Accounts
+ View, you can select which columns are shown by right-clicking on any column
+ heading and selecting or unselecting the checkbox next to the name of the column.
</para>
+<para>
+ The columns available for Categories are identical to those for Accounts for Name,
+ Type, Tax, VAT, Balance, and Total Value. Online, Account Number, and IBAN are not
+ applicable to Categories. There is one additional column available.
+</para>
+
+<variablelist>
+ <varlistentry>
+ <term>CC</term>
+ <listitem>
+ <para>
+ An indication that a cost center assignment is necessary under certain
+ conditions when entering a transaction for this category. This is a recently
+ added feature, which is not yet implemented, so this column is not currently
+ used.
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
+</sect1>
+
<sect1 id="details.categories.create">
<title>Creating a category</title>
<para>
- There are 3 ways to create a new category: either select the
+ There are 3 ways to create a new category: select the
<menuchoice><guimenu>Category</guimenu><guimenuitem>New
- category</guimenuitem></menuchoice> menu item; select a parent in the tree
- in the Categories View, right-click and select the <guimenuitem>New
- Category</guimenuitem> option, or directly type the name of the new category
- when adding or editing a transaction in the Ledger. Doing any of these steps
- will direct you to the <guilabel>Create new Category</guilabel> dialog. The
- dialog contains three tabs: <guilabel>General</guilabel>,
- <guilabel>Hierarchy</guilabel>, and <guilabel>Tax</guilabel>. The General tab
- includes editable fields for the new category name, type, and currency (with
- the default currency preselected,) as well as options for Last check number,
- Notes, and a checkbox for Cost center assignment required. In the Hierarchy
- tab, you are able to select the appropriate parent account for the category.
- Finally, in the Tax tab, there are fields to enable and configure VAT support,
- and a checkbox to include this category in tax related reports.
-</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ category</guimenuitem></menuchoice> menu item, right-click a parent in the tree in
+ the Categories View and select the <guimenuitem>New Category</guimenuitem> option,
+ or directly type the name of the new category when adding or editing a transaction
+ in the Ledger. Doing any of these steps will direct you to the <guilabel>Create a
+ new Category</guilabel> dialog. This dialog contains three tabs:
+ <guilabel>General</guilabel>, <guilabel>Hierarchy</guilabel>, and
+ <guilabel>Tax</guilabel>. The General tab includes editable fields for the new
+ category name, type, and currency (with the default currency preselected,) as well
+ as options for Last check number, Notes, and a checkbox for Cost Center assignment
+ required. In the Hierarchy tab, you are able to select the appropriate parent for
+ the category. Finally, in the Tax tab, there are fields to enable and configure
+ VAT support, and a checkbox to include this category in tax related reports.
+</para>
+
+<para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="categoryedit.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
</sect1>
@@ -63,10 +103,10 @@
<title>Editing a Category</title>
<para>
- To edit a category, right-click on a category name, and choose
- <guimenuitem>Edit category</guimenuitem>. A window appears with the same
- three tabs as the new category dialog: General, Hierarchy and Tax. Each tab
- allows you to edit certain details of the category.
+ To edit a category, right-click on a category name in the Category View, and choose
+ <guimenuitem>Edit category...</guimenuitem>. A window appears with the same three
+ tabs as the <guilabel>Create a new Category</guilabel> dialog: General, Hierarchy,
+ and Tax. Each tab allows you to edit certain details of the category.
</para>
<para>
@@ -81,17 +121,14 @@
See https://bugs.kde.org/show_bug.cgi?id=272737
You can also change the parent category from the main category page by
dragging the category to a different parent. -->
- The Hierarchy tab allows you to change the parent category by clicking on
- another category in this view of the category hierarchy. In an earlier
- version of &kmymoney; it was possible to change the parent of a category by
- dragging and dropping. This functionality is expected to return in a future
- version of the application.
+ The Hierarchy tab allows you to change the parent of a category by clicking on
+ another category which then becomes the parent.
</para>
<para>
- The Tax tab allows you to assign or change VAT details, or to alter the
- automatic VAT assignment. It also allows the ability to toggle whether or not
- the category is included in tax related reports.
+ The Tax tab allows you to assign or change VAT details, or to alter the automatic
+ VAT assignment. It also allows you to toggle whether or not the category is
+ included in tax related reports.
</para>
</sect1>
@@ -142,16 +179,17 @@
<title>Deleting a category</title>
<para>
- To delete a category, select it in the tree, right click to bring up the popup
- menu, and select <guimenuitem>Delete</guimenuitem>. If the category has no
- transactions, schedules, or budgets associated with it, and it is not set as the
- default category for new transactions with any payee, it will be deleted.
+ Deleting a Category is similar to deleting an Account. To delete a category,
+ right-click its name in the Categories View, and select <guimenuitem>Delete
+ Category...</guimenuitem>. If the category has no transactions, schedules, or
+ budgets associated with it, and it is not set as the default category for new
+ transactions with any payee, it will be deleted.
</para>
<para>
- If the category has any of those items, a popup will be displayed allowing you
- to choose another category to which all those items can be reassigned before
- the category is deleted.
+ If the category has any of those items, a popup will be displayed allowing you to
+ choose another category to which all those items can be reassigned before the
+ category is deleted.
</para>
<para>
@@ -163,8 +201,8 @@
</para>
<para>
- Note that deleting some categories may prompt both for where to reassign its
- data and also whether or not to delete any sub-categories.
+ Note that deleting some categories may prompt both for where to reassign its data
+ and also whether or not to delete any sub-categories.
</para>
</sect1>
@@ -172,17 +210,12 @@
<title>Open ledger for a category</title>
<para>
- By right-clicking on any category there is an option to open a ledger for that
- category. You can also double-click on the category. When this option is
- selected &kmymoney; will display a ledger with all the transactions for the
- selected category. This allows you to quickly review all the transactions in
- detail for the selected category. You can then right-click on any transaction
- to obtain additional details about the specific transaction ultimately allowing
- any editing that may be required. Note that you cannot edit a transaction in
- the Category ledger; you need to switch to the ledger display for the other
- account, using one of the selections in the popup menu when you right click on
- the transaction.
-
+ The menu options for categories includes a choice to open a ledger for that
+ category. When this option is selected &kmymoney; will display that category in a
+ tab in the Ledgers View, showing all the transactions for the selected category.
+ This allows you to quickly review all the transactions in detail for the selected
+ category. You can then right-click on any transaction to obtain additional details
+ about the specific transaction, and can even edit the transaction.
</para>
</sect1>
</chapter>
diff --git a/doc/details-currencies.docbook b/doc/details-currencies.docbook
index ae6a1870e..d40bde825 100644
--- a/doc/details-currencies.docbook
+++ b/doc/details-currencies.docbook
@@ -57,12 +57,13 @@
<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. 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>.
</para>
</sect2>
</sect1>
diff --git a/doc/details-impexp-csv.docbook b/doc/details-impexp-csv.docbook
index 4d68e6730..a2ca1f667 100644
--- a/doc/details-impexp-csv.docbook
+++ b/doc/details-impexp-csv.docbook
@@ -445,9 +445,9 @@
</para>
<para>
- You can edit a symbol or security name by double clicking the cell. For
+ You can edit a symbol or security name by double-clicking the cell. For
each security, if necessary, edit the name in one of its rows, If the correct
- security name appears in the imported file, double click on it to select it,
+ security name appears in the imported file, double-click on it to select it,
then copy and paste/edit, taking care if you have used a variation or
abbreviation within &kmymoney;. If you edit a security name, that edit will
be applied to all rows with the same symbol.
@@ -478,7 +478,7 @@
all those symbol cells should still be selected, so click on one and enter the
symbol. Click inside the window but outside that column, or hit
&Enter; (not <guibutton>OK</guibutton>). Now that those
- transactions all have the same symbol, double click one detail entry and edit
+ transactions all have the same symbol, double-click one detail entry and edit
the security name as you wish. Click elsewhere on the window (or
&Enter;) to accept the edit, which will then change all
those entries. The remaining entries will show the symbols picked up from the
diff --git a/doc/details-impexp.docbook b/doc/details-impexp.docbook
index 7db3abeb7..992686e66 100644
--- a/doc/details-impexp.docbook
+++ b/doc/details-impexp.docbook
@@ -712,7 +712,7 @@
</para>
<para>
- Transaction data can be edited or even deleted if needed. To edit a transaction simply double click on the entry or hit enter when the entry is highlighted. Once finished click on <guibutton>OK</guibutton> to accept the imported transactions or <guibutton>Cancel</guibutton> to remove the imported transactions.
+ Transaction data can be edited or even deleted if needed. To edit a transaction simply double-click on the entry or hit enter when the entry is highlighted. Once finished click on <guibutton>OK</guibutton> to accept the imported transactions or <guibutton>Cancel</guibutton> to remove the imported transactions.
</para>
</sect2>
@@ -1072,7 +1072,7 @@
<para>
The first step is to configure each account for which you wish to download
- statements. Go to the Accounts view, right click on the account you wish to
+ statements. Go to the Accounts view, right-click on the account you wish to
configure, and choose <guimenuitem>Map to online account...</guimenuitem>.
In case more than one online banking plugin is installed on your system
you will be asked which one to use. For the internal OFX method select
diff --git a/doc/details-institutions.docbook b/doc/details-institutions.docbook
index f7de274d3..6bc73935e 100644
--- a/doc/details-institutions.docbook
+++ b/doc/details-institutions.docbook
@@ -33,7 +33,7 @@
<para>
The Institutions View displays several columns, showing information about the
account. It also shows the total value of all accounts in each institution. You
- can select which columns are shown by right clicking on any column heading and
+ can select which columns are shown by right-clicking on any column heading and
selecting or unselecting the checkbox next to the name of the column.
</para>
@@ -61,55 +61,6 @@
</listitem>
</varlistentry>
-<!-- not in Institutions View
- <varlistentry>
- <term>Type</term>
- <listitem>
- <para>
- The type of account, ⪚, Savings, Checking, Credit Card, ...
- </para>
- </listitem>
- </varlistentry>
--->
-
-<!-- not in Institutions View
- <varlistentry>
- <term>Tax</term>
- <listitem>
- <para>
- An indication whether this account has been configured as important for
- tax purposes.
- </para>
- </listitem>
- </varlistentry>
--->
-
-<!-- not in Institutions View
- <varlistentry>
- <term>VAT</term>
- <listitem>
- <para>
- An indication whether this account has been configured to apply a VAT on
- transaction.
- </para>
- </listitem>
- </varlistentry>
--->
-
-<!-- not in Institutions View
- <varlistentry>
- <term>CC (Cost Center)</term>
- <listitem>
- <para>
- An indication that a cost center assignment is necessary under certain
- conditions when entering a transaction for this account. This is a new
- feature, which is not yet implemented, so this column is not currently
- used.
- </para>
- </listitem>
- </varlistentry>
--->
-
<varlistentry>
<term>Balance</term>
<listitem>
@@ -119,17 +70,6 @@
</listitem>
</varlistentry>
-<!-- not in Institutions View
- <varlistentry>
- <term>Posted Value</term>
- <listitem>
- <para>
- This is the balance of the account as provided by the institution.
- </para>
- </listitem>
- </varlistentry>
--->
-
<varlistentry>
<term>Total Value</term>
<listitem>
@@ -140,17 +80,6 @@
</listitem>
</varlistentry>
-<!-- not in Institutions View
- <varlistentry>
- <term>Number</term>
- <listitem>
- <para>
- The account number, if one was entered.
- </para>
- </listitem>
- </varlistentry>
--->
-
<varlistentry>
<term>IBAN</term>
<listitem>
@@ -186,18 +115,8 @@
</para>
</listitem>
</varlistentry>
-
</variablelist>
-<!-- FIXME: confirm no longer true.
-<para>
- Note that many of these same columns are also available in other views, such
- as the Accounts View. When you select or unselect a checkbox to display or
- remove a column, you will see a popup asking if you want to show or remove
- that column from all other views where it is present. If you check "No," you
- will only change the display of that column in the current view.
-</para>
--->
</sect1>
<sect1 id="details.institutions.institution">
diff --git a/doc/details-investments.docbook b/doc/details-investments.docbook
index 0eab3fd2f..e951c9272 100644
--- a/doc/details-investments.docbook
+++ b/doc/details-investments.docbook
@@ -3,10 +3,7 @@
<chapterinfo>
<authorgroup>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
- <author>
- <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
- <email>mfcarpino at gmail.com</email>
- </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
<date>2019-12-30</date>
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index eba56a5cf..b30320f16 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -4,13 +4,11 @@
<authorgroup>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
<author> &Roger.Lum; &Roger.Lum.mail; </author>
- <author>
- <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
- <email>mfcarpino at gmail.com</email>
- </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2019-04-02</date>
- <releaseinfo>5.0.3</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>Ledgers</title>
@@ -413,7 +411,7 @@
action="simul">&Ctrl;&Ins;</keycombo>, or click
<guibutton>New</guibutton> at the foot of the window. The &Up;
and &Down; arrow keys let you navigate through the list. After
- pressing &Enter; or double clicking on an entry, the transaction list displays
+ pressing &Enter; or double-clicking on an entry, the transaction list displays
the fields required to enter the transaction and waits for input.
</para>
@@ -521,10 +519,10 @@
<para>
To edit a transaction, select it in the list view and either click on
- <guibutton>Edit</guibutton> in the transaction form or right click on the
+ <guibutton>Edit</guibutton> in the transaction form or right-click on the
entry and select <guimenuitem>Edit</guimenuitem> from the popup menu. If you
are editing transactions directly in the list you can edit the transaction
- simply by double clicking on an entry or by pressing &Enter; when a
+ simply by double-clicking on an entry or by pressing &Enter; when a
transaction is highlighted.
</para>
</sect1>
@@ -533,7 +531,7 @@
<title>Deleting transactions</title>
<para>
- To delete a transaction, select it in the list view, right click on the entry,
+ To delete a transaction, select it in the list view, right-click on the entry,
and select <guimenuitem>Delete</guimenuitem> from the popup menu when it
appears, or click <guibutton>Delete</guibutton> on the transaction form.
</para>
@@ -575,7 +573,7 @@
combine the two transactions together. The values of both transactions must be
the same for the match to work, except that the dates may differ by the window
specified in the settings, as described above. If you are happy with the
- result, right click the matched transaction, then select
+ result, right-click the matched transaction, then select
<guibutton>Accept</guibutton>.
</para>
diff --git a/doc/details-payees.docbook b/doc/details-payees.docbook
index a020a4016..9830ba090 100644
--- a/doc/details-payees.docbook
+++ b/doc/details-payees.docbook
@@ -4,77 +4,86 @@
<authorgroup>
<author> &Roger.Lum; &Roger.Lum.mail; </author>
<author> &Ace.Jones; &Ace.Jones.mail; </author>
- <author>
- <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
- <email>mfcarpino at gmail.com</email>
- </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2019-06-24</date>
- <releaseinfo>5.0.5</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>Payees</title>
<para>
- The Payees View provides detailed information about all the payees and payers
- involved in transactions. These are the entities to and from which you
- transfer money. &kmymoney; stores information about all the payees and payers
- from all existing transactions. This makes it possible to pick a payee from a
- list instead of having to type the full name, which also decreases the chance
- of misspelling or typing the wrong name.
+ Payees represent people or organizations to whom you give money. Payers are those
+ from whom you receive money. They are handled identically in &kmymoney; and are
+ only distinguished by the direction in which the money moves. It is possible for a
+ single person or organization to be both a Payee and a Payer. An example is your
+ employer, who pays you money as a salary, but whom you might pay money when you eat
+ lunch in the cafeteria at work. It is completely your choice whether to use the
+ same Payee for both of these transaction types, or to create a separate Payee and
+ Payer, if you want to track them separately.
</para>
+<sect1 id="details.payees.view">
+<title>Payees View</title>
+
<para>
- The Payees View is split into two main areas: a payees and payers list on the
- left, and a detail area on the right. The <guilabel>Your payees</guilabel>
- section allows for adding, deleting, renaming, and merging payees. The detail
- area has several tabs, showing the transactions, address, matching
- information, default category, and account numbers for the payee selected in
- the list.
+ The Payees View provides detailed information about all the payees and payers
+ involved in transactions. &kmymoney; stores information about all the payees and
+ payers from all existing transactions. This makes it possible to pick a payee from
+ a list instead of having to type the full name, which also decreases the chance of
+ misspelling or typing the wrong name.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="payeeview.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
-<sect1 id="details.payees.list">
-<title>Payees List</title>
+<para>
+ Like the Tags View, the Payees View is split into two main areas: a payees and payers list on the
+ left, and a detail area on the right.
+</para>
<para>
- The list of all payees and payers in your data is shown on the left side of
- this view. The payee list is sorted alphabetically.
+ The <guilabel>Your payees</guilabel> section displays a list of all payees defined
+ in your data file. The the top are buttons for adding, renaming, deleting, and
+ merging payees. Each of these is described below.
+</para>
+
+<para>
+ The details area has several tabs: transactions, address, matching, default
+ category, and account numbers. Each of these is described in the following
+ sections.
</para>
<sect2>
<title>Adding a Payee or Payer</title>
-
<para>
- To add a payee or payer, choose <guibutton>+New</guibutton>. This creates a
- new payee called <quote>New Payee</quote>. You can also right-click on any
- existing payee and select <guimenuitem>Add payee</guimenuitem>.
+ To add a payee or payer, click the <guibutton>+</guibutton> New Payee button.<!--
+ FIXME: use proper icon from button --> This creates a new payee called <quote>New
+ Payee</quote>. You can also right-click on any existing payee and select
+ <guimenuitem>Add payee</guimenuitem>.
</para>
</sect2>
<sect2>
<title>Renaming a Payee or Payer</title>
-
<para>
- To rename a payee or payer, either double-click on the name or right-click on
- the name and select <guimenuitem>Rename payee</guimenuitem>. The name then
- becomes editable. Changing the name will affect the name in all the
- transactions in which it appears.
+ To rename a payee or payer, either double-click on the name or right-click on the
+ name and select <guimenuitem>Rename payee</guimenuitem>. The name then becomes
+ editable. Changing the name will affect the name in all the transactions in which
+ it appears.
</para>
</sect2>
<sect2>
<title>Deleting a Payee or Payer</title>
-
<para>
To remove a payee or payer, right-click the name and select
<guimenuitem>Delete payee</guimenuitem>. If the payee has any transactions,
@@ -85,38 +94,74 @@
clicking <guibutton>Del</guibutton>.
</para>
</sect2>
+
+<sect2 id="details.payees.merging">
+<title>Merging Payees</title>
+<para>
+<!-- FIXME: write something here -->You can merge payees.
+</para>
+</sect2>
</sect1>
-<sect1 id="details.payees.personalinformation">
+<sect1 id="details.payees.transactionhistory">
+<title>Viewing Transactions for a Payee</title>
+
+<para>
+ To view all transactions associated with a particular payee, select the payee from
+ the list and select the <guilabel>Transactions</guilabel> tab in the details area.
+ Double-clicking a particular transaction will allow you to edit that transaction in
+ the context of the appropriate account. Right-clicking on a transaction will pop
+ up a context menu with appropriate actions, including the ability to go directly to
+ the ledger of the appropriate account, with that transaction selected.
+</para>
+
+<para>
+ <screenshot>
+ <screeninfo>The transaction tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payee_history.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Transaction history</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
+</para>
+</sect1>
+
+<sect1 id="details.payees.details">
<title>Additional Payee Details</title>
<sect2>
-<title>Personal Information</title>
+<title>Payee Personal Information</title>
<para>
To view and edit the personal information associated with a particular payee,
- select the payee from the list and select the Address tab. Along with address
- information you can also store a telephone number, email address, and notes
- pertaining to the selected payee. To modify this information, edit the detail
- area directly and press the Update button when finished.
+ select the payee from the list and select the Address tab. Although we call this
+ personal information, it is also applicable if the payee is a corporation or other
+ organization. Along with address information you can also store a telephone
+ number, email address, and notes pertaining to the selected payee. To modify this
+ information, edit the detail area directly and press the
+ <guibutton>Update</guibutton> button when finished.
</para>
<para>
<screenshot>
- <screeninfo>The personal information tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="payee_info.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Personal information</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>The personal information tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payee_info.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Personal information</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
</sect2>
-<sect2 id="details.payees.personalinformation.matching">
+<sect2 id="details.payees.details.matching">
<title>Transaction Matching Settings</title>
<sect3>
@@ -124,64 +169,64 @@
<para>
&kmymoney; has the ability to automatically assign the proper payee to imported
- transactions. This can be handy when importing transactions from your bank,
- when the payee name has extra unnecessary characters, or worse, if the payee
- names change. The ability to match transactions to a particualar payee assists
- in providing a consist naming of payees within the ledger and reports.
+ transactions. This can be handy when importing transactions from your bank, when
+ the payee name has extra unnecessary characters, or worse, if the payee names
+ change. The ability to match transactions to a particualar payee assists in
+ providing a consist naming of payees within the ledger and reports.
</para>
<para>
- For example, let's say your monthly mortgage payment comes in from your bank
- like this <quote>SUN TRUST BANK MAPLE VALLEY, GA 111506</quote> one month and
- then <quote>SUN TRUST BANK MAPLE VALLEY, GA 121606</quote> the next month. You
- would really like both of those transactions to be assigned to your payee
- <quote>Sun Trust</quote>. The transaction matching feature is for you!
+ For example, let's say your monthly mortgage payment comes in from your bank like
+ this <quote>SUN TRUST BANK, MAPLE VALLEY, GA 111506</quote> one month and then
+ <quote>SUN TRUST BANK MAPLE VALLEY, GA 121606</quote> the next month. You would
+ really like both of those transactions to be assigned to your payee <quote>Sun
+ Trust</quote>. In this case, the transaction matching feature is for you!
</para>
+</sect3>
+
+<sect3>
+<title>Setting up Payee Matching</title>
<para>
<screenshot>
- <screeninfo>The payee matching tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="payee_match.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Payee matching details</phrase>
- </textobject>
- </mediaobject>
+ <screeninfo>The payee matching tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="payee_match.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Payee matching details</phrase>
+ </textobject>
+ </mediaobject>
</screenshot>
</para>
-</sect3>
-
-<sect3>
-<title>Setting up</title>
<para>
- From the Matching tab, you can set the transaction matching settings. You can
- select one of four options with the <guilabel>Match method</guilabel>
- dropdown.
+ On the Matching tab, you can set the matching settings for transactions imported
+ for this payee. You can select one of four options with the <guilabel>Match
+ method</guilabel> dropdown.
</para>
<itemizedlist>
<listitem>
<para>
- No Matching. This disables the feature for this payee. This is the
- default setting for all payees.
+ <emphasis>No Matching</emphasis>: This disables the matching feature for this
+ payee. This is the default setting for all payees.
</para>
</listitem>
<listitem>
<para>
- Match Payees name (partial). This enables the feature based on a partial
- name matching of the Payee and and uses the payee name itself as the Match
- Key.
+ <emphasis>Match Payees name (partial)</emphasis>: This enables the feature
+ based on a partial name matching of the Payee and and uses the payee name
+ itself as the Match Key.
</para>
</listitem>
<listitem>
<para>
- Match Payees name (exact). This enables the feature based on an exact
- match of the Payee. You would use this matching ability when you want to
+ <emphasis>Match Payees name (exact)</emphasis>: This enables the feature based
+ on an exact match of the Payee. You might use this method when you want to
keep track of different Payees that have the same business name but have
different locations.
</para>
@@ -189,11 +234,17 @@
<listitem>
<para>
- Match on a name listed below. This enables matching based on multiple
- different or optional names for a Payee. You would use this matching
- ability when you have a particular Payee that has different business
- names but you want all imported transactions identified by any of those
- names to be associated with a single Payee in &kmymoney;.
+ <emphasis>Match on a name listed below</emphasis>: This enables matching based
+ on multiple different or optional names for a Payee. You would use this
+ matching ability when you have a particular Payee that has different business
+ names but you want all imported transactions identified by any of those names
+ to be associated with a single Payee in &kmymoney;.
+ </para>
+ <para>
+ Another use of this method is if you want a payee for "Other food stores" to
+ group all food stores other than the one or two you use often enough to want to
+ track separately. You would enter each of the different store's names on the
+ matching list, and all will then be matched to the same payee.
</para>
</listitem>
</itemizedlist>
@@ -209,46 +260,23 @@
<title>Importing Transactions</title>
<para>
- The Match Keys you have set will be considered whenever you import
- transactions using the QIF import, or using a plugin such as OFX or AqBanking,
- If the Match Key for one of your payees is found anywhere in the payee of the
- imported transaction, the corresponding payee from your list will be assigned
- to that transaction. Thus, a Match Key of <quote>Sun Trust</quote> will match
- <quote>SUN TRUST BANK MAPLE VALLEY,GA</quote> or even
- <quote>MORGEN SUN TRUST&LOAN</quote>. So choose your Match Keys carefully.
+ The Match Keys you have set will be considered whenever you import transactions
+ using the QIF import, or using a plugin such as OFX or AqBanking. If the Match Key
+ for one of your payees is found anywhere in the payee of the imported transaction,
+ the corresponding payee from your list will be assigned to that transaction. Thus,
+ a Match Key of <quote>Sun Trust</quote> will match <quote>SUN TRUST BANK MAPLE
+ VALLEY,GA</quote> or even <quote>MORGEN SUN TRUST&LOAN</quote>. So choose your
+ Match Keys carefully.
</para>
-<para><note>
- <para> If a transaction payee matches more than one Match Key, the behavior
- is undefined. &kmymoney; will arbitrarily pick one of the matching
- payees.</para>
-</note></para>
-</sect3>
-</sect2>
-</sect1>
-
-<sect1 id="details.payees.transactionhistory">
-<title>Viewing Transaction History</title>
-<para>
- To view all transactions associated with a particular payee, select the payee
- from the list and select the Transaction tab in the detail area.
- Double-clicking a particular transaction will bring you directly to that
- transaction in the Ledgers View for the appropriate account.
-</para>
+<note>
+ <para>
+ If a transaction payee matches more than one Match Key, the behavior is
+ undefined. &kmymoney; will arbitrarily pick one of the matching payees.
+ </para>
+</note>
-<para>
-<screenshot>
- <screeninfo>The transaction tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="payee_history.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Transaction history</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
-</para>
+</sect3>
+</sect2>
</sect1>
</chapter>
-
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index 81b024170..79900b9db 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -4,13 +4,11 @@
<authorgroup>
<author> &Roger.Lum; &Roger.Lum.mail; </author>
<author> &Michael.T.Edwardes; &Michael.T.Edwardes.mail; </author>
- <author>
- <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
- <email>mfcarpino at gmail.com</email>
- </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
+ <author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2019-04-01</date>
- <releaseinfo>5.0.3</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>Schedules</title>
@@ -19,44 +17,42 @@
<title>Introduction</title>
<para>
- <quote>
- Schedules maintain information about transactions that occur one or more
- times over a specified period of time.
- </quote>
+ Schedules maintain information about transactions that occur one or more times over
+ a specified period of time.
</para>
<para>
- Sometimes called a recurring transaction, a schedule provides a means to
- record information about a transaction that happen on a regular basis. You
- can schedule deposit, transfer, withdrawal, and loan transactions. There is
- a lot of flexibility built in with scheduling transactions that include doing
- it Once, or on a basis of number of Day(s), Week(s), Half-month(s), Month(s),
- or Year(s).
+ Sometimes called a scheduled transaction or a recurring transaction, a schedule
+ provides a means to record information about a transaction that happens on a
+ regular basis. You can schedule deposit, transfer, withdrawal, and loan
+ transactions. There is a lot of flexibility in schedules, including transactions
+ that occur Once, or on a basis of number of Days, Weeks, Half-months, Months, or
+ Years.
</para>
<para>
- Because you know these transactions are regularly made, whether they are
- payments made to you or payments you make to someone else, you can create a
- Schedule to record information about the recurring details to simplify and
- easily remember when the event will occur.
+ Because you know these transactions happen regularly, whether they are payments made
+ to you or payments you make to someone else, you can create a Schedule to record
+ information about the recurring details to simplify and easily remember when the
+ event will next occur.
</para>
<para>
- Schedules can be considered to reflect money coming in or out of your accounts
- on a consistent basis. Common uses include paychecks, taxes, insurance,
- credit cards, dues, interest, loans, mortgage, and rents. Scheduling a
- payment like these provides for a useful reminder so you can manage expected
- future financial matters effectively.
+ Schedules can be created to reflect money coming in or out of your accounts on a
+ consistent basis. Common uses include paychecks, taxes, insurance, credit card
+ payments, dues, interest, loans, mortgage, and rents. Scheduling a payment like
+ these provides for a useful reminder so you can manage expected future financial
+ matters effectively.
</para>
<para>
A schedule consists of two main parts: the transaction data and the scheduling
- data. The scheduling data records the occurrence of the schedule, &ie;, when
- the transaction is to be entered into the ledger and how. The transaction
- data records the normal details about the transaction. These include options
- for Payment method, Account, Pay to/from, Category, Tags, Memo, Due date,
- Amount and status. Along with this, you can also select additional options
- based on when to process the transaction.
+ data. The scheduling data records the occurrence of the schedule, &ie;, when the
+ transaction is to be entered into the ledger and how. The transaction data records
+ the normal details about the transaction, including options for Payment method,
+ Account, Pay to/from, Category, Tags, Memo, Due date, Amount, and Status. Along
+ with these, you can also select additional options based on when to process the
+ transaction.
</para>
</sect1>
@@ -64,102 +60,88 @@
<title>Types of schedules</title>
<para>
- There are four different types of schedules in the current version of
- &kmymoney;:
+ There are four different types of schedules in &kmymoney;:
</para>
-<itemizedlist>
- <listitem><para>Deposits</para></listitem>
- <listitem><para>Bills</para></listitem>
- <listitem><para>Transfers</para></listitem>
- <listitem><para>Loans</para></listitem>
-</itemizedlist>
-
-<sect2>
-<title>Deposit</title>
-
+<formalpara><title>Deposits</title>
<para>
- A Deposit is for money coming into your account, such as paychecks,
- bonuses, or interest income.
+ These schedules are for money coming into your account, such as a paycheck, bonus,
+ or interest income.
</para>
-</sect2>
-
-<sect2>
-<title>Bills/Withdrawals</title>
+</formalpara>
-<para>
- A Bill or Withdrawal is for money going out of your account, such as a
- membership, utility bill, taxes, or car registration.
+<formalpara><title>Bills/Withdrawals</title>
+<para>
+ These are for money going out of your account, such as a membership, utility bill,
+ taxe payment, or car registration.
</para>
-</sect2>
-
-<sect2>
-<title>Transfer</title>
+</formalpara>
+<formalpara><title>Transfer</title>
<para>
- A Transfer is for money going out of one account and into another,
- such as making a credit card payment from your checking account.
+ These are for money going out of one account and into another account, such as making a
+ credit card payment from your checking account.
</para>
-</sect2>
-
-<sect2>
-<title>Loans</title>
+</formalpara>
+<formalpara><title>Loans</title>
<para>
- A Loan Schedule is a special type of schedule and is created when dealing with a
- <link linkend="details.loans">Loan account</link>.
+ These are a special type of schedule, which is created when you create a <link
+ linkend="details.loans">Loan account</link>.
</para>
-</sect2>
+</formalpara>
</sect1>
<sect1 id="details.schedules.view">
<title>The Schedules View</title>
<para>
- Open the Schedules View by clicking on the <guiicon><inlinemediaobject><imageobject>
- <imagedata fileref="schedule_view.png" format="PNG"/></imageobject></inlinemediaobject>
- </guiicon> schedule icon in the view selector.
+ Open the Schedules View by clicking on the
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="schedule_view.png"
+ format="PNG"/></imageobject></inlinemediaobject></guiicon> Scheduled transactions
+ icon in the view selector.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="scheduleview.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>Schedule View</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
- The Schedules View consists of a view area with <guibutton>New
- Schedule</guibutton> button and <guibutton>Filter</guibutton> and
- <guilabel>Filter:</guilabel> text box above it.
+ The Schedules View consists of a sinngle display area with a <guibutton>New
+ Schedule...</guibutton> button and a <guilabel>Filter</guilabel> text box above it.
</para>
<para>
- To create a new schedule click on the button. For Deposit, Transfer, and Withdrawal/Bills
- schedules, &kmymoney; will display the new schedule dialog. Loan schedules are
- handled differently, as described in the Loans section of this manual.
+ To create a new schedule click on the <guibutton>New Schedule...</guibutton>
+ button. &kmymoney; will display the new schedule dialog, which can be used to
+ create a Deposit, Transfer, or Bill/Withdrawal schedule. Loan schedules are
+ handled differently, as described in the <link linkend="details.loans">Loans</link>
+ section of this manual.
</para>
</sect1>
<sect1 id="details.schedules.new">
<title>The New Schedule dialog</title>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="newsched_numbered.png" format="PNG" />
- </imageobject>
- <textobject>
+ </imageobject>
+ <textobject>
<phrase>New Schedule</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
@@ -182,49 +164,72 @@
<para>
Enter the name of the schedule and the date of the next occurrence into their
- respective fields. The name is how the schedule will be labelled in the
- Schedules View, and other displays. Specify how often the schedule should
- occur, using the Frequency field and drop down list. For example "every 6
- weeks" or "every 3 months." If the amount varies transaction to transaction
- make sure to check the <guilabel>Estimate</guilabel> checkbox and you will be
- prompted for the correct amount when it is entered into the ledger. The other
- required fields in the Payment information section include the Account and
- Category. The remaining fields in this section are optional.
+ respective fields. The name is how the schedule will be labelled in the Schedules
+ View and other displays. Specify how often the schedule should occur, using the
+ Frequency field and drop down list. For example "every 6 weeks" or "every 3
+ months." If the amount varies transaction to transaction make sure to check the
+ <guilabel>The amount is an estimate because it varies for each payment</guilabel>
+ checkbox in the <guilabel>Options</guilabel> area below, and you will be prompted
+ for the correct amount when it is entered into the ledger. The amount is entered
+ as a positive number in either the <guilabel>Payment</guilabel> or
+ <guilabel>Deposit</guilabel> field. The other required fields in this area are the
+ Account and the Category. The <guilabel>Status</guilabel> dropdown indicates the
+ state of the transaction when &kmymoney; enters it into the ledger. The remaining
+ fields in this section are optional.
</para>
</sect2>
<sect2>
<title>Modifying the Schedule Options section</title>
<para>
- You can choose how to handle non-processing days. If the schedule occurs on a
- non-processing day you can choose whether to <guilabel>Do not change the
- date</guilabel>, <guilabel>Change the date to the previous processing
- day</guilabel>, or <guilabel>Change the date to the next processing
- day</guilabel>. This option is available to replicate some of the real world
- banking operational processing. Non-processing days include weekends and
- holidays known to &kmymoney; for the region specified in the <link
- linkend="details.settings.schedules.calendar">appropriate configuration
- option</link>.
+ The <guilabel>If this schedule occurs on a non-processing date:</guilabel> dropdown
+ allows you to choose how to handle non-processing days. Non-processing days
+ include weekends and holidays known to &kmymoney; for the region specified in the
+ <link linkend="details.settings.schedules.calendar">appropriate configuration
+ option</link>. If the schedule occurs on a non-processing day you can choose
+ whether to <guilabel>Do not change the date</guilabel>, <guilabel>Change the date
+ to the previous processing day</guilabel>, or <guilabel>Change the date to the next
+ processing day</guilabel>. This option is available to replicate some of the real
+ world business operational processing.
</para>
<para>
- You can also select whether or not the amount is an estimate so you'll be
- prompted to update the amount when the schedule is due. Selecting the process
- at the last day of the month allows for scheduling for irregular month-end
- date processing. By checking the box for automatically enter when the it's due
- provides for &kmymoney; to enter the transaction into the ledger without human
- intervention. Otherwise, when the transaction is due to be entered,
- &kmymoney; will open a dialog box asking you to confirm that you want it to be
- entered. This behavior is configurable, and more information can be found in
- the <link linkend="details.settings.schedules">Settings</link> section.
+ The <guilabel>The amount is an estimate because is varies for each
+ payment</guilabel> checkbox allows you to select whether &kmymoney; automatically
+ enters that amount into the ledger or prompts you for the actual amount when the
+ schedule is due.
</para>
<para>
- If you know how many transactions are left or when they are due to finish,
- this information can be entered so the transactions are not entered
- indefinitely. Checking the schedule will end box and enter either the number
- of transactions remaining or date of final transaction will end the scheduled
- transaction based on this criteria.
+ The <guilabel>Do not change amount of category but modify exchange rate of
+ transaction</guilabel> checkbox can be used when the schedule involves an account
+ and a category with different currencies. If it is not selected, the amount
+ specified is used when the transaction is entered into the ledger. Checked the box
+ tells &kmymoney; that the amount is specified in the currency of the category. You
+ will still need to confirm the other value or the conversion rate when the
+ transaction is entered into the ledger.
+ <!-- FIXME: confirm what this really does. -->
+</para>
+
+<para>
+ The <guilabel>Process this schedule always at the last day of the month</guilabel>
+ checkbox allows for scheduling for irregular month-end date processing.
+</para>
+
+<para>
+ The <guilabel>Enter this schedule into the register automatically when it is
+ due</guilabel> checkbox tells &kmymoney; to enter the transaction into the ledger
+ on the correct date without human intervention. Otherwise, when the transaction is
+ due to be entered, &kmymoney; will open a dialog box asking you to confirm that you
+ want it to be entered. This behavior is configurable, and more information can be
+ found in the <link linkend="details.settings.schedules">Settings</link> section.
+</para>
+
+<para>
+ If you know the schedule will not continue indefinitely, check the <guilabel>This
+ schedule will end at some time</guilabel> and you can enter either the
+ <guilabel>Number of transactions remaining:</guilabel> or the <guilabel>Date of
+ final transaction</guilabel>.
</para>
<para>
@@ -232,17 +237,16 @@
<guibutton>OK</guibutton> to continue.
</para>
</sect2>
-
</sect1>
<sect1 id="details.schedules.edit">
<title>Editing schedules</title>
<para>
- To edit a schedule simply select the entry in the list and right click to
- bring up the context menu and select <guimenuitem>Edit scheduled transaction</guimenuitem>. This
- will bring up a dialog similar to the Edit Schedule transaction dialog, where you can update
- the necessary data.
+ To edit a schedule simply select the entry in the list, then right-click and select
+ <guimenuitem>Edit scheduled transaction</guimenuitem> in the context menu. This
+ will bring up a dialog similar to the <guilabel>New Scheduled
+ transaction</guilabel> dialog, where you can update the necessary data.
</para>
</sect1>
@@ -250,8 +254,9 @@
<title>Deleting schedules</title>
<para>
- To delete a schedule simply select the entry in the list and right click to
- bring up the context menu and select <guimenuitem>Delete scheduled transaction</guimenuitem>.
+ To delete a schedule simply select the entry in the list, then right-click and
+ select <guimenuitem>Delete scheduled transaction</guimenuitem>. in the context
+ menu.
</para>
</sect1>
@@ -259,8 +264,9 @@
<title>Duplicating schedules</title>
<para>
- To duplicate a schedule simply select the entry in the list and right click to
- bring up the context menu and select <guimenuitem>Duplicate scheduled transaction</guimenuitem>.
+ To duplicate a schedule simply select the entry in the list, then right-click and
+ select <guimenuitem>Duplicate scheduled transaction</guimenuitem> in the context
+ menu.
</para>
</sect1>
@@ -268,76 +274,70 @@
<title>Entering scheduled transactions</title>
<para>
- Entering a scheduled transaction means actually entering a transaction into
- the appropriate ledger, using the details specified in the schedule.
- Scheduled transactions can be entered in one of 3 different ways:
+ Entering a scheduled transaction means actually enteringcreating a transaction in
+ the appropriate ledger, using the details specified in the schedule. Scheduled
+ transactions can be entered in one of 3 different ways:
</para>
<itemizedlist>
<listitem>
<para>
- Manually by right clicking on the entry in the Schedules View</para>
+ Manually, by right-clicking on the entry in the Schedules View and selecting
+ <guilabel>Enter next transaction</guilabel> in the context menu.
+ </para>
</listitem>
<listitem>
<para>
- &kmymoney; can enter them with or without your interaction upon startup
+ &kmymoney; can enter them with or without your interaction upon startup.
</para>
</listitem>
<listitem>
<para>
- &kmymoney; can enter them with your interaction during online banking or
- import of an electronic bank statement
+ &kmymoney; can enter them with your interaction during online banking or when
+ you import a bank statement.
</para>
</listitem>
</itemizedlist>
-<sect2>
-<title>Manually entering scheduled transactions</title>
-
-<para>
- You can enter a scheduled transaction manually by right clicking on the list
- entry and selecting <guimenuitem>Enter</guimenuitem> from the popup menu.
-</para>
-</sect2>
-
<sect2>
<title>Confirming the transaction to enter</title>
<para>
- After selecting either method the Enter Scheduled Transaction dialog window is
- shown prompting you with the required information that was entered when you
- created the schedule.
+ The first and third methods will display an <guilabel>Enter scheduled
+ transaction</gui> dialog (possibley after displaying an informational window about
+ the process.) This dialog prompts you to confirm or update the required
+ information that was entered when you created the schedule.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="enterschedule.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
- This information can be changed, and the changes can be applied to just this
- one instance of the schedule or to all subsequent transactions. After
- checking that all the data is correct clicking <guibutton>OK</guibutton>
- will add the transaction to the ledger and update the next due date of the
- schedule to the next occurrence. If you have changed any of the transaction
- data a further confirmation of what you changed will be displayed, giving you
- a final chance to accept or reject the changes.
+ This information can be changed, and the changes can be applied to just this one
+ instance of the schedule or to all subsequent transactions. After checking that
+ all the data is correct clicking <guibutton>OK</guibutton> will add the transaction
+ to the ledger and update the next due date of the schedule to the next occurrence.
+ If you have changed any of the transaction data a further confirmation of what you
+ changed will be displayed, giving you a final chance to accept or reject the
+ changes.
</para>
<para>
- <screenshot>
- <mediaobject>
- <imageobject>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
<imagedata fileref="confirmenter.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</para>
<para>
@@ -350,23 +350,21 @@
<title>Letting &kmymoney; enter the scheduled transaction(s) for you</title>
<para>
- Alternatively, &kmymoney; can check which schedules are due upon startup and
- enter them for you if the appropriate option was checked when setting up the
- schedule.
+ Alternatively, &kmymoney; can check which schedules are due upon startup and enter
+ them for you if the appropriate option was checked when setting up the schedule.
</para>
<para>
- If the option was not checked then &kmymoney; will open the previously
- mentioned dialog and you can follow the steps mentioned there. &kmymoney;
- will also open the dialog if the amount is an estimate so you can enter the
- real amount.
+ If the option was not checked then &kmymoney; will open the previously mentioned
+ dialog and you can follow the steps mentioned there. &kmymoney; will also open the
+ dialog if the amount is an estimate so you can enter the actual amount.
</para>
<para>
- You can also opt to have &kmymoney; not check which transactions are scheduled
- on startup by deselecting the option in the Settings dialog and any overdue
- transaction or transactions due 'today' will be shown in the Home view for you
- to enter manually.
+ You can also opt to have &kmymoney; not check which transactions are scheduled on
+ startup by deselecting the option in the Settings dialog and any overdue
+ transaction or transactions due 'today' will be shown in the Home view for you to
+ enter manually.
</para>
</sect2>
</sect1>
diff --git a/doc/details-search.docbook b/doc/details-search.docbook
index 422a8993c..051dfeaab 100644
--- a/doc/details-search.docbook
+++ b/doc/details-search.docbook
@@ -329,7 +329,7 @@
<para>
The <quote>Result</quote> tab displays the Date, Account, Details,
Reconciliation status, Payment, and Deposit for each transaction
- that matches the search criteria you have entered. Right clicking
+ that matches the search criteria you have entered. Right-clicking
on the header row of the results list allows you to alter the sort
order of the results.
</para>
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index 327b173fb..1827c450b 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -3,14 +3,11 @@
<chapterinfo>
<authorgroup>
<author> &Roger.Lum; &Roger.Lum.mail; </author>
- <author>
- <personname><firstname>Michael</firstname><surname>Carpino</surname></personname>
- <email>mfcarpino at gmail.com</email>
- </author>
+ <author>&Michael.Carpino; &Michael.Carpino.mail;</author>
<author> &Jack.H.Ostroff; &Jack.H.Ostroff.mail; </author>
</authorgroup>
- <date>2019-03-31</date>
- <releaseinfo>5.0.3</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>&kmymoney; Settings</title>
@@ -536,7 +533,7 @@ of accounts.</para>
You can adjust the relative order of the fields by selecting one and adjusting
its position in the list using the up and down arrows to the right of the
list. You can switch between ascending and descending sort for any item
- by double clicking on it.
+ by double-clicking on it.
</para>
<para>
The fields available for sorting are the same for all three sections: Amount,
@@ -609,11 +606,10 @@ of accounts.</para>
<term><guilabel>Match names from start</guilabel></term>
<listitem>
<para>This option controls <link
- linkend="details.payees.personalinformation.matching">payee
- matching.</link> When enabled, payee names will always be matched from the
- start. When disabled, any substring will be matched. Also, when enabled
- additional options for matching can be established in the Matching Tab of
- the Payees View.</para>
+ linkend="details.payees.details.matching">payee matching</link>. When enabled,
+ payee names will always be matched from the start. When disabled, any
+ substring will be matched. Also, when enabled additional options for matching
+ can be established in the Matching Tab of the Payees View.</para>
</listitem>
</varlistentry>
diff --git a/doc/details-tags.docbook b/doc/details-tags.docbook
index bb484d9c7..92d39a666 100644
--- a/doc/details-tags.docbook
+++ b/doc/details-tags.docbook
@@ -5,53 +5,68 @@
<author>&Cristian.Onet; &Cristian.Onet.mail;</author>
<author>&Michael.Carpino; &Michael.Carpino.mail;</author>
</authorgroup>
- <date>2020-02-06</date>
- <releaseinfo>5.0.8</releaseinfo>
+ <date>2023-08-30</date>
+ <releaseinfo>5.2.0</releaseinfo>
</chapterinfo>
<title>Tags</title>
<para>
- The Tags View provides information about all the tags that have been added by
- the user. The Tags screen is split into two main areas: a list of tags and a
- detail area, which has two tabs: Transactions and Details. The
- <guilabel>Transactions</guilabel> tab displays all the transactions associated
- with the tag. The <guilabel>Details</guilabel> tab includes a user-defined
- color, as well as Notes, which are not used elsewhere. Note that if you
- change the color, which is used in the symbol displayed before the tag name in
- any associated transactions, you need to click the check button at the lower
- right of the Details area for it to be saved.
- </para>
-
-<sect1 id="details.tags.list">
-<title>Tags List</title>
+ Tags provide an additional way for you to group and categorize transactions. They
+ are often useful in <link linkend="details.search.general">searching for
+ transactions</link> and for <link linkend="details.reports.avail">creating
+ reports</link>.
+</para>
-<para>
- A list of all tags, sorted alphabetically, is displayed on the left side of
- this screen.
+<sect1 id="details.tags.view">
+<title>Tags View</title>
+<para>
<screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="tags.png" format="PNG" />
- </imageobject>
- </mediaobject>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tags.png" format="PNG" />
+ </imageobject>
+ </mediaobject>
</screenshot>
</para>
+<para>
+ The Tags View provides information about all the tags that have been added to the
+ data file. The display is split into two areas.
+</para>
+
+<sect2 id="details.tags.list">
+<title>Tags List</title>
+
+<para>
+ On the left is a list of tags, with buttons for adding, renaming, or deleting a tag.
+</para>
+
+<para>
+ On the right you can see more detailed information about the tag selected in the
+ list on the left, in one of the two tabs: Transactions and Details. The
+ <guilabel>Transactions</guilabel> tab displays all the transactions associated with
+ the tag. The <guilabel>Details</guilabel> tab includes a user-selectable color, as
+ well as Notes, which are not used elsewhere. Note that if you change the color,
+ which is used in the symbol displayed before the tag name in any associated
+ transactions, you need to click the <guibutton>Update</guibutton> button at the
+ lower right of the Details area for it to be saved.
+</para>
+</sect2>
+
<sect2>
<title>Adding a Tag</title>
<para>
- There are three different ways to create a new tag. First, you can click on
- the <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="list-add.png"/></imageobject></inlinemediaobject></guiicon> new tag
- icon. Second, you can right-click on any tag and choose <guimenuitem>New
- tag</guimenuitem>. This creates a new tag called <quote>New tag.</quote>
- Right-click on this tag and select <guimenuitem>Rename tag</guimenuitem> to
- enter the name of the new tag. Finally, you can add a new tag directly into
- the ledger page or within a split transaction by typing the name of the tag in
- the tag field. &kmymoney; will ask if you want to add this tag and after
- selecting <quote>yes</quote> it will be added.
+ As with most actions in &kmymoney;, there are multiple ways to create a new tag.
+ First, you can click on the <guiicon><inlinemediaobject><imageobject><imagedata
+ fileref="list-add.png"/></imageobject></inlinemediaobject></guiicon> new tag icon.
+ Second, you can right-click on any tag and choose <guimenuitem>New
+ tag...</guimenuitem>. This creates a new tag called <quote>New tag.</quote> See the
+ next section for how to rename the tag. Finally, you can add a new tag directly in
+ the ledger or within a split transaction by typing the name of the tag in the tag
+ field. &kmymoney; will ask if you want to add this tag and after selecting
+ <quote>yes</quote> it will be added.
</para>
</sect2>
@@ -59,29 +74,29 @@
<title>Renaming a Tag</title>
<para>
To rename a tag, either click on the tag name to select it and click on the
- <guiicon>Rename tag</guiicon> (between the add and remove icons) or
- right-click on the name and then select <guimenuitem>Rename tag</guimenuitem>.
- The name then becomes editable. Changing the name will affect the name in all
- the transactions in which it appears.
+ <guiicon>Rename tag</guiicon> icon <!-- FIXME: add icon for rename -->(between the
+ add and remove icons) or right-click on the name and then select
+ <guimenuitem>Rename tag</guimenuitem>. The name then becomes editable. Changing
+ the name will affect the name in all the transactions in which it appears.
</para>
</sect2>
<sect2>
<title>Deleting a Tag</title>
<para>
- To remove a tag, either click on the <guiicon><inlinemediaobject><imageobject><imagedata
- fileref="list-remove.png" format="PNG"/></imageobject></inlinemediaobject></guiicon>
- delete tag icon or right-click the name and select <guimenuitem>Delete tag</guimenuitem>.
- If the tag has any transactions, you will be presented with a dialog that allows you
- to reassign them to a different tag.
+ To delete a tag, either click on the
+ <guiicon><inlinemediaobject><imageobject><imagedata fileref="list-remove.png"
+ format="PNG"/></imageobject></inlinemediaobject></guiicon> delete tag icon or
+ right-click the name and select <guimenuitem>Delete tag</guimenuitem>. If the tag
+ has any transactions, you will be presented with a dialog that allows you to
+ reassign them to a different tag.
</para>
<note>
<para>
- As Tags were only introduced to &kmymoney; in version 4.7, none of the methods
- for importing data are able to import tags. It is understood that this is an
- important feature, and each import method is likely to introduce it in an
- upcoming release.
+ Tags were introduced to &kmymoney; in version 4.7, but not all of the methods for
+ importing data are able to import tags. It is understood that this is an important
+ feature, and it will eventually be added to all import methods
</para>
</note>
</sect2>
@@ -91,20 +106,22 @@
<title>Tagged transactions and Tag details</title>
<para>
To view the transactions or view and edit the information associated with a
- particular tag, select the tag from the list and select the appropriate tab on
- the right side of the dialog.
-
-<screenshot>
- <screeninfo>The tag details tab</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata fileref="tag_details.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Tag details</phrase>
- </textobject>
- </mediaobject>
-</screenshot>
+ particular tag, select the tag from the list and select the appropriate tab on the
+ right side of the dialog.
+</para>
+
+<para>
+ <screenshot>
+ <screeninfo>The tag details tab</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="tag_details.png" format="PNG" />
+ </imageobject>
+ <textobject>
+ <phrase>Tag details</phrase>
+ </textobject>
+ </mediaobject>
+ </screenshot>
</para>
<sect2 id="details.tags.info.transactions">
diff --git a/doc/firsttime.docbook b/doc/firsttime.docbook
index 84abb06c5..c7db417f2 100644
--- a/doc/firsttime.docbook
+++ b/doc/firsttime.docbook
@@ -545,7 +545,7 @@
To create an account using the Accounts View click on the <guiicon>
<inlinemediaobject><imageobject><imagedata fileref="accounts_view.png"
format="PNG"/></imageobject></inlinemediaobject></guiicon> accounts icon in
- the view selector to display the Accounts View. Right click on the either
+ the view selector to display the Accounts View. Right-click on the either
the Asset tree icon or the Liability tree icon in the display and select
<guimenuitem>New account</guimenuitem> from the popup menu. The Asset tree
holds all of your accounts that are assets, such as savings and investments.
diff --git a/doc/index.docbook b/doc/index.docbook
index 2ad157a15..696eecfdd 100644
--- a/doc/index.docbook
+++ b/doc/index.docbook
@@ -219,10 +219,10 @@ consistent documentation style across all KDE apps. -->
&details-loans;
&details-budgets;
&details-forecast;
-&details-settings;
&details-search;
&details-formats;
&details-database;
+&details-settings;
&faq;
&reference;
&credits;
More information about the kde-doc-english
mailing list