home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 1 / GoldFishApril1994_CD2.img / d4xx / d493 / bizcalc / bizcalc.doc < prev    next >
Text File  |  1991-06-06  |  12KB  |  242 lines
  1.                             BizCalc v1.1
  2.                             ~~~~~~~~~~~~                 
  3.         BizCalc may be freely redistributed. Enjoy and
  4.         pass it around with all the documentation files. 
  5.  
  6. This program is based on MortCalc, which was published on Fred Fish
  7. disk no. 385. I changed the name because some users thought that it was
  8. only for mortgage loans. Enter BizCalc, the do-it-all loan calculator!
  9.  
  10. For the Table to screen option, I used the code of Teks, Pierre
  11. Baillargeon's compact and yet user-friendly file reader. Iconify
  12. routine is from Leo Schwab, "the guy in the cape". 
  13.  
  14. WARNING
  15. ~~~~~~~
  16. The author of this program shall not be held responsible for any lost 
  17. incurred by users.
  18. Please don't blame me if some day your house is repossessed!  :^) 
  19.  
  20. OPERATION
  21. ~~~~~~~~~
  22.   -from the CLI:    BizCalc   [-option -option ...] 
  23.                     BizCalc ?                   This help screen 
  24.                                                       
  25.     Options:  (where N is an integer or decimal value)                
  26.          -pN  Principal N (decimal or integer)        
  27.          -rN  Rate N                                  
  28.          -lN  Length N (months)                       
  29.          -bN  Balance N                               
  30.          -cN  Compounded every N months  (default: 1 ; Canada, 6)  
  31.          -nN  N payments/year (default: 12)
  32.          -f   Change the default language from english to french  
  33.          -u   Send unformated data (6 decimals, not rounded) to
  34.               standard output (CLI).  Can be redirected to the printer
  35.               with the command line: BizCalc >PRT: -u.
  36.  
  37.    Why so many CLI options? So that you can run with your own values
  38.    from a directory utility like DiskMaster, SID, etc. Please note  
  39.    that "1w" and "2w" must be used for compounding periods less than 
  40.    one month. Example: 1> bizcalc -l48 -n52 -c1w 
  41.  
  42.   -from the Workbench: just double click on the icon. See PRESELECTION.
  43.  
  44.    Standard icon.library and mathieee.library are required; boot form a  
  45.    standard Workbench. Version 1.2, 1.3 and 2.0 are O.K.
  46.  
  47. BUTTONS AND BOXES  
  48. ~~~~~~~~~~~~~~~~~ 
  49. If you are fluent with Amigese, run BizCalc right away and read this
  50. doc later for the fine points.
  51.  
  52. Select the operation you want to do (the unknown value to calculate) by
  53. clicking in one of the buttons at the left (CAPITAL, RATE, LENGTH,
  54. BALANCE or PAYMENT). The amortization LENGTH is the length of the loan.
  55. The selected button stays highlighted and the message box confirms your
  56. selection. At startup, BizCalc will compute the monthly payments for
  57. the figures displayed in the value boxes (PAYMENT selected). 
  58.  
  59. To change a known value, select a box by clicking in it and edit the
  60. digits with the keyboard or the keypad (DEL, Backspace and the left and
  61. right cursor keys work the usual way). You may click CALCULATE anytime.
  62. [RETURN] is not needed to enter a value; however, it places the cursor
  63. in the next box. Also click CALCULATE whenever you loose the cursor. 
  64.  
  65. To clear a box, you may use the Right Amiga X combination (press X
  66. while holding down the right fancy A key). Clearing a box just makes
  67. room to enter a new value; to really change a value in memory, you have
  68. to click CALCULATE. This button enters all the displayed figures and
  69. the result is highlighted by the cursor in the selected value box.
  70.  
  71. Clicking on the CALCULATE button updates the display and formats the
  72. output with $, %, etc. The value boxes accept any character but will 
  73. read in only digits and decimal points. Naturally, any non-numerical
  74. entry may generate an error message.
  75.  
  76. When the RATE and BALANCE are computed, errors messages may be
  77. displayed if out-of-limits conditions are encountered.
  78.  
  79. The INTEREST box shows the cumulative interest amount paid. This is the
  80. only box that doesn't accept a direct input; this value is updated each
  81. time a new payment is calculated.
  82.  
  83. The PRINT button gets you a hard copy of all the values. This short
  84. list is different from the "Table to the printer" menu option.
  85. CAUTION: BizCalc will hang and wait if this option is selected while
  86.          the printer is not on line. 
  87.          This option is incompatible with the "Table to file" option. 
  88.  
  89. The "Compounded every" and "Number of payments/year" value boxes allow
  90. direct entry of integers or decimals values. This is the "expert" mode
  91. for those who know what they are doing. In a nutshell, in the U.S.A.,
  92. mortgage loans are compounded monthly, but semiannually in Canada
  93. (every 6 months). There are no such legal restrictions for personal
  94. loans; for instance, a weekly loan (52 payments/year) will normally be
  95. compounded weekly (1w).
  96.  
  97. If you don't feel ready for the expert mode, you might as well use the
  98. ">>>" buttons to select the correct values. Thus, BizCalc will accept
  99. "1w" for 0.2307692, which is the compounding factor for weekly loans.
  100. Or you may use the "Type of Loan" menu, which automatically puts the
  101. correct value in the "Compounded every" box, but only for mortgage
  102. loans, U.S.A. or Canada. Then, if the "Number of payments/year" is not
  103. 12, use the ">>>" buttons to set it.
  104.  
  105. To Iconify, click the upper right pictogram; you can move the icon around.
  106. To restore the display, double-click the icon.
  107.  
  108. To QUIT, hit the Close button in the upper left corner of the BizCalc
  109. window, or use the Project menu option. 
  110.  
  111. MENUS
  112. ~~~~~
  113.     Project Menu: Info help screen, Author's address, Calculate and Quit
  114.     commands. Keyboard shortcuts: Right Amiga I, A and C.
  115.  
  116. Amortization Table Menu: Click to toggle anoption on or off
  117. *To Screen:
  118.     Displays the list of all the payments in a small window. The computing
  119.     of the amortization table may take some time, especially if the number
  120.     of periods is over 100 (weekly loans, for instance). You can scroll up
  121.     or down the list with the proportional button to the right, with the up
  122.     and down arrow keys or by clicking up or down in the small window.
  123.     Memory is allocated dynamically, so BizCalc multitasks nicely with
  124.     other applications.
  125. *To Printer
  126.     Outputs a summary of the values and the complete table. It is advisable
  127.     to check the list on the screen first.
  128. *To File
  129.     Saves in the current directory the summary and the complete table in a
  130.     file whose name defaults to BCalc.lst. Works in append mode; all the
  131.     tables are joined one after the other if the file name is unchanged.
  132.     This is handy to update permanent files or if you change one or more
  133.     factor some year, like a lump sum payment on the anniversary of the
  134.     loan. To change the path or file name, edit the file name displayed in
  135.     the message box, for example: "dh0:finances/my_loan_table.lst", to save
  136.     your file in the Finance drawer of dh0:.
  137.     IMPORTANT: Type [RETURN] to enter the new file name.
  138.  
  139. Type of Loan Menu:
  140.     Canada option in the Mortgage submenu will change the default U.S.A.    
  141.     monthly compounding to legal canadian semiannually compounding. The
  142.     correct value is dispayed in the "Compounded every" box.  With the
  143.     startup values, PAYMENT is $132.15 (USA) and $131.04 (Canada). BizCalc
  144.     values have been verified with annuity tables and are very reliable. If
  145.     you have a weekly or biweekly loan, then use the ">>>" button to set
  146.     the "Number of payments/year" box to 52 or 26 weeks, respectively. 
  147.  
  148. SHORT CUTS 
  149. ~~~~~~~~~~
  150. To clear a box, you may use the Right Amiga "X" combination (press X
  151. while holding down the right fancy A key). The Right-Amiga "Q"
  152. combination undoes any change and gives you a second chance.
  153.  
  154. All the value boxes (exept LENGTH) need digits only, so you don't have
  155. to enter any comma, $ or % ; CALCULATE does that for you. 
  156.  
  157. As for the LENGTH box, it uses any non-digit character(s) to separate 2
  158. integer fields (years and months). So, the following entries are
  159. equivalent:
  160.             10 yrs 2 mo.
  161.             10 ans 2 mois
  162.             10/2
  163.             0y122        (122 months is 10 years and 2 months)
  164.  
  165. The years field is mandatory, but the months field is optional. Please
  166. note that the LENGTH box accepts integers only. All the other boxes
  167. take both integer and decimal values. BizCalc rejects negative values. 
  168.  
  169. You may operate BizCalc without the mouse if you use the arrow keys 
  170. within a box and the <RETURN> key to move from box to box. Place the
  171. mouse pointer on CALCULATE  and simultaneously press Left Alt and Left
  172. Amiga to simulate a mouse click...
  173.  
  174. CAUTION: The Right-Amiga C keyborad shortcut works as indicated, but a
  175. small bug eats up the cursor. Type Left Arrow to get it back without
  176. changing anything else. I didn't squash that bug because it has a handy
  177. side effect: the cursor will come back in the starting box instead of
  178. in the results box. Some users may actually prefer that. This shows
  179. quite appropriately that one man's bug may be another man's feature.
  180.  
  181. ROAD TEST 
  182. ~~~~~~~~~ 
  183. BizCalc can do a lot of things besides calculating your instalments.
  184. For instance, using the startup values, you may want to know how long
  185. it would take to pay the capital if the payments were set at $150. To
  186. find out, select the LENGTH box (unknown value), then edit the PAYMENT
  187. value box to $150.00 and click CALCULATE. 
  188.  
  189. You may wish to know the balance on a loan after, say, one year. Just
  190. select BALANCE as the unknown value and enter 1 in the LENGTH box. For
  191. lump sum payments, find the BALANCE at that date and subtract the lump
  192. sum amount. Then go on with these new values.
  193.  
  194. Watch out for asymptotic values or else, you may have to pay your
  195. mortgage for the whole eternity. For instance, select LENGTH as the
  196. unknown value and try to increment the CAPITAL until you get an error
  197. message (which will show up when the LENGTH exceeds 9999 months!). You
  198. will find out that at some point just before the error message, a
  199. difference of one miserable dollar in the principal adds *years* of
  200. payments. 
  201.  
  202. If you add fractions of cent (say $0.003) to the PAYMENT, you may
  203. notice an increment of a few dollars in CAPITAL. The rounding down of
  204. figures also explains why you may have in few cents left (or see a
  205. minus sign) in BALANCE when the amortization LENGTH is over. Use the
  206. CLI -u option (raw data) if you need a precision of six decimals.
  207.  
  208. BizCalc gives you all the figures you need to shop for a mortgage. You
  209. no longer have to take for granted everything your loan agent tells
  210. you, and you may even teach him a trick or two.
  211.  
  212. PRESELECTION OF DEFAULT VALUES 
  213. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
  214. You may change some startup values by editing the Tool Types box of the
  215. icon (Workbench ICON menu item). CAN=1 and FR=1 will change the
  216. defaults options to Canada and French, respectively. Delete these
  217. entries to get the default values (USA and English). Invisible language
  218. selection is a welcome feature in a small world like ours.
  219.  
  220. You may use the same tool to change the default startup values. For
  221. instance, typing in CAPITAL=44832.44, RATE=11.75, LENGHT=134,
  222. BALANCE=4000, COMP=2w, NPY=26 will start BizCalc with these values.
  223. Notes:  LENGTH has to be in months 
  224.         1w must be used for "one week", and 2w for "two weeks"
  225.         Lower/upper CASE are important!
  226.  
  227. AGITPROP 
  228. ~~~~~~~~ 
  229. The next version of BizCalc will incorporate a lot of new features, 
  230. like a complete set of help screens, file manipulation options, an Arp
  231. file requester to load and save config files, a file reader, amortization
  232. tables with actual calendar dates  and more. This version is available
  233. to registered BizCalc users only. So, if you use BizCals regularly, do
  234. yourself a favor and order BizCalc Professional by sending $15 to:
  235.  
  236.  
  237.                                             Michel Laliberté
  238.                                             875 Dollard
  239.                                             Outremont, Québec
  240.                                             H3V 3G8 Canada
  241.         Any comment is welcome.
  242.