Restructured customization groups. Completed initial draft of ledger-mode documentation

1 files changed, 172 insertions, 23 deletions

diff --git a/doc/ledger-mode.texi b/doc/ledger-mode.texi
index 0dc487a2..9b2c1262 100644
--- a/doc/ledger-mode.texi
+++ b/doc/ledger-mode.texi
@@ -72,7 +72,9 @@ reports and much more...
 * The Ledger Buffer::           
 * The Reconcile Buffer::        
 * The Report Buffer::           
-* Installing and Customizing Ledger-mode::  
+* Customizing Ledger-mode::     
+* Generating Ledger Regression Tests::  
+* Embedding Example results in Ledger Documentation::  
 * Hacking Ledger-mode::         
 @end menu
 
@@ -83,12 +85,12 @@ reports and much more...
 @node Introduction to Ledger Mode, The Ledger Buffer, Copying, Top
 @chapter Introduction to Ledger Mode
 @menu
-* Quick installation::          
+* Quick Installation::          
 * Menus::                       
 * Quick Demo::                  
 @end menu
 
-@node Quick installation, Menus, Introduction to Ledger Mode, Introduction to Ledger Mode
+@node Quick Installation, Menus, Introduction to Ledger Mode, Introduction to Ledger Mode
 @section Quick Installation
 
 The emacs lisp source for Ledger-mode is included with the source
@@ -107,7 +109,7 @@ This sets up Emacs to automatically recognize files that end with
 @file{.ledger} and start Ledger mode.  Nothing else should be required
 as long as the ledger command line utility is properly installed.
 
-@node Menus, Quick Demo, Quick installation, Introduction to Ledger Mode
+@node Menus, Quick Demo, Quick Installation, Introduction to Ledger Mode
 @section Menus
 
 The vast majority of Ledger-mode functionality is available from the
@@ -225,6 +227,12 @@ payees and accounts. Included files are not currently included in the
 completion scan. Repeatedly hitting @code{TAB} will cycle through the
 possible completions.
 
+Ledger mode can also help you keep your amounts in alignment.  Setting
+@code{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 @code{ledger-post-amount-alignment-column},
+which defautls to 52. @xref{Ledger Post Customization Group}
+
 @node Editing Amounts, Marking Transactions, Adding Transactions, The Ledger Buffer
 @section Editing Amounts
 GNU Calc is a very powerful Reverse Polish Notation calculator built
@@ -439,7 +447,7 @@ If for some reason during reconciliation your target amount changes,
 type @code{t} and enter the new target value.
 
 
-@node The Report Buffer, Installing and Customizing Ledger-mode, The Reconcile Buffer, Top
+@node The Report Buffer, Customizing Ledger-mode, The Reconcile Buffer, Top
 @chapter The Report Buffer
 @menu
 * Running Basic Reports::       
@@ -552,36 +560,177 @@ it will reverse the order of the transactions and maintain the proper
 mathematical sense.
 
 
-@node Installing and Customizing Ledger-mode, Hacking Ledger-mode, The Report Buffer, Top
-@chapter Installing and Customizing Ledger-mode
+@node Customizing Ledger-mode, Generating Ledger Regression Tests, The Report Buffer, Top
+@chapter Customizing Ledger-mode
 @menu
-* Emacs Initialization File::   
 * Ledger-mode Customization::   
 * Customization Variables::     
-* Ledger-mode Faces::           
 @end menu
 
-@node Emacs Initialization File, Ledger-mode Customization, Installing and Customizing Ledger-mode, Installing and Customizing Ledger-mode
-@section Emacs Initialization File
-
-@node Ledger-mode Customization, Ledger-mode Faces, Emacs Initialization File, Installing and Customizing Ledger-mode
+@node Ledger-mode Customization, Customization Variables, Customizing Ledger-mode, Customizing Ledger-mode
 @section Ledger-mode Customization
-@node Customization Variables,  , Ledger-mode Customization, Installing and Customizing Ledger-mode
+
+Ledger-mode has several options available for configuration.  All
+options can be configure through the Emacs customization menus, or
+specified in your Emacs initialization file.  The complete list of
+options is show below. To change the option using the Emacs
+customization menu, simply choe customize in the Options menu and look
+for Ledger under the data options.  Alternately you can choose
+``Customize Specific Group'' and enger ``Ledger'' as the group.
+
+@node Customization Variables,  , Ledger-mode Customization, Customizing Ledger-mode
 @section Customization Variables
-@node Ledger-mode Faces,  , Customization Variables, Installing and Customizing Ledger-mode
-@section Ledger-mode Faces
+
 @menu
-* Using EMACS customization menus::  
-* Complete list of customization variables::  
+* Ledger Customization Group::  
+* Ledger Reconcile Customization Group::  
+* Ledger Report Customization Group::  
+* Ledger Faces Customization Group::  
+* Ledger Post Customization Group::  
+* Ledger Exec Customization Group::  
+* Ledger Test Customization Group::  
+* Ledger Texi Customization Group::  
 @end menu
 
-@node Using EMACS customization menus, Complete list of customization variables, Ledger-mode Faces, Ledger-mode Faces
-@subsection Using EMACS customization menus
+@node Ledger Customization Group, Ledger Reconcile Customization Group, Customization Variables, Customization Variables
+@subsection Ledger Customization Group
+@table @code
+@item ledger-default-acct-transaction-indent
+   Default indentation for account transactions in an entry.
+@item ledger-occur-use-face-unfolded
+   If non-nil use a custom face for xacts shown in `ledger-occur' mode using @code{ledger-occur-xact-face}.
+@item ledger-clear-whole-transactions
+   If non-nil, clear whole transactions, not individual postings.
+@item ledger-highlight-xact-under-point
+   If non-nil highlight xact under point using @code{ledger-font-highlight-face}.
+@end table
+
+@node Ledger Reconcile Customization Group, Ledger Report Customization Group, Ledger Customization Group, Customization Variables
+@subsection Ledger Reconcile Customization Group
+
+@table @code
+@item ledger-reconcile-default-commodity
+The default commodity for use in target calculations in ledger
+reconcile.  Defaults to $ (USD)
+@item ledger-recon-buffer-name
+   Name to use for reconciliation window.
+@item ledger-fold-on-reconcile
+   If non-nil, 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 xact in the recon
+   window.
+@item ledger-reconcile-force-window-bottom
+   If non-nil, make the 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 (@code{!}). If false
+   toggle between unlceared and cleared (@code{*})
+@end table
+
+@node Ledger Report Customization Group, Ledger Faces Customization Group, Ledger Reconcile Customization Group, Customization Variables
+@subsection Ledger Report Customization Group
+
+@table @code
+@item ledger-reports
+   Definition of reports to run.
+@item ledger-report-format-specifiers
+   An alist mapping ledger report format specifiers to implementing functions.  
+@end table
+
+
+@node Ledger Faces Customization Group, Ledger Post Customization Group, Ledger Report Customization Group, Customization Variables
+@subsection Ledger Faces Customization Group 
+Ledger Faces : Ledger mode highlighting
+@table @code
+@item ledger-font-uncleared-face
+Default face for Ledger
+@item ledger-font-cleared-face
+Default face for cleared (*) transactions
+@item ledger-font-highlight-face
+Default face for transaction under point
+@item ledger-font-pending-face
+Default face for pending (!) transactions
+@item ledger-font-other-face
+Default face for other transactions
+@item ledger-font-posting-account-face
+Face for Ledger accounts
+@item ledger-font-posting-amount-face
+Face for Ledger amounts
+@item ledger-occur-folded-face
+Default face for Ledger occur mode hidden transactions
+@item ledger-occur-xact-face
+Default face for Ledger occur mode shown transactions
+@item ledger-font-comment-face
+Face for Ledger comments
+@item ledger-font-reconciler-uncleared-face
+Default face for uncleared transactions in the reconcile window
+@item ledger-font-reconciler-cleared-face
+Default face for cleared (*) transactions in the reconcile window
+@item ledger-font-reconciler-pending-face
+Default face for pending (!) transactions in the reconcile window
+@item ledger-font-report-clickable-face
+Default face for pending (!) transactions in the reconcile window
+@end table
+
+@node Ledger Post Customization Group, Ledger Exec Customization Group, Ledger Faces Customization Group, Customization Variables
+@subsection Ledger Post Customization Group
+Ledger Post : 
+@table @code
+@item ledger-post-auto-adjust-amounts
+If non-nil, then automatically align amounts to column specified in
+@code{ledger-post-amount-alignment-column}
+@item ledger-post-amount-alignment-column
+The column Ledger-mode uses to align amounts
+@item ledger-post-use-completion-engine
+Which completion engine to use, iswitchb, ido, or built-in
+@item ledger-post-use-ido
+@end table
+
+@node Ledger Exec Customization Group, Ledger Test Customization Group, Ledger Post Customization Group, Customization Variables
+@subsection Ledger Exec Customization Group
+
+Ledger Exec : Interface to the Ledger command-line accounting program.
+
+@table @code
+@item ledger-binary-path
+Path to the ledger executable.
+@item ledger-init-file-name
+Location of the ledger initialization file. nil if you don't have one
+@end table
+
+
+@node Ledger Test Customization Group, Ledger Texi Customization Group, Ledger Exec Customization Group, Customization Variables
+@subsection Ledger Test Customization Group
+@table @code
+@item ledger-source-directory
+   Directory where the Ledger sources are located.
+@item ledger-test-binary
+   Directory where the debug binary.
+@end table
+
+@node Ledger Texi Customization Group,  , Ledger Test Customization Group, Customization Variables
+@subsection Ledger Texi Customization Group
+
+@table @code
+@item ledger-texi-sample-doc-path 
+Location for sample data to be used in texi tests, defaults to @file{~/ledger/doc/sample.dat}
+@item ledger-texi-normalization-args 
+texi normalization for producing ledger output, defaults to ``@code{--args-only --columns 80}''
+@end table
+
+@node Generating Ledger Regression Tests, Embedding Example results in Ledger Documentation, Customizing Ledger-mode, Top
+@chapter Generating Ledger Regression Tests
+
+Work in Progress.
+
+@node Embedding Example results in Ledger Documentation, Hacking Ledger-mode, Generating Ledger Regression Tests, Top
+@chapter Embedding Example results in Ledger Documentation
 
-@node Complete list of customization variables,  , Using EMACS customization menus, Ledger-mode Faces
-@subsection Complete list of customization variables
+Work in Progress.
 
-@node Hacking Ledger-mode,  , Installing and Customizing Ledger-mode, Top
+@node Hacking Ledger-mode,  , Embedding Example results in Ledger Documentation, Top
 @chapter Hacking Ledger-mode
 
+Work in Progress.
 @bye