diff options
author | thdox <thdox@free.fr> | 2013-05-01 00:25:00 +0200 |
---|---|---|
committer | thdox <thdox@free.fr> | 2013-05-01 00:25:00 +0200 |
commit | 07e852c7d08d629df03e18841bf4395b929813e7 (patch) | |
tree | b43b4c08624c5dda462d90fb4c6162dca36f09b1 /doc | |
parent | eab7b577804923ff5d62aa37b08d9b22e9ccbcc9 (diff) | |
download | fork-ledger-07e852c7d08d629df03e18841bf4395b929813e7.tar.gz fork-ledger-07e852c7d08d629df03e18841bf4395b929813e7.tar.bz2 fork-ledger-07e852c7d08d629df03e18841bf4395b929813e7.zip |
Adding concepts (@cindex) to fill Concept Index
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ledger-mode.texi | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi index 1f6ac9be..3e0cd4fa 100644 --- a/doc/ledger-mode.texi +++ b/doc/ledger-mode.texi @@ -103,6 +103,7 @@ reports and much more... @node Quick Installation, Menus, Introduction to Ledger-mode, Introduction to Ledger-mode @section Quick Installation +@cindex installation The Emacs lisp source for Ledger-mode is included with the source distribution of Ledger. It is entirely included in the @file{lisp} @@ -123,6 +124,7 @@ as long as the ledger command line utility is properly installed. @node Menus, Quick Demo, Quick Installation, Introduction to Ledger-mode @section Menus +@cindex menu The vast majority of Ledger-mode functionality is available from the Emacs menu system. The keystrokes are shown in the menu to help you @@ -130,6 +132,7 @@ learn the faster keyboard methods. @node Quick Demo, , Menus, Introduction to Ledger-mode @section Quick Demo +@cindex demo Load the demo file @file{demo.ledger} from the Ledger source @file{test/input} directory. The ledger will be loaded and font @@ -245,6 +248,7 @@ amount. @findex ledger-post-auto-adjust-amounts @findex ledger-post-amount-alignment-column @kindex TAB +@cindex transaction, adding Beyond the two ways of quickly adding transactions (@pxref{Quick Add}) Ledger-mode assists you by providing robust @kbd{TAB} completion for @@ -266,6 +270,7 @@ which defaults to @samp{52}. @xref{Ledger Post Customization Group}. @node Quick Balance Display, , Adding Transactions, Adding Transactions @subsection Quick Balance Display @kindex C-c C-p +@cindex balance You will often want to quickly check the balance of an account. The easiest way it to position point on the account you are interested in, @@ -277,6 +282,8 @@ the balance of the account will be displayed in the minibuffer. @section Editing Amounts @kindex C-c C-b @kindex y +@cindex calc +@cindex transaction, editing amounts GNU Calc is a very powerful Reverse Polish Notation calculator built into all recent version of Emacs. Ledger-mode makes it easy to @@ -294,6 +301,10 @@ a comma. @node Marking Transactions, Deleting Transactions, Editing Amounts, The Ledger Buffer @section Marking Transactions +@cindex transaction, marking +@cindex uncleared +@cindex pending +@cindex cleared Ledger considers transaction or posting to be in one of three states: uncleared, cleared, and pending. For calculation Ledger ignores these @@ -329,6 +340,7 @@ while in a posting. This places an asterisk prior to the posting. @node Deleting Transactions, Sorting Transactions, Marking Transactions, The Ledger Buffer @section Deleting Transactions @kindex C-c C-d +@cindex transaction, deleting Along with normal buffer editing methods to delete text, Ledger-mode provides an easy way to delete the transaction under point: @kbd{C-c @@ -338,6 +350,7 @@ transaction operation is in the undo buffer. @node Sorting Transactions, Narrowing Transactions, Deleting Transactions, The Ledger Buffer @section Sorting Transactions @kindex C-c C-s +@cindex transaction, sorting As you operating on the Ledger files, they may become disorganized. For the most part, Ledger doesn't care, but our human brains prefer a bit of @@ -376,6 +389,8 @@ at point. @node Narrowing Transactions, , Sorting Transactions, The Ledger Buffer @section Narrowing Transactions @kindex C-c C-f +@cindex transaction, narrowing +@cindex transaction, display filtering Often you will want to run Ledger register reports just to look at a specific set of transactions. If you don't need the running total @@ -430,6 +445,7 @@ To show back all transactions simply invoke @samp{Hide Xacts} or @node Basics of Reconciliation, Starting a Reconciliation, The Reconcile Buffer, The Reconcile Buffer @section Basics of Reconciliation +@cindex reconciliation, basics Even in this relatively modern era, financial transactions do not happen instantaneously, unless you are paying cash. When you swipe your debit @@ -449,6 +465,7 @@ parties agree. @section Starting a Reconciliation @findex ledger-reconcile-default-commodity @kindex C-c C-r +@cindex reconciliation, starting To start reconciling an account you must have a target, both the transactions that you know about and the transactions the bank knows @@ -476,6 +493,7 @@ not display the complete list of commodities. @node Mark Transactions Pending, Edit Transactions During Reconciliation, Starting a Reconciliation, The Reconcile Buffer @section Mark Transactions Pending @kindex SPC +@cindex reconciliation, transaction marking The @file{*Reconcile*} buffer will show all the uncleared transactions that meet the criteria set in the regex. By default uncleared @@ -489,6 +507,7 @@ difference from your target is zero. @section Edit Transactions during Reconciliation @kindex RET @kindex C-c C-c +@cindex reconciliation, transaction editing If you find errors during reconciliation. You can visit the transaction under point in the @file{*Reconcile*} buffer by hitting the @kbd{RET} @@ -499,6 +518,7 @@ mark the transaction if appropriate. @node Finalize Reconciliation, Adding and Deleting Transactions during Reconciliation, Edit Transactions During Reconciliation, The Reconcile Buffer @section Finalize Reconciliation +@cindex reconciliation, finalizing Once you have marked all transactions as pending and the cleared balance is correct. Finish the reconciliation by typing @kbd{C-c C-c}. This @@ -508,6 +528,7 @@ marks all pending transaction as cleared and saves the ledger buffer. @section Adding and Deleting Transactions during Reconciliation @kindex a @kindex d +@cindex reconciliation, transaction adding and deleting While reconciling, you may find new transactions that need to be entered into your ledger. Simply type @kbd{a} to bring up the quick add for the @@ -519,6 +540,7 @@ Typing @kbd{d} will delete the transaction under point in the @node Changing Reconciliation Account, Changing Reconciliation Target, Adding and Deleting Transactions during Reconciliation, The Reconcile Buffer @section Changing Reconciliation Account @kindex g +@cindex reconciliation, account changing You can conveniently switch the account being reconciled by typing @kbd{g}, and entering a new account to reconcile. This simply restarts @@ -528,6 +550,7 @@ the ledger buffer are left in that state when the account is switched. @node Changing Reconciliation Target, , Changing Reconciliation Account, The Reconcile Buffer @section Changing Reconciliation Target @kindex t +@cindex reconciliation, target changing If for some reason during reconciliation your target amount changes, type @kbd{t} and enter the new target value. @@ -544,6 +567,7 @@ type @kbd{t} and enter the new target value. @node Running Basic Reports, Adding and Editing Reports, The Report Buffer, The Report Buffer @section Running Reports @kindex C-c C-o C-r +@cindex report, running The real power behind Ledger is in its amazing reporting capability. Ledger-mode provides easy facility to run reports directly from Emacs. @@ -572,6 +596,7 @@ transactions involving that account. @kindex S @kindex C-c C-o C-e @kindex e +@cindex report, adding and editing @menu * Expansion Formats:: @@ -600,6 +625,7 @@ report you want removed. @node Expansion Formats, Make Report Transactions Active, Adding and Editing Reports, Adding and Editing Reports @subsection Expansion Formats +@cindex report, custom variable It is sometimes convenient to leave room to customize a report without saving the command line every time. For example running a register @@ -633,6 +659,7 @@ Note how the double-quotes are escaped with back-slashes. @node Make Report Transactions Active, , Expansion Formats, Adding and Editing Reports @subsection Make Report Transactions Active +@cindex report, custom command In a large register report it is convenient to be able to jump to the source transaction. Ledger-mode will automatically include source @@ -646,6 +673,7 @@ may not get stripped out of the visible report. @node Reversing Report Order, , Adding and Editing Reports, The Report Buffer @section Reversing Report Order @kindex R +@cindex report, order reversing Often, banks show their online transaction histories with the most recent transaction at the top. Ledger itself cannot do a sensible @@ -691,6 +719,7 @@ for Ledger under the data options. Alternately you can choose @node Ledger Customization Group, Ledger Reconcile Customization Group, Customization Variables, Customization Variables @subsection Ledger Customization Group +@cindex customization, ledger-mode @ftable @option @item ledger-occur-use-face-shown @@ -705,6 +734,7 @@ If non-nil, highlight xact under point using @node Ledger Reconcile Customization Group, Ledger Report Customization Group, Ledger Customization Group, Customization Variables @subsection Ledger Reconcile Customization Group +@cindex customization, reconcile @ftable @option @item ledger-reconcile-default-commodity @@ -728,6 +758,7 @@ false toggle between uncleared and cleared @samp{*}. @node Ledger Report Customization Group, Ledger Faces Customization Group, Ledger Reconcile Customization Group, Customization Variables @subsection Ledger Report Customization Group +@cindex customization, report @ftable @option @item ledger-reports @@ -739,6 +770,7 @@ functions. @node Ledger Faces Customization Group, Ledger Post Customization Group, Ledger Report Customization Group, Customization Variables @subsection Ledger Faces Customization Group +@cindex customization, faces Ledger Faces: Ledger-mode highlighting @@ -779,6 +811,7 @@ FIXME @node Ledger Post Customization Group, Ledger Exec Customization Group, Ledger Faces Customization Group, Customization Variables @subsection Ledger Post Customization Group +@cindex customization, post Ledger Post: @@ -797,6 +830,7 @@ Which completion engine to use: @var{iswitchb}, @var{ido}, or built-in. @node Ledger Exec Customization Group, Ledger Test Customization Group, Ledger Post Customization Group, Customization Variables @subsection Ledger Exec Customization Group +@cindex customization, executable Ledger Exec: Interface to the Ledger command-line accounting program. @@ -809,6 +843,7 @@ Location of the ledger initialization file. nil if you don't have one. @node Ledger Test Customization Group, Ledger Texi Customization Group, Ledger Exec Customization Group, Customization Variables @subsection Ledger Test Customization Group +@cindex customization, test @ftable @option @item ledger-source-directory @@ -819,6 +854,7 @@ Directory where the debug binary. @node Ledger Texi Customization Group, , Ledger Test Customization Group, Customization Variables @subsection Ledger Texi Customization Group +@cindex customization, texi @ftable @option @item ledger-texi-sample-doc-path |