diff options
Diffstat (limited to 'doc/ledger-mode.texi')
| -rw-r--r-- | doc/ledger-mode.texi | 89 |
1 files changed, 59 insertions, 30 deletions
diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi index e47bdae..1a5674d 100644 --- a/doc/ledger-mode.texi +++ b/doc/ledger-mode.texi @@ -47,7 +47,7 @@ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. @end copying -@dircategory Major Modes +@dircategory Emacs @direntry * Ledger Mode: (ledger-mode). Command-Line Accounting @end direntry @@ -169,18 +169,13 @@ format. Then type the first few characters of another payee in the search for a Payee that has the same beginning and copy the rest of the transaction to you new entry. -Additionally you can use the ledger @command{xact} command, by either -typing @kbd{C-c C-a} or using @samp{Add Transaction} menu entry. Then -typing a close match to the payee. Ledger-mode will call @command{ledger -xact} with the data you enter and place the transaction in the proper -chronological place in the ledger. - -If you need to add a lot of transactions that are not near your current -date you can set the current year and month so that using @samp{Add -Transaction} will prompt you with a more convenient month and year. To -set the month type @kbd{C-c RET} and enter the month you want. @kbd{C-c -C-y} will prompt you for the year. These settings only effect the -@samp{Add Transaction} command. +Additionally you can use the ledger @command{xact} command, by either typing +@kbd{C-c C-a} or using @samp{Add Transaction} menu entry. Then typing a close +match to the payee. Ledger-mode will call @command{ledger xact} with the data +you enter and place the transaction in the proper chronological place in the +ledger. Subsequent calls to @kbd{C-c C-a} remember the last date so entering +many dates in the past is easy. The date format can be changed by modifying +@option{ledger-default-date-format}. @node Reconciliation, Reports, Quick Add, Quick Demo @subsection Reconciliation @@ -254,6 +249,7 @@ current regex. Cancel the narrowing by typing @kbd{C-c C-f} again. @chapter The Ledger Buffer @menu +* Navigating Transactions:: * Adding Transactions:: * Copying Transactions:: * Editing Amounts:: @@ -264,26 +260,59 @@ current regex. Cancel the narrowing by typing @kbd{C-c C-f} again. * Narrowing Transactions:: @end menu +@node Navigating Transactions, Adding Transactions, The Ledger Buffer, The Ledger Buffer +@section Navigating Transactions +@cindex transaction, navigation + +@findex ledger-navigate-next-xact-or-directive +@findex ledger-navigate-prev-xact-or-directive +@kindex M-p +@kindex M-n + +In addition to the usual Emacs navigation commands, ledger-mode offers several +additional commands to ease navigation. @kbd{M-n} and @kbd{M-p} navigate between +next and previous xacts or directives. -@node Adding Transactions, Copying Transactions, The Ledger Buffer, The Ledger Buffer +@findex ledger-navigate-next-uncleared +@findex ledger-navigate-previous-uncleared + +Additionally, M-x ledger-navigate-previous-uncleared and M-x +ledger-navigate-next-uncleared navigate to the next and precious uncleared +transactions. + + +@node Adding Transactions, Copying Transactions, Navigating Transactions, The Ledger Buffer @section Adding Transactions -@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 -payees and accounts. Ledger-mode will scan the existing buffer for -payees and accounts. Included files are not currently included in the -completion scan. Repeatedly hitting @kbd{TAB} will cycle through the -possible completions. - -Ledger-mode can also help you keep your amounts aligned. Setting -@option{ledger-post-auto-adjust-amounts} to true tells Ledger-mode to -automatically place any amounts such that their last digit is aligned to -the column specified by @option{ledger-post-amount-alignment-column}, -which defaults to @samp{52}. @xref{Ledger Post Customization Group}. +Ledger-mode assists you by providing robust @kbd{TAB} completion for payees and +accounts. Ledger-mode will scan the existing buffer for payees and accounts. +Included files are not currently included in the completion scan. Ledger-mode +respects Emacs's variables that govern @kbd{TAB} completion, see especially +@code{tab-always-indent}. + +To cycle between completions when hitting @kbd{TAB} multiple times, you can +adjust the standard completion configuration like this: + +@lisp +(add-hook 'ledger-mode-hook + (lambda () + (setq-local tab-always-indent 'complete) + (setq-local completion-cycle-threshold t) + (setq-local ledger-complete-in-steps t))) +@end lisp + +Ledger-mode will help you keep your amounts aligned. When indenting or +completing, Ledger-mode will automatically place any amounts such that their +last digit is aligned to the column specified by +@option{ledger-post-amount-alignment-column}, which defaults to +@samp{52}. @xref{Ledger Post Customization Group}. + +To prevent the automatic realignment of amounts, disable +@option{ledger-post-auto-align}. @xref{Ledger Post Customization Group}. @menu * Setting a Transactions Effective Date:: @@ -328,6 +357,10 @@ An easy way to copy a transaction is to type @kbd{C-c C-k} or menu entry copied transaction, and after having confirmed with @kbd{RET}, new transaction will be inserted at @emph{date} position in buffer. +If you prefer to keep blank lines between your transactions, you can +change the default in +@option{ledger-copy-transaction-insert-blank-line-after}. + @node Editing Amounts, Marking Transactions, Copying Transactions, The Ledger Buffer @section Editing Amounts @kindex C-c C-b @@ -1113,10 +1146,6 @@ Ledger Post: @ftable @option -@item ledger-post-auto-adjust-amounts -If non-nil, then automatically align amounts to column specified in -@option{ledger-post-amount-alignment-column}. - @item ledger-post-amount-alignment-column The column Ledger-mode uses to align amounts. |