[kmymoney/5.0] doc: More doc updates for 5.x: payees and schedules
Jack Ostroff
null at kde.org
Tue Apr 2 20:36:53 BST 2019
Git commit 1d8fe6a1899acb45d491605c093b5ac1c66cb59e by Jack Ostroff.
Committed on 02/04/2019 at 17:18.
Pushed by ostroffjh into branch '5.0'.
More doc updates for 5.x: payees and schedules
More minor edits: settings and new png
Updated but not reviewed by me yet: ledgers
A +- -- doc/accessories-calculator.png
M +76 -71 doc/details-ledgers.docbook
M +77 -50 doc/details-payees.docbook
M +104 -176 doc/details-schedules.docbook
M +1 -1 doc/details-settings.docbook
https://commits.kde.org/kmymoney/1d8fe6a1899acb45d491605c093b5ac1c66cb59e
diff --git a/doc/accessories-calculator.png b/doc/accessories-calculator.png
new file mode 100644
index 000000000..1b1dd1e44
Binary files /dev/null and b/doc/accessories-calculator.png differ
diff --git a/doc/details-ledgers.docbook b/doc/details-ledgers.docbook
index eebc62d4f..fa60ba2c7 100644
--- a/doc/details-ledgers.docbook
+++ b/doc/details-ledgers.docbook
@@ -15,17 +15,18 @@
<title>The Ledger View</title>
<para>
- The Ledger view is where most of the functionality of &kmymoney; lies. This
- view is for examining and entering transaction data in the various
+ The Ledger view is functionaly the data intergration center of &kmymoney;. This
+ view is for entering, examining, deleting and editing transactions in your defined
accounts. The view is split into three main areas: the filter area, the
transaction list, and the input area.
</para>
<para>
This view allows for several key actions: searching and viewing transactions,
- entering new transactions, and editing or deleting existing
- transactions. Other functionality includes modifying account details and
- reconciling the account.
+ entering new and editing, duplicating, deleting and scheduling existing transactions.
+ Along with this it also provides the ability to move, mark and go to additional account
+ transaction details. Other functionality within the ledger view includes modifying
+ and reconciling the account.
</para>
<para>
@@ -51,7 +52,7 @@
<listitem>
<para>
The transaction input form, which may or may not appear, depending upon
- your configuration.
+ your configuration as selected in the Configure &kmymoney; Ledger section.
</para>
</listitem>
</itemizedlist>
@@ -73,19 +74,20 @@
</para>
<para>
- You can select an account via the account dropdown list at the top of the view
+ You can easily select any account via the account dropdown list at the top of the view
area. Note that depending upon the type of the account the <link
linkend="details.ledger.transactionform">transaction input form</link> at the
- bottom of the view changes.
+ bottom of the view may change.
</para>
<para>
To the right of the account dropdown list, are two additional fields. The
- search box acts as a filter on the transactions that are shown in the list
- view. Only transactions that include the text typed in the search box are
- displayed. The text specified can be in any of the fields of the transaction.
- The status field is a dropdown list. Only transactions of the type selected in
- that dropdown are displayed.
+ filter box acts provides the ability to search for matching transactions
+ that will be displayed in the list view. The text specified can be in any
+ of the fields of the transaction for the specific account. The status field
+ is a dropdown list. The status field list allows for the selection of:
+ Any status, Imported, Matched, Erroneous, Not marked, Not reconciled,
+ Cleared and scheduled transactions.
</para>
</sect2>
@@ -107,21 +109,21 @@
</para>
<para>
- After you have entered a transaction, it is displayed in the transaction list.
+ After a transaction has been entered, it is displayed in the transaction list.
You can also change transaction properties or even create new transactions
directly in the list. In the transactions list, the default arrangement of
transactions is sorted by date with the most recent transaction on the bottom.
Clicking the Right Mouse Button on the header of the transaction list brings
- up a dialog that allows you to change the sort order of the transactions. For
- instructions on how to change the default sort order, see the <link
+ up a dialog box that will allow the ability to change the sort order of the
+ transactions. For instructions on how to change the default sort order, see the <link
linkend="details.settings.register.sorting">Sorting tab</link> section of the
<link linkend="details.settings">&kmymoney; Settings</link> Chapter.
</para>
<para>
Note that the balance column is based on the currently displayed sort order,
- and will not be calculated if the display is filtered by the search box or
- transaction type dropdown, as described above.
+ and will not be calculated if the display is filtered by the searching within
+ the filter box or transaction type dropdown, as described above.
</para>
<para>
@@ -130,7 +132,7 @@
<formalpara><title>Last reconciled</title>
<para>
- This is the most recent date on which you reconciled this account.
+ This is the most recent date when you reconciled this account.
Reconciliation is an important process for many accounts, and is described
<link linkend="details.reconcile">here</link>.
</para>
@@ -174,9 +176,11 @@
<para>
There are two methods of entering transactions into the ledger: using the
- transaction input form and entering the data directly into the transaction
+ transaction input form or entering the data directly into the transaction
list. The transaction input form is displayed by default and this is the
- method we will discuss first.
+ method we will discuss first. Turning off the transaction form can be
+ accoumplished by going to the Ledger section in the Configure &kmymoney; that's
+ within the Settings.
</para>
<para>
@@ -205,14 +209,14 @@
<para>
The transaction input form at the bottom of the ledger view is the interface
- for creating transactions.
+ for manually creating transactions.
</para>
<para>
Depending upon the type or method of transaction you wish to enter there are
several tabs available on the transaction form. Click on the tab that best
- describes your transaction (deposit, transfer, or withdrawal) and the form
- will load several fields ready for your input.
+ defines your transaction (deposit, transfer, or withdrawal) and the form
+ will load several fields available for your input.
</para>
<para>
@@ -222,14 +226,14 @@
<para>
If you are unsure which method to choose simply use Deposit for any money
- going into the account, Withdrawal for money coming out of the account, and
+ coming into the account, Withdrawal for money going out of the account, and
Transfer for money moving from one account to another. The transaction
methods and the differences between them are discussed in more detail
elsewhere.
</para>
<para>
- Select the transaction method by clicking on one of the tabs.
+ Select the transaction method by clicking on the appropriate tab.
</para>
<sect2>
@@ -238,11 +242,12 @@
<para>
Enter the information using the following notes on the available fields. Note
that many fields have 'Auto Completion' turned on. That is, if you start
- typing, &kmymoney; will offer alternatives matching the characters you have
- entered so far. To select an entry click on it using the mouse or keyboard,
- or if your entry is not listed keep typing to add the new value. The next
- time you type the value in, &kmymoney; will find it for you after the first
- few characters have been input.
+ typing, &kmymoney; will offer alternatives matching the characters you begin
+ to enter. To select the matching content simply click on the entry by using
+ your mouse or selecting the appropriate keyboard keys. If the entry is not
+ listed finish typing the content to add the new value. The next time you type
+ the content, &kmymoney; will find it for you as you begin to enter the intial
+ characters.
</para>
<sect3>
@@ -251,8 +256,8 @@
<para>
The Payee is who the money came from/to. If the payee is a new entry
&kmymoney; will ask if you wish to add this to the list of Payees. Any other
- information related to a payee or payer, such as address details can be
- updated in the Payees view later.
+ information related to a payee or payer, such as address, phone number and account
+ number as well as notes can be updated in the Payees view.
</para>
</sect3>
@@ -262,16 +267,18 @@
<para>
The Category associates a transaction with an income or expense category for
accounting and reporting purposes, and enables you to group certain
- transactions. Type the name of the category into the required field. If you
+ transactions. Type the name of the category into the defined field. If you
have entered the category and it does not exist then &kmymoney; will ask if
- you want to create a new one.
+ you want to create a new one. If the selection is Yes &kmymoney; will then
+ open a dialog box that allows for the further definiton of the category based
+ on General, Heirarchy and Tax characteristics.
</para>
<para>
If you wish to associate parts of the transaction with different categories,
- &kmymoney; can let you do that. An example transaction might be a cash
- machine withdrawal of 50 of which you use 10 on food, 20 on beer and 20 as
- spare cash. The transaction will therefore be assigned three categories:
+ &kmymoney; can handle this need. An example transaction might be a cash
+ withdrawal of 50 of which you use 10 on food, 20 on beer and 20 as
+ cash. The transaction will therefore be assigned three categories:
Food, Beer, and Cash. To do this, you need to use <link
linkend="details.ledgers.split">Split Transactions</link>, which is described
in more detail below.
@@ -287,12 +294,14 @@
<title>The Tag</title>
<para>
- Tags were introduced to &kmymoney; in version 4.7, and they are not yet fully
- documented in this handbook. Tags are similar to Categories, and can be used
- to maintain an orthogonal view to Categories. For example, you might have
- a Category for each different type of automotice expenses, and then have a Tag
- for each vehicle. As with Categories, you can select from the dropdown list, or type
- a new Tag name, and be prompted if you want to create a new Tag with that name.
+ Tags are similar to Categories, and can be used to maintain an orthogonal view
+ to Categories. They provide the ability to group transactions within a Category based
+ on your defined needs. This need could be defined by a specifics to Person, Place or
+ Thing. For example, you might have a Category for each different type of automotive
+ expenses, and then have a Tag for each vehicle. As with Categories, you can select
+ from the dropdown list, or type a new Tag name, and be prompted if you want to create
+ a new Tag with that name. Within the Tag field &kmymoney; will allow for multiple tags
+ entered within a single transaction.
</para>
</sect3>
@@ -300,8 +309,8 @@
<title>The Memo</title>
<para>
- A multi-line memo can be entered if you wish to help you remember what the
- transaction was for.
+ A multi-line memo can be entered if you wish to help you remember further
+ details of a specific transaction.
</para>
</sect3>
@@ -309,8 +318,9 @@
<title>The Check Number</title>
<para>
- The check number can be entered if needed. Note that the check number can
- always be visible if desired. This is configured in the Settings dialog.
+ The check number can be entered if needed. Note that the check number field can
+ be made visible or invisible in the ledger if desired. This is configured in
+ the Ledger Settings dialog.
</para>
</sect3>
@@ -332,12 +342,13 @@
Finally, enter the transaction amount into the required field. Note that a
simple calculator can be displayed, either by clicking the icon to the right
of the amount field, or by entering the % character into the field, or by
- entering a formula, as in <emphasis>12 + 3</emphasis>. When entering the plus
+ entering any of these mathmatical symbols: + - * / in a formula,
+ as in <emphasis>12 + 3</emphasis>. When entering the plus
sign, the calculator will be opened.
</para>
<para>
- When you are satisfied that all the fields have been filled in correctly,
+ When you are satisfied that all the fields have been adequately filled in,
click on <guibutton>Enter</guibutton>. If you accidentally press or click on
<guibutton>Enter</guibutton> before you have finished entering all the data,
click on <guibutton>Edit</guibutton> to resume entering the data.
@@ -364,7 +375,7 @@
<para>
The second method of entering transactions into the ledger involves editing
- the transaction list itself directly.
+ the transaction list directly.
</para>
<para>
@@ -417,7 +428,7 @@
</sect1>
<sect1 id="details.ledgers.split">
-<title>Split Transactions</title>
+<title id="details.ledgers.split.title">Split Transactions</title>
<para>
The Split transaction feature allows you to divide up a transaction into
@@ -427,7 +438,7 @@
<para>
To enter a split transaction, using either the transaction input form or the
- transaction list, start a new transaction as normal, including entering the
+ transaction list, start a new transaction, including entering the
total amount. Then, instead of selecting a category, click the
<guibutton>Split</guibutton> button. If you have already selected a category,
that becomes the first entry in the split editor screen.
@@ -494,7 +505,7 @@
</sect1>
<sect1 id="details.ledgers.match">
-<title>Matching Transactions</title>
+<title id="details.ledgers.match.title">Matching Transactions</title>
<para>
Generally, when importing transactions, either via QIF, OFX, or HBCI, &kmymoney;
@@ -508,7 +519,7 @@
<para>
If you should find that an imported transaction was not automatically matched
with an existing transaction when it should have matched, then it is possible
- to match them manually. Note that there is a difference between manually
+ to match them manually. Note there is a difference between manually
matching two transactions and simply deleting one of them, even though they
may appear to have the same effect. Specifically with OFX or HBCI, it is
important not to delete the imported transaction, because you will find that
@@ -525,12 +536,11 @@
transaction with a hand-entered (non-imported) transaction. To do so, select
one of the transactions to be matched by clicking on it, then select the other
by left clicking on it while pressing the &Ctrl; key, and then select
- <guimenuitem>Match</guimenuitem> from the context menu. This changes the
- background color to a pale green. This will match and 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 <guibutton>Accept</guibutton>.
+ <guimenuitem>Match</guimenuitem> from the context menu. This will match and
+ 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 <guibutton>Accept</guibutton>.
</para>
<para>
@@ -553,8 +563,8 @@
<title>Understanding the Cleared State</title>
<para>
- A transaction can have one of three states: non-reconciled, cleared (C), and
- reconciled (R). When you enter a transaction, it has state
+ A transaction can have one of three states: non-reconciled(blank), cleared (C)
+ , and reconciled (R). When a transaction is entered, it has state of
non-reconciled. Once the bank posts the transaction, the user can clear it
and thus transform it to state (C). When you receive a statement from the
bank, all cleared transactions should be on the statement.
@@ -587,16 +597,10 @@
(R), you will be warned.
</para>
-<para>
- A fourth state is defined (frozen (F)) but there's currently no way to set
- it. It is reserved for future use. Nevertheless, if a transaction has at least
- one split in state frozen it cannot be edited anymore.
-</para>
</sect1>
-<sect1 id="details.ledgers.settings">
-<title>Changing Transaction Settings</title>
+<sect1 id="details.ledgers.settings"><title id="details.ledgers.settings.title">Changing Transaction Settings</title>
<para>
There are several settings options that change the appearance and behavior of
@@ -675,7 +679,7 @@
</sect1>
<sect1 id="details.ledgers.other">
-<title>Other Functionality</title>
+<title id="details.ledgers.other.title">Other Functionality</title>
<para>
Additional options are available from the <guimenu>Transaction
@@ -710,3 +714,4 @@
</para>
</sect1>
</chapter>
+
diff --git a/doc/details-payees.docbook b/doc/details-payees.docbook
index 70fd184ff..fccd44d0b 100644
--- a/doc/details-payees.docbook
+++ b/doc/details-payees.docbook
@@ -4,23 +4,33 @@
<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>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2019-04-01</date>
+ <releaseinfo>5.0.3</releaseinfo>
</chapterinfo>
<title>Payees</title>
<para>
- The Payees screen provides detailed information about all the payees and
- payers involved in transactions. The Payees screen is split into two main
- areas: a payees and payers list and a detail area.
+ 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.
</para>
<para>
- The Payees screen allows for viewing the transactions for the selected payee,
- updating personal information associated with a particular payee or payer, and
- specifying transaction matching criteria.
+ 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 tabls, showing the transactions, address, matching
+ information, default account, and account numbers for the payee selected in
+ the list.
</para>
<para>
@@ -37,19 +47,17 @@
<title>Payees List</title>
<para>
- A list of payees and payers is on the left side of this screen. The payee list
- is sorted alphabetically.
+ 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.
</para>
<sect2>
<title>Adding a Payee or Payer</title>
<para>
- To add a payee or payer, right-click on any payee name and choose
- <guimenuitem>New payee</guimenuitem>. This creates a new payee called
- <quote>New Payee</quote>. Right-click on this payee and select
- <guimenuitem>Rename payee</guimenuitem> to enter the name of the new payee or
- payer.
+ 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>.
</para>
</sect2>
@@ -57,10 +65,10 @@
<title>Renaming a Payee or Payer</title>
<para>
- To rename a payee or payer, simply right-click on the name, select
- <guimenuitem>Rename payee</guimenuitem> and the name 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>
@@ -69,10 +77,12 @@
<para>
To remove a payee or payer, right-click the name and select
- <guimenuitem>Delete payee</guimenuitem>. If the payee has any transactions,
+ <guimenuitem>Delete payee</guimenuitem>. If the payee has any transactions,
you will be presented with a dialog that allows you to reassign them to a
- different payee, and also a check box to enable a deleted name to be added to
- the new payee's matching list.
+ different payee, and also a check box to enable the deleted name to be added
+ to the new payee's matching list. Another option for renaming an existing
+ payee is to select the payee or payer by left clicking it and then left
+ clicking <guibutton>-Del</guibutton>.
</para>
</sect2>
</sect1>
@@ -85,9 +95,10 @@
<para>
To view and edit the personal information associated with a particular payee,
- select the payee from the list and select the Address tab. 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. 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.
</para>
<para>
@@ -115,15 +126,16 @@
&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.
+ 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>SUNTRUST BANK MAPLE VALLEY, GA 111506</quote> one month and
then <quote>SUNTRUST BANK MAPLE VALLEY, GA 121606</quote> the next month. You
- would really like both of those transactions to be assigned simply to your
- payee <quote>SunTrust</quote>. The transaction matching feature is for you!
+ would really like both of those transactions to be assigned to your payee
+ <quote>SunTrust</quote>. The transaction matching feature is for you!
</para>
<para>
@@ -145,39 +157,51 @@
<title>Setting up</title>
<para>
- From the Matching tab, you can set the Transaction Matching Settings. You have
- 3 major options:
+ 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.
</para>
<itemizedlist>
<listitem>
<para>
- No Matching. Disables the feature for this payee. This is the default
- setting for all payees.
+ No Matching. This disables the feature for this payee. This is the
+ default setting for all payees.
</para>
</listitem>
<listitem>
<para>
- Match on Payee Name. Enables the feature, and uses the payee name itself
- as the Match Key
+ 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.
</para>
</listitem>
<listitem>
<para>
- Match on Key. Enables the feature, and allows you to enter one or more
- Match Keys of your choosing. In general, entering a plain string will
- work perfectly. However, the match keys are actually regular expressions,
- so it is possible to match on more complicated patterns.
+ 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
+ keep track of different Payees that have the same business name but have
+ different locations.
+ </para>
+ </listitem>
+
+ <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 particaular 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>
</listitem>
</itemizedlist>
<para>
- You can also choose whether you want to ignore the case of the Match Key. If
- you choose this option, the Match Key <quote>SunTrust</quote> would match
- <quote>SUNTRUST BANK</quote> or <quote>SunTrust Bank</quote>.
+ With any of these options you can choose whether or not to ingnore the case
+ sensitivity of the spelling of the payee based on whether you check
+ <guilabel>Ignore Case</guilabel>.
</para>
</sect3>
@@ -185,16 +209,18 @@
<title>Importing Transactions</title>
<para>
- When you import transactions using the QIF import, or using a plugin such as
- OFX or AqBanking, the Match Keys you have set will be considered. If the
- Match Key for one of your payees is found anywhere in the payee of the
+ 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>SunTrust</quote> will match
<quote>SUNTRUST BANK MAPLE VALLEY,GA</quote> or even
<quote>MORGENSUNTRUST&LOAN</quote>. So choose your Match Keys carefully.
- <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>
+ <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>
@@ -205,9 +231,9 @@
<para>
To view all transactions associated with a particular payee, select the payee
- from the list and the Transaction tab in the detail area. Double-clicking a
- particular transaction will bring you directly to that transaction in the
- Ledgers screen.
+ 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>
<para>
@@ -225,3 +251,4 @@
</para>
</sect1>
</chapter>
+
diff --git a/doc/details-schedules.docbook b/doc/details-schedules.docbook
index 2dfa4c2e7..1963933bf 100644
--- a/doc/details-schedules.docbook
+++ b/doc/details-schedules.docbook
@@ -4,9 +4,13 @@
<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>
</authorgroup>
- <date>2010-07-25</date>
- <releaseinfo>4.5</releaseinfo>
+ <date>2019-04-01</date>
+ <releaseinfo>5.0.3</releaseinfo>
</chapterinfo>
<title>Schedules</title>
@@ -23,33 +27,36 @@
<para>
Sometimes called a recurring transaction, a schedule provides a means to
- record information about a transaction that happen on a regular basis. A
- common schedule is your salary. Once a month, or maybe weekly, the company
- you work for pays you for services rendered. This payment can happen in many
- different ways, but each month or week you will receive a payment that needs
- to be recorded.
+ record information about a transaction that happen on a regular basis. You
+ can schedule deposit, transfer, withdrawl, 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).
</para>
<para>
- Because you know these payments are regularly made to you, you can create a
- Schedule to record information about the payment and even create the
- transaction for you when pay day arrives.
+ 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.
</para>
<para>
- Other types of schedules can also be recorded to reflect money coming in and
- out of your accounts. Common expenses, such as utility bills or money
- transfers, can be recorded with schedules, along with loan
- repayments. Scheduling a payment can also provide a useful reminder that you
- need to make a payment.
+ 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.
</para>
<para>
- A schedule consists of two main parts: the scheduling data and the transaction
- data. The scheduling data records the occurrence of the schedule, i.e., when
+ A schedule consists of two main parts: the transactiondata 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, and will be entered in
- to the ledger as-is.
+ 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.
</para>
</sect1>
@@ -62,54 +69,54 @@
</para>
<itemizedlist>
- <listitem><para>Bills</para></listitem>
<listitem><para>Deposits</para></listitem>
- <listitem><para>Loans</para></listitem>
+ <listitem><para>Bills</para></listitem>
<listitem><para>Transfers</para></listitem>
+ <listitem><para>Loans</para></listitem>
</itemizedlist>
<sect2>
-<title>Bills</title>
+<title>Deposit</title>
<para>
- A Bill Schedule is used for money going out of your account, such as a Gym
- membership or a utility bill.
+ A Deposit is for money coming into your account, such as paychecks,
+ bonuses, or interest income.
</para>
</sect2>
<sect2>
-<title>Deposits</title>
+<title>Bills/Withdrawals</title>
-<para>
- A Deposit Schedule is for money coming into your account, such as a pay check.
+<para>
+ A Bill or Withdrawal is for money going out of your account, such as a
+ membership, utility bill, taxes, or car registration.
</para>
</sect2>
<sect2>
-<title>Loans</title>
+<title>Transfer</title>
-<para>
- A Loan Schedule is a special type of schedule and is created when dealing with
- <link linkend="details.loans">Loan</link> accounts.
+<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.
</para>
</sect2>
<sect2>
-<title>Transfers</title>
+<title>Loans</title>
<para>
- A Transfer Schedule is used for money coming out of one account and going into
- another, such as making a credit card payment from your checking account.
+ A Loan Schedule is a special type of schedule and is created when dealing with a
+ <link linkend="details.loans">Loan account</link>.
</para>
</sect2>
-
</sect1>
<sect1 id="details.schedules.view">
-<title>The schedule view</title>
+<title>The Schedules View</title>
<para>
- Open the schedule view by clicking on the <guiicon>Schedule
+ Open the Schedules View by clicking on the <guiicon>Schedule
<inlinemediaobject><imageobject><imagedata
fileref="schedule_view.png"/></imageobject></inlinemediaobject></guiicon> icon in
the view selector.
@@ -129,22 +136,20 @@
</para>
<para>
- The schedule view consists of a view area with two tabs along with a
- <guibutton>New Schedule</guibutton> button above it. The first tab
- <guibutton>List View</guibutton> shows all schedules, grouped by type. The
- second tab <guibutton>Calendar View</guibutton> is described in its own
- section below.
+ 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.
</para>
<para>
- To create a new schedule click on the button. For Bill, Deposit, and Transfer
- schedules, &kmymoney; will display the new schedule dialog. Loan schedules are
- handled differently, and are described in the section on Loans.
+ 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.
</para>
</sect1>
<sect1 id="details.schedules.new">
-<title>The new schedule dialog</title>
+<title>The New Schedule dialog</title>
<para>
<screenshot>
<mediaobject>
@@ -159,8 +164,8 @@
</para>
<para>
- A new dialog window is now shown, prompting for the schedule and transaction
- data. The requested data includes the following:
+ A New Schedule dialog is now shown, prompting for the schedule and transaction
+ details. The requested data include the following:
</para>
<orderedlist numeration="upperalpha">
@@ -174,53 +179,53 @@
</orderedlist>
<sect2>
-<title>Filling in the fields</title>
-
-<para>
- Enter the name and the date of the next occurrence of this schedule into their
- respective fields. The name is how the schedule will be shown in the list
- view. 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> check box and you will be prompted for the
- correct amount when it is entered into the ledger. Fill in all the
- transaction fields as you would normally with the ledger view.
-</para>
+<title>Filling in the Schedule name, Frequency, and Payment information.</title>
+
+<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> check box 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.
+</para>
</sect2>
<sect2>
-<title>Modifying the schedule behavior</title>
+<title>Modifying the Schedule Options section</title>
<para>
- At the bottom of the dialog are some optional fields that can modify how the
- schedule behaves. If the schedule occurs on a weekend you can choose whether
- to enter the transaction on the weekend day, the previous Friday, or the next
- Monday. Typically this option is used to replicate some real world operation
- such as a bank transaction.
+ 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>.
</para>
-</sect2>
-
-<sect2>
-<title>Letting &kmymoney; enter the transaction into the register</title>
<para>
- To let &kmymoney; automatically enter the transaction for you when needed,
- make sure that the check box labeled <guilabel>Enter this schedule into the
- ledger automatically when it is due</guilabel> is checked. 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 Settings section.
+ 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.
</para>
-</sect2>
-
-<sect2>
-<title>Letting &kmymoney; know when the schedule will finish</title>
<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. Check the appropriate check box and enter the appropriate
- information. Only the date or the number of transactions remaining is needed
- because the other can be calculated.
+ 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.
</para>
<para>
@@ -236,8 +241,8 @@
<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</guimenuitem>. This
- will bring up a dialog similar to the New Schedule dialog, where you can alter
+ 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.
</para>
</sect1>
@@ -247,96 +252,17 @@
<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</guimenuitem>.
+ bring up the context menu and select <guimenuitem>Delete scheduled transaction</guimenuitem>.
</para>
</sect1>
-<sect1 id="details.schedules.calendar">
-<title>The calendar view</title>
-
-<para>
- The calendar tab presents the schedules in a calendar format so it is easier
- to see when they occur. To switch to the calendar view click on the
- <guibutton>Calendar View</guibutton> tab.
-</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="calendarview.png" format="PNG" />
- </imageobject>
- <textobject>
- <phrase>Calendar View</phrase>
- </textobject>
- </mediaobject>
- </screenshot>
-</para>
-
-<para>
- The calendar type can be changed using the <guibutton>Select Style</guibutton>
- button. Currently only two types exist: Week and Month. The monthly view is
- the default, and is usually the most useful. Navigate through the dates using
- the controls as you would with the date input control.
-</para>
-
-<para>
- On any day with scheduled transactions, the number of transactions scheduled
- for that day is displayed on the calendar.
-</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="schedmonthday.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
+<sect1 id="details.schedules.duplicate">
+<title>Duplicating schedules</title>
<para>
- To view the schedule(s) that fall on that day, move the mouse cursor over the
- highlight and a popup window will be displayed allowing you to view the
- schedule summary.
+ 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>.
</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="schedpopup.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
-
-<para>
- If more than one schedule falls on that day you can cycle through them using
- the arrow buttons in the upper corners of the popup window.
-</para>
-
-<para>
- If you find that the display is cluttered with schedules and you only want to
- view one type of schedule, then this is possible from the <guibutton>Select
- Schedules</guibutton> dropdown. After clicking on this button the different
- schedule types are listed and are checked by default
-</para>
-
-<para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="schedcaltypes.png" format="PNG" />
- </imageobject>
- </mediaobject>
- </screenshot>
-</para>
-
-<para>
- To remove a type from the calendar view simply uncheck it in the list.
-</para>
-
</sect1>
<sect1 id="details.schedules.entering">
@@ -345,12 +271,15 @@
<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 four different ways:
+ Scheduled transactions can be entered in one of 3 different ways:
</para>
<itemizedlist>
- <listitem><para>Manually by right clicking on the list entry</para></listitem>
- <listitem><para>Manually via the popup window in the calendar view</para></listitem>
+ <listitem>
+ <para>
+ Manually by right clicking on the entry in the Schedules View</para>
+ </listitem>
+
<listitem>
<para>
&kmymoney; can enter them with or without your interaction upon startup
@@ -369,9 +298,7 @@
<para>
You can enter a scheduled transaction manually by right clicking on the list
- entry and selecting <guimenuitem>Enter</guimenuitem> from the popup menu or by
- clicking on the <guibutton>Enter</guibutton> button on the popup window in the
- calendar view.
+ entry and selecting <guimenuitem>Enter</guimenuitem> from the popup menu.
</para>
</sect2>
@@ -397,7 +324,7 @@
<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 on <guibutton>OK</guibutton>
+ 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
@@ -445,3 +372,4 @@
</sect2>
</sect1>
</chapter>
+
diff --git a/doc/details-settings.docbook b/doc/details-settings.docbook
index ba0d5862b..887257abb 100644
--- a/doc/details-settings.docbook
+++ b/doc/details-settings.docbook
@@ -767,7 +767,7 @@ of accounts.</para>
</variablelist>
</sect2>
-<sect2>
+<sect2 id="details.settings.schedules.calendar">
<title>Processing Days</title>
<variablelist>
<varlistentry>
More information about the kde-doc-english
mailing list