Add documentation for bugzilla #1105, and align documentation between

ledger-reconcile.el and ledger-mode.texi.

doc/ledger-mode.texi

@@ -929,29 +929,63 @@ If non-nil, highlight transaction under point using
 
 @ftable @option
 
-@item ledger-reconcile-default-commodity
-The default commodity for use in target calculations in ledger
-reconcile.  Defaults to @samp{$} (USD).
-
 @item ledger-recon-buffer-name
 Name to use for reconciliation buffer. Defaults to @file{*Reconcile*}.
 
 @item ledger-narrow-on-reconcile
-If non-nil, limit transactions shown in main buffer to those matching
+If t, limit transactions shown in main buffer to those matching
 the reconcile regex.
 
 @item ledger-buffer-tracks-reconcile-buffer
-If non-nil, then when the cursor is moved to a new transaction in the
+If t, then when the cursor is moved to a new transaction in the
-@file{*Reconcile*} window.
+@file{*Reconcile*} buffer. Then that transaction will be shown in its
+source buffer.
 
 @item ledger-reconcile-force-window-bottom
-If non-nil, make the @file{*Reconcile*} window appear along the bottom
+If t, make the @file{*Reconcile*} window appear along the bottom
 of the register window and resize.
 
 @item ledger-reconcile-toggle-to-pending
-If non-nil, then toggle between uncleared and pending @samp{!}. If
+If t, then toggle between uncleared and pending @samp{!}. If
 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.
+
+@item ledger-reconcile-target-prompt-string
+Prompt for recon target. Defaults to "Target amount for reconciliation ".
+
+@item ledger-reconcile-buffer-header
+Header string for the reconcile buffer. If non-nil, the name of the
+account being reconciled will be substituted into the '%s'.  If nil, no
+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
+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
+"%(date)s %-4(code)s %-50(payee)s %-30(account)s %15(amount)s\n"
+
+@item ledger-reconcile-buffer-payee-max-chars
+If positive, truncate payee name right side to max number of characters.
+
+@item ledger-reconcile-buffer-account-max-chars
+If positive, truncate account name left side to max number of characters.
+
+@item ledger-reconcile-sort-key
+Key for sorting reconcile buffer. Possible values are '(date)',
+'(amount)', '(payee)' or '(0)' for no sorting, i.e. using
+ledger file order. Defaults to '(0)'.
+
+@item ledger-reconcile-insert-effective-date nil
+If t, prompt for effective date when clearing transactions during
+reconciliation.
+
 @end ftable
 
 @node Ledger Report Customization Group, Ledger Faces Customization Group, Ledger Reconcile Customization Group, Customization Variables

lisp/ledger-reconcile.el

@@ -40,7 +40,7 @@
   :group 'ledger)
 
 (defcustom ledger-recon-buffer-name "*Reconcile*"
-  "Name to use for reconciliation window."
+  "Name to use for reconciliation buffer."
   :group 'ledger-reconcile)
 
 (defcustom ledger-narrow-on-reconcile t
@@ -49,29 +49,30 @@
   :group 'ledger-reconcile)
 
 (defcustom ledger-buffer-tracks-reconcile-buffer t
-  "If t, then when the cursor is moved to a new xact in the recon window.
+  "If t, then when the cursor is moved to a new transaction in the reconcile buffer.
 Then that transaction will be shown in its source buffer."
   :type 'boolean
   :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-force-window-bottom nil
-  "If t make the reconcile window appear along the bottom of the register window and resize."
+  "If t, make the reconcile window appear along the bottom of the register window and resize."
   :type 'boolean
   :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-toggle-to-pending t
-  "If true then toggle between uncleared and pending.
+  "If t, then toggle between uncleared and pending.
 reconcile-finish will mark all pending posting cleared."
   :type 'boolean
   :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-default-date-format ledger-default-date-format
-  "Default date format for the reconcile buffer."
+  "Date format for the reconcile buffer.
+Default is ledger-default-date-format."
   :type 'string
   :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-target-prompt-string "Target amount for reconciliation "
-  "Default prompt for recon target prompt."
+  "Prompt for recon target."
   :type 'string
   :group 'ledger-reconcile)
 
@@ -79,9 +80,9 @@ reconcile-finish will mark all pending posting cleared."
 	"Default header string for the reconcile buffer.
 
 If non-nil, the name of the account being reconciled will be substituted
-	into the '%s'.  If nil, no header willbe displayed."
+        into the '%s'.  If nil, no header will be displayed."
-	:type 'string
+  :type 'string
-	:group 'ledger-reconcile)
+  :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-buffer-line-format "%(date)s %-4(code)s %-50(payee)s %-30(account)s %15(amount)s\n"
 	"Format string for the ledger reconcile posting format.
@@ -106,10 +107,9 @@ ledger-reconcile-buffer-account-max-chars is defined."
   :group 'ledger-reconcile)
 
 (defcustom ledger-reconcile-sort-key "(0)"
-  "Default key for sorting reconcile buffer.
+  "Key for sorting reconcile buffer.
 
-Possible values are '(date)', '(amount)', '(payee)'.  For no sorting, i.e. using
+Possible values are '(date)', '(amount)', '(payee)' or '(0)' for no sorting, i.e. using ledger file order."
-ledger file order, use '(0)'."
   :type 'string
   :group 'ledger-reconcile)