update and sync the balance report documentation and sample.ledger

Ledger/Ledger.hs

@@ -162,88 +162,99 @@ printregister l = putStr $ showTransactionsWithBalances
 This and the helper functions below generate ledger-compatible balance
 report output. Here's how it should work:
 
-a sample account tree:
+A sample account tree (as in the sample.ledger file):
 
 @
-assets
+ assets
- cash
+  cash
- checking
+  checking
- saving
+  saving
-equity
+ expenses
-expenses
+  food
- food
+  supplies
- shelter
+ income
-income
+  gifts
- salary
+  salary
-liabilities
+ liabilities
- debts
+  debts
 @
 
-The standard balance command shows all top-level accounts:
+The balance command shows top-level accounts by default:
 
 @
-\> ledger balance
+ \> ledger balance
-$ assets      
+ $-1  assets
-$ equity
+  $2  expenses
-$ expenses    
+ $-2  income
-$ income      
+  $1  liabilities
-$ liabilities 
 @
 
-With an account pattern, show only the ones with matching names:
+With -s (--showsubs), also show the subaccounts:
 
 @
-\> ledger balance asset
+ $-1  assets
-$ assets      
+ $-2    cash
+  $1    saving
+  $2  expenses
+  $1    food
+  $1    supplies
+ $-2  income
+ $-1    gifts
+ $-1    salary
+  $1  liabilities:debts
 @
 
-With -s, show all subaccounts of matched accounts:
+- @checking@ is not shown because it has a zero balance and no interesting
+  subaccounts.  
+
+- @liabilities@ is displayed only as a prefix because it has no transactions
+  of its own and only one subaccount.
+
+With an account pattern, show only the accounts with matching names:
 
 @
-\> ledger -s balance asset
+ \> ledger balance o
-$ assets      
+  $1  expenses:food
-$  cash       
+ $-2  income
-$  checking   
+--------------------
-$  saving
+ $-1  
 @
 
-Elide boring accounts in two ways:
+- The o matched @food@ and @income@, so they are shown.
+
+- Parents of matched accounts are also shown for context (@expenses@).
+
+- This time the grand total is also shown, because it is not zero.
+
+Again, -s adds the subaccounts:
+
+@
+\> ledger -s balance o
+  $1  expenses:food
+ $-2  income
+ $-1    gifts
+ $-1    salary
+--------------------
+ $-1  
+@
+
+- @food@ has no subaccounts. @income@ has two, so they are shown. 
+
+- We do not add the subaccounts of parents included for context (@expenses@).
+
+Here are some rules for account balance display, as seen above:
+
+- grand total is omitted if it is 0
 
 - leaf accounts and branches with 0 balance or 0 transactions are omitted
 
 - inner accounts with 0 transactions and 1 subaccount are displayed inline
 
-so this:
+- in a filtered report, matched accounts are displayed with their parents
+  inline (a consequence of the above)
 
-@
+- in a showsubs report, all subaccounts of matched accounts are displayed
-a (0 txns)
-  b (0 txns)
-    c
-      d
-e (0 txns)
-  f
-  g
-h (0 txns)
-  i (0 balance)
-@
 
-is displayed like:
-
-@
-a:b:c
-  d
-e
-  f
-  g
-@
-
-If the overall balance of accounts shown is non-zero (eg when using filter
-patterns), display it:
-
-@
---------------------
-                   $
-@
 -}
 showLedgerAccountBalances :: Ledger -> Int -> String
 showLedgerAccountBalances l maxdepth = 

sample.ledger

@@ -6,30 +6,31 @@
 ;   checking
 ;   saving
 ; expenses
-;   banking
 ;   food
 ;   supplies
 ; income
+;   gifts
 ;   salary
 ; liabilities
 ;   debts
 
-2007/01/01 save
+2007/01/01 income
-    assets:saving  $1000
+    assets:checking  $1
     income:salary
 
+2007/01/01 gift
+    assets:checking  $1
+    income:gifts
+
+2007/01/01 save
+    assets:saving  $1
+    assets:checking
+
 2007/01/01 * eat & shop
     expenses:food      $1
     expenses:supplies  $1
     assets:cash
 
 2008/1/1 * pay off
-    liabilities:debts  $0.99
+    liabilities:debts  $1
     assets:checking
-
-2008/01/21 atm
-    assets:cash                               $40.00
-    expenses:banking                           $2.00
-    expenses:banking                           $2.00
-    assets:checking                          $-44.00
-