Merge pull request #409 from thdox/ledger-mode-doc

Some documentation improvments about Ledger mode
This commit is contained in:
Craig Earls 2015-04-05 09:40:11 -07:00
commit dd6185a120

View file

@ -385,13 +385,15 @@ transaction.
@end itemize
@kindex C-c C-e
@kindex C-c C-c
@kindex C-c C-e
Clearing complete transactions is done by typing @kbd{C-c C-e} with
point in a transaction. This places an asterisk @samp{*} after the
date. Clearing individual postings is done by typing @kbd{C-c C-c}
while in a posting. This places an asterisk prior to the posting.
Typing @kbd{C-c C-c}, depending where is the point, will clear the
complete transaction, or an individual posting. This places an asterisk
@samp{*} prior to the payee for the complete transaction, or prior to
the account for an individual posting. When point is inside
a transaction, specifically on an individual posting, you can still
clear the complete transaction by typing @kbd{C-c C-e}.
@node Formatting Transactions, Deleting Transactions, Marking Transactions, The Ledger Buffer
@section Formatting Transactions
@ -882,7 +884,7 @@ recurrence relation to be specified. The day names are two character
codes that default to Mo, Tu, We, Th, Fr, Sa, Su, for Monday, Tuesday,
Wednesday, Thursday, Friday, Saturday, Sunday respectively. You can
change the codes to something more convenient for your locale by
customizing the ledger @var{ledger-schedule-week-days}. They must be two
customizing the ledger @option{ledger-schedule-week-days}. They must be two
characters long.
@ -967,7 +969,7 @@ false toggle between uncleared and cleared @samp{*}.
@item ledger-reconcile-default-date-format
Date format for the reconcile buffer. Defaults to
ledger-default-date-format.
@option{ledger-default-date-format}.
@item ledger-reconcile-target-prompt-string
Prompt for recon target. Defaults to "Target amount for reconciliation ".
@ -980,11 +982,11 @@ header will be displayed. Defaults to "Reconciling account %s\n\n".
@item ledger-reconcile-buffer-line-format
Format string for the ledger reconcile posting format. Available fields
are date, status, code, payee, account, amount. The format for each
field is %WIDTH(FIELD), WIDTH can be preced by a minus sign which mean
field is %WIDTH(FIELD), WIDTH can be preceded by a minus sign which mean
to left justify and pad the field. WIDTH is the minimum number of
characters to display; if string is longer, it is not truncated unless
ledger-reconcile-buffer-payee-max-chars or
ledger-reconcile-buffer-account-max-chars is defined. Defaults to
@option{ledger-reconcile-buffer-payee-max-chars} or
@option{ledger-reconcile-buffer-account-max-chars} is defined. Defaults to
"%(date)s %-4(code)s %-50(payee)s %-30(account)s %15(amount)s\n"
@item ledger-reconcile-buffer-payee-max-chars