From 9a0bafd2178fb0798251647f7e32ba9a1cbaf8ea Mon Sep 17 00:00:00 2001 From: Dave Peticolas Date: Fri, 15 Sep 2000 06:59:10 +0000 Subject: [PATCH] Glen Ditchfield's documentation patch. git-svn-id: svn+ssh://svn.gnucash.org/repo/gnucash/trunk@2857 57a11ea4-9604-0410-9ed3-97b8803252fd --- doc/sgml/C/xacc-recnwin.sgml | 146 +++++++++++++++++++---------------- doc/sgml/C/xacc-regwin.sgml | 135 +++++++++++++++++--------------- 2 files changed, 152 insertions(+), 129 deletions(-) diff --git a/doc/sgml/C/xacc-recnwin.sgml b/doc/sgml/C/xacc-recnwin.sgml index 061e9a0f4e..ecbbed1ed9 100644 --- a/doc/sgml/C/xacc-recnwin.sgml +++ b/doc/sgml/C/xacc-recnwin.sgml @@ -4,65 +4,92 @@ Reconciliation Window -The Reconciliation window is used to reconcile cleared - transactions from a bank statement. Enter a dollar amount from - your last bank statement in the box, and then click OK - . The window will then show all unreconciled transactions since - your last bank statement. The reconcile window looks like - this: +The Reconciliation window is used to reconcile a GnuCash account with + a statement that a bank or other institution has sent you. - - - - - - - - -The Reconciliation window is used to reconcile the user's - records at the end of the month. This involves validating the - transactions in GnuCash against the transactions indicated on - your bank statement. +For example, when you write a check for something, you should enter + the transaction into GnuCash. The reconciliation + (R) field of the transaction will initially + contain n (not reconciled). Later, if you think + that the check has been cashed, you might click on the transaction's + R field to change it to c + (cleared, but not reconciled). -For example, when you write a check for something, you - should enter the transaction into GnuCash. +At the end of the month, you receive your bank statement, + perhaps including canceled checks. At that point, + you should "reconcile" the account, that is, match your personal + records with the documentation provided by the bank. -At the end of the month, you receive your bank statement, -perhaps including canceled checks. At that point, -you should "reconcile" the account, that is, agree your personal -records to the documentation provided by the bank. -Open the reconcile window, and GnuCash will prompt you to - enter the ending balance from the bank statement. +Open the reconcile window by selecting + Reconcile... from the + Accounts menu of the account's + Register window. GnuCash will prompt + you for some information from the statement: - + + + + + + + -Then the reconcile window will pop-up, and you will see a - credit and a debit column that lists all the non-reconciled - transactions. - - +Enter the date of the end of the period that the statement covers, + and the final balance from the statement, and press + OK. The Reconcile window will pop up. It + looks like this: - + + + + + + + + + The Funds In and Funds Out + groups lists all the unreconciled transactions. The + '?' columns show whether the transactions have + been cleared or reconciled. + + - Now, examine each item on the bank statement. - - -If a check has cleared, as indicated by your bank - statement, you should click the field between the - description and payment fields, and it will then change - from n to c, indicating the -transaction - has ccleared. - - +Now, examine each item on the bank statement, and look for the + matching item in the Reconcile window. + + +If you cannot find one, then perhaps you forgot to enter a + transaction, or did not know that the transaction had happened. You + can use the New button on the tool bar, or the + New menu item in the + Transaction menu, to open a register window and + enter the missing transaction. The new item will appear in the + Reconcile window when you press enter after + entering the transaction. + + +When you find the item in the Reconcile window, compare the amount in + the item to the amount on the statement. If they disagree, you may + have made an error when you entered the transaction in GnuCash. You + can use the Edit button on the tool bar, or the + Edit menu item in the + Transaction menu, to open a register window and + correct the transaction. + + +If the amounts agree, click on the item in the Reconcile window. The + '?' column will change to 'y' + (reconciled) from 'n' or 'c'. + + You then repeat this for each item that appears on the bank statement, verifying that the amounts match with the amounts in GnuCash, and marking off transactions in GnuCash @@ -84,34 +111,17 @@ transaction When you have completed marking off all the items on the - bank statement, and when the difference heads to $0.00, you - should press Ok, then the n or c - in the transactions that were checked off will change to a - y, indicating that they have been validated to agree - between the bank statement and your own records. + bank statement, and when the difference is $0.00, you should press the + Finish button on the tool bar or select + Finish from the + Reconcile menu. The Reconcile window will close. + In the Register window, the + R field of the reconciled transactions will + change to 'y'. - -When you change anything in a transaction that has been - reconciled, a dialog box warning you that such changes are - unwise should pop up, but this doesn't seem to happen - anymore. - - -Also, the "cleared" total at the bottom seems to display - $0.00 regardless of what transactions are cleared or - reconciled. - - -The "cleared" total should display the total of only the - transactions that have been cleared (c) or reconciled - (y). - - - - diff --git a/doc/sgml/C/xacc-regwin.sgml b/doc/sgml/C/xacc-regwin.sgml index 7418cda8b9..d1d1b0a59d 100644 --- a/doc/sgml/C/xacc-regwin.sgml +++ b/doc/sgml/C/xacc-regwin.sgml @@ -6,30 +6,30 @@ Register Window - + - + - This is the "Register" or the "Ledger" window. Transactions are entered here. To enter a new transaction, just type into the last blank - transaction. As well as just typing them in, ou can use can use + transaction. As well as just typing them in, you can use the Date Accelerator keys to quickly enter dates. Use the mouse or the Register Keyboard Shortcutsto move - between fields, and hit the Enter key or click record to record + between fields, and press the Enter key or click + record on the toolbar to record the transaction: - + + + - - - + Notice how a the transaction has been recorded and a new, blank transaction has been created. @@ -40,7 +40,7 @@ After you have entered a few transactions, GnuCash will try to guess some or all of the remaining details of a transaction - when you type into the "Description" field. If GnuCash has + when you type into the Description field. If GnuCash has guessed wrong, simply type over or delete the incorrect information and replace it with the correct information. @@ -48,99 +48,110 @@ Manipulating transactions -You can manipulate transactions with the toolbar or the - "Transaction" menu: +You can manipulate transactions with the toolbar buttons or the + Transaction menu: - - -Delete: you can delete a transaction or an + + +Delete + You can delete a transaction or an individual split. - -Cancel: this reverts any changes you have made to - the transaction you are currently entering/changing + +Cancel + This undoes any changes you have made to + the transaction you are currently entering or changing. - -New: this moves the cursor to the last line of the - register where new transactions are entered + +New + This moves the cursor to the last line of the + register where new transactions are entered. - -Jump: When placed over an existing transaction, it - takes you to the corresponding register entry in the other - register entry that this transaction appears in + +Jump + When you have selected an existing transaction or split, this + takes you to the corresponding register entry in the other account + that is involved in the transaction or split. - -Transfer:This is an alternative way to enter a + +Transfer +This is an alternative way to enter a transaction. You can do a transfer between any two accounts without opening up other registers. - -Close:Closes this register + +Close +Closes this register. - + + - Viewing Transactions The register can show transactions in a variety of different - ways, controlled by entries on the "Register" menu. + ways, controlled by entries on the Register menu. The register can display transactions in several different styles: - - -single-line mode: transactions are displayed on a - single line. + + +single-line mode +Transactions are displayed on a single line. - -double-line mode: transactions are displayed over + +double-line mode +Transactions are displayed over two lines, with more information about each transaction shown. - -multi-line mode: transactions are displayed over + +multi-line mode +Transactions are displayed over multiple lines, allowing the display of multiple entries. This allows you to enter multi-split transactions (for instance, when you pay multiple bills with one check). - -auto-single and auto-double modes are like single + +auto-single and + auto-double modes +Like single and double-line modes, except that the currently-edited transaction is displayed in multi-line form. This is a very convenient way of entering multi-account transactions. - + + - -To change the display style, to go the "Register" menu and - select "style". +To change the display style, to go the Register + menu and select a style from the Style submenu. Existing transactions are normally displayed in date order, - but this can also be changed with "Sort Order". You can also + but this can also be changed with the Register + menu's Sort Order submenu. You can also select a date rate from which transactions will be displayed - with "Date Range". + with Date Range. @@ -152,17 +163,20 @@ The reconciliation status of a transaction is shown by the - reconciliation (R) field. 'c' indicates that a transaction has - been reconciled, 'n' indicates that it has not. You can change - the reconciliation status by clicking on a the 'r' field of the - transaction. + reconciliation (R) field. 'y' + indicates that a transaction has been reconciled, + 'n' indicates that it has not, and + 'c' indicates that it has been cleared, but not + reconciled. When a transaction has cleared, you can change its status + to 'c' by clicking on its R + field. At the bottom of the account window, there are two running - balances, the "cleared and reconciled" balance, and the "total" - balance... the "cleared and reconciled" balance should + totals: 'Balance', and + 'Cleared'. 'Cleared' should correspond to how much money the bank thinks you have in your - account, and the "total" balance includes outstanding + account, while 'Balance' includes outstanding transactions. @@ -176,18 +190,17 @@ window, or from a portfolio-view window, shown below. - + - - + + - + - The portfolio ledger can seem a bit daunting at first sight. @@ -243,7 +256,7 @@ If you are having trouble indicating a share purchase/sale in the portfolio ledger, then make sure that - Transfer From and Transfer To accounts are in + Transfer From and Transfer To accounts are in the right order. A transfer from a stock account is always interpreted as a sale, even if you entered the data as a purchase. The vice-versa is also true.