home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / biz / misc / banker / docs / banker.doc next >
Text File  |  1993-12-16  |  16KB  |  473 lines
  1.  
  2.  
  3. *
  4.  
  5. Welcome to Banker!!!
  6. ********************
  7.  
  8.  
  9. Overview
  10. *********
  11.  
  12.    This manual describes *Banker*.  Banker is a program designed to
  13. help you keep an accurate track of your bank accounts.  Before going any
  14. further, if you are reading the file 'banker.doc', I must tell you that
  15. there is a much more comfortable to read this documentation :  use the
  16. Amigaguide format.  As you may have noticed, in the same directory is a
  17. file 'banker.guide'.  If you have an Amigaguide reader (the most
  18. powerful is Amigaguide but if you don't have it, see your public domain
  19. library for this, there are plenty of them in there!), you will enjoy
  20. immensely the ability to browse through this documentation using
  21. Hypertext...
  22.  
  23.    Banker's main features include :
  24.  
  25.   1. Entries can be entered as you choose it.  'Amount' and 'Dates' are
  26.      the only fields that are obligatory.  You are free to enter the
  27.      other ones if you wish (*note The New Entry Window::.).
  28.  
  29.   2. Three output formats are available :  Display Format, Print Format
  30.      and Export  Format (*note Output Formats::.).  You might want to
  31.      display on your screen only a limited number of information, but
  32.      may want to print the database fully (on a 132 columns printer for
  33.      example) and be able to save your file under another form
  34.      understandable by another program...
  35.  
  36.   3. Full 2.0 graphic user interface using MUI, the Magic User Interface
  37.  
  38.   4. Banker is fully localized (i.e.  can speak several languages :
  39.      French, English, Italian, Dutch, etc... *note Installing
  40.      Banker::.).
  41.  
  42.   5. Maximum use of the 2.0 OS features : IffParse(), ReadArgs(),
  43.      amigaguide.library, etc...
  44.  
  45.   6. User-definable autosave. No more data wasted because of an
  46.      unexpected power loss : Banker will save your file automatically.
  47.  
  48.  
  49.  
  50. Banker's legal status
  51. **********************
  52.  
  53.    This program is shareware and (C)1992 by Cédric BEUST. You may
  54. redistribute it freely provided :
  55.  
  56.   1. No benefits are made on it, and that the price asked doesn't
  57.      exceed the price of shipping and handling plus the one of the
  58.      supporting media.
  59.  
  60.   2. The distribution is given with every single file present and
  61.      unaltered. See the file Banker/FILES for a list of these files. 
  62.      My name and copyright notices must remain intact.
  63.  
  64.   3. If you find this program useful and have been using it for more
  65.      than a month, you are morally forced (we know what this means...)
  66.      to send me a reasonable amount of money ($10 seems fine to me, but
  67.      if you send more you will enter my "privileged users" list).
  68.      Please send dollars or French francs unless you really can't do
  69.      otherwise. I can be reached to the following address :
  70.  
  71.  
  72.    Cédric BEUST
  73. "Les Ducs de Savoie"
  74. 1, rue Roger Martin du Gard
  75. 06000 NICE
  76. FRANCE
  77. email: beust@sa.inria.fr
  78.  
  79.  
  80. Installing Banker
  81. ******************
  82.  
  83.    The operations needed to install Banker are very simple :
  84.  
  85.    * From CLI : Copy the files Banker and Banker.info into your
  86.      favorite directory, and copy the configuration file in your `s:'
  87.      directory :
  88.  
  89.      1> copy Banker <dest>
  90.      1> copy Banker.info <dest>
  91.      1> copy s/.bankerconfig s:
  92.  
  93.    * From Workbench : Simply drag the Banker icon into your favorite
  94.      directory. For the configuration file, it's hardly trickier :
  95.  
  96.        1. Select Window/Show all files from the Workbench menu
  97.  
  98.        2. Open the `s' drawer
  99.  
  100.        3. Double-click on the file `.bankerconfig' and replace
  101.           `.bankerconfig' with `copy .bankerconfig S:'
  102.  
  103.  
  104. The graphic interface
  105. **********************
  106.  
  107.    Banker uses MUI, the Magic User Interface by Stefan Stuntz for its
  108. interface. Thus, you must have the MUI package in order to be able to
  109. use Banker. It can be retrieved on aminet, or directly from the author
  110. if you have no net access. Read the file "Readme.mui" for more
  111. information on MUI.
  112.  
  113.    All you have to know of *gadtools* and *MUI* in order to use Banker
  114. is the following :
  115.  
  116.    * In string gadgets, all the characters are allowed. Hitting
  117.      *RETURN* will deactivate the string gadgets. Then you can use the
  118.      shortcuts if any are present (see below)
  119.  
  120.    * When you are in a string gadget, hit *TAB* to take the cursor to
  121.      the following string gadget (*Shift-TAB* will take you to the
  122.      previous one). When you reach the last one in the window, you are
  123.      taken back to the first (respectively the first to the last).
  124.  
  125.    * When all the gadgets are deactivated (i.e. the cursor doesn't
  126.      appear in any string gadgets), you are free to use the mouse or
  127.      the shortcuts. They are indicated by a word with a letter
  128.      underlined. You can press the underlined letter to obtain the same
  129.      result as if you had pressed the gadget with the mouse.
  130.  
  131.    * In every window, there are shortcuts that are always valid, even
  132.      though not clearly indicated. These are
  133.  
  134.         * *ESC* will make the window disappear (same as selecting the
  135.           gadget *Cancel* (NB : the name will be different if you chose
  136.           to use another language)
  137.  
  138.  
  139. Launching Banker
  140. *****************
  141.  
  142.    You can execute Banker either from CLI or from the Workbench. You
  143. have the possibility in either case to give arguments that give Banker
  144. different directives.
  145.  
  146.  
  147. From Cli
  148. =========
  149.  
  150.    If  you launch Banker with a single quotation mark as argument, you
  151. will have the following template :
  152.  
  153. 1> banker ?
  154. Language/K,File/K,OptionsFile/K:
  155.  
  156.    The meaning of these options is :
  157.  
  158.    * LANGUAGE :    Specify the language you wish to use, in case it is
  159.      different from the default locale. Note : this option will only
  160.      work if you're running Workbench 2.1 or higher (*note Notes for
  161.      2.1 users::.).
  162.  
  163.    * FILE :    Specify the file you want to load initially in Banker.
  164.  
  165.    * OPTIONSFILE :    Specify an alternate name for the default
  166.      configuration file (default is `s:.bankerconfig')
  167.  
  168.    For example, you might call Banker from CLI with the following
  169. syntax :
  170.  
  171. 1> banker FILE account.bank LANGUAGE italiano
  172.  
  173.    or
  174.  
  175. 1> banker OPTIONSFILE CFG:Banker.cfg
  176.  
  177. From Workbench
  178. ===============
  179.  
  180. Specifying arguments for Banker in the Workbench is accomplished through
  181. the `info' file. Click once on the Banker icon in order to activate it
  182. and then select Icon/Information from the menu (or press Right-Amiga
  183. I). A list of tooltypes appears. To add one, simply click on *Add* and
  184. type it in the activated string gadget. To modify an existing one,
  185. select it and do the same. See your Workbench Manual for more details.
  186.  
  187.    The tooltypes understood by Banker are the following :
  188.  
  189.    * LANGUAGE=<name>    Specify the language you wish to use, in case
  190.      it is different from the default locale. Note : this option will
  191.      only work if you're running Workbench 2.1 or higher (*note Notes
  192.      for 2.1 users::.).
  193.  
  194.    * FILE=<path>    Specify the file you want to load initially in
  195.      Banker.
  196.  
  197.    * OPTIONSFILE=<path>    Specify an alternate name for the default
  198.      configuration file (default is `s:.bankerconfig'
  199.  
  200.  
  201. The main window
  202. ****************
  203.  
  204.    This is the window that allows you to choose among the several
  205. features of Banker. It has menus and buttons.
  206.  
  207.  
  208. Menus
  209. ======
  210.  
  211.    The menus are the following
  212.  
  213.   1. The File menu
  214.         * Open          Open a new file. Its name will be indicated in
  215.           the title bar of the main window. If there is already a file
  216.           present in memory and if it has been modified, Banker will
  217.           issue a warning telling you you're about to lose data. If
  218.           it's not your intention, cancel the Open order, save your
  219.           file and then you can Open safely.
  220.  
  221.         * Save          Save current file to disk. If no name had been
  222.           given yet, a file requester appears.
  223.  
  224.         * Save as          Save the current file under a name queried
  225.           through the file requester.
  226.  
  227.         * Print          Print the current file through a file
  228.           requester (suggesting `PRT:' by default) using the format
  229.           specified in the *PrintFormat* variable (*note The
  230.           Configuration File::.).
  231.  
  232.         * Export          Export the current database to a format
  233.           specified in the *ExportFormat* variable (*note The
  234.           Configuration File::.).
  235.  
  236.         * Quit          Quit Banker. If there is already a file present
  237.           in memory and if it has been modified, Banker will issue a
  238.           warning telling you you're about to lose data. If it's not
  239.           your intention, cancel the Quit order, save your file and
  240.           then you can Quit safely.
  241.  
  242.   2. The Preferences menu
  243.         * Save          Will allow you to save the current settings to
  244.           the configuration file (*note The Configuration File::.),
  245.           mainly the positions of all the windows. Next time Banker is
  246.           started, the windows will be automatically positioned at the
  247.           place where you last moved them.
  248.  
  249.  
  250. Buttons
  251. ========
  252.  
  253.    The buttons perform the following actions :
  254.  
  255.    * New Entry    If you wish to add an entry to the current database,
  256.      select this button (*note The New Entry Window::.).
  257.  
  258.    * List Entries    Will take you to the List window in order to see
  259.      the contents of the current database, or to edit it (*note The
  260.      List Window::.).
  261.  
  262.    * Automatic credit/debit    If you wish to add a new Automatic entry
  263.      (that is : an entry that will be entered repeatedly and
  264.      automatically in the database), select this button (*note The
  265.      Automatic Entry Window::.).
  266.  
  267.    * Clear File    Will clear the current file, in order to start a new
  268.      one.
  269.  
  270.  
  271. The List window
  272. ****************
  273.  
  274.    This window gives you the full listing of your account until today.
  275.  
  276. The list
  277. ========
  278.  
  279.    The appearance of what you see will depend on the variable
  280. *DisplayFormat* (*note The Configuration File::.). The only constant
  281. thing is the character displayed on the first column, which is one of :
  282.  
  283.    * '+'      Indicate a line that was generated by an automatic entry
  284.      (*note The Automatic Entry window::.).
  285.  
  286.    * '*'      Indicate an entry that has not been validated by your
  287.      bank.
  288.  
  289.    * ' '      When no character is present, this entry was validated by
  290.      the bank
  291.  
  292. Validate/Edit/Delete
  293. ====================
  294.  
  295.    The cycle gadget at the bottom of the window can alternate between
  296. three states. Depending on its value, clicking on one of the displayed
  297. lines will have a different behavior :
  298.  
  299.    * Validate  Validate this entry. The 'Validated total' gadget at the
  300.      bottom will be updated accordingly immediately.
  301.  
  302.    * Edit      Edit this entry. If you click on a regular entry, you
  303.      will be taken to the window editing a new entry (*note The New
  304.      Entry Window::.) but if this entry was generated by an automatic
  305.      entry, you are actually asking to edit the automatic entry (*note
  306.      The Automatic Entry Window::.).
  307.  
  308.    * Delete    Delete this entry. A warning will appear so you can
  309.      confirm your action. If you select an automatic entry, you're
  310.      actually asking the automatic entry to be removed, and therefore
  311.      all the generated entries. Use this option with great care!
  312.  
  313. The total
  314. =========
  315.  
  316.    Down on the right are two figures that represent the state of your
  317. account.
  318.  
  319.    * Validated    All the entries that were validated by your bank.
  320.      After you correctly updated these entries, the figure indicated
  321.      must match the one your bank is giving you.
  322.  
  323.    * Total        This is the actual total of what your account is (that
  324.      is, the validated total plus the new entries that were not
  325.      validated yet)
  326.  
  327.  
  328. The New Entry window
  329. *********************
  330.  
  331.    This window allows you to enter a new entry. Its use is rather
  332. straightforward. The only mandatory fields are "Date" and "Amount". You
  333. can fill in the other fields depending on the value of your format
  334. variables (*note The Configuration File::.).
  335.  
  336.    To specify a debit in your account, enter a negative figure in the
  337. "Amount" gadget.
  338.  
  339.  
  340. The New Automatic Entry window
  341. *******************************
  342.  
  343.    This window allows you to enter a new automatic entry. Automatic
  344. entries are used when an amount is regularly credited (or debited) to
  345. your account. In this window, you can specify :
  346.  
  347.    * The amount (may be negative to specify a debit)
  348.  
  349.    * The delay between two entries
  350.  
  351.    * The fields defining the Reason and the Imputation of the generated
  352.      entry. You're free not to fill these fields.
  353.  
  354.      These automatic entries will generate entries that will be
  355.      signaled by a '+' in the List Window (*note The list window::.).
  356.  
  357.  
  358. The configuration file
  359. ***********************
  360.  
  361.    Banker can be customized in a simple yet flexible way.
  362.  
  363.  
  364. Output formats
  365. ***************
  366.  
  367.    There are three output formats controlled by three variables :
  368.    * listformat    Control the entries displayed in the List Window
  369.      (*note THE LIST WINDOW::.)
  370.  
  371.    * printformat   Control how the entries are printed (*note Menus::.)
  372.  
  373.    * exportformat  Control how the entries are exported(*note Menus::.)
  374.  
  375.      These three variables must respect a certain syntax. Each string
  376.      that you wish to include as is must be enclosed in quotation marks
  377.      ("). Any words not enclosed in quotation marks must be one of the
  378.      following :
  379.  
  380.         * Date, Imputation, Reason, Amount, Transaction
  381.  
  382.         * Any valid escape sequence from MUI's font engine
  383.  
  384.      In order to have the list of these sequences, read the file
  385.      font_engine.doc in the Docs/ directory.
  386.  
  387.      Example :
  388.  
  389.      displayformat "<ESC>b" date "<ESC>n | $" amount " | " reason
  390.  
  391.      will display the date in bold, followed by a vertical bar, then a
  392.      dollar, the amount, another bar and the reason field.
  393.  
  394.      NOTE: <ESC> must be replaced with a *real* ESC character
  395.  
  396.  
  397. Date formats
  398. *************
  399.  
  400.    You can ask Banker to display dates in many different formats.
  401. Depending on your Workbench version, not all the formats will be
  402. available.
  403.  
  404.    * Workbench 2.0
  405.  
  406.    * Workbench 2.1 and 3.0
  407.  
  408.  
  409. Windows open
  410. *************
  411.  
  412.    Here you specify which windows you want to find open when you start
  413. Banker. For example :
  414.  
  415.    mainwindow 1
  416. automatic 1
  417. list 1
  418. getEntry 0
  419. will display all the windows except the one where you enter a new entry.
  420.  
  421.  
  422. Autosave
  423. *********
  424.  
  425.    Set the autosave interval in minutes. For example :
  426.  
  427.    autosave 2
  428.  
  429. Notes for 2.1 users
  430. ********************
  431.  
  432.  
  433. Future enhancements
  434. ********************
  435.  
  436. Whereas primarily written for my own use, Banker quickly appeared as a
  437. program that might beneficiate from an intensive work and become a very
  438. powerful tool. Depending on the level of interest of this first version,
  439. next versions of Banker will incorporate the following features :
  440.  
  441.  
  442. Index
  443. ******
  444.  
  445. * Menu:
  446.  
  447. * Arguments:                            LAUNCHING BANKER.
  448. * Changing the configuration file name: FROM WORKBENCH.
  449. * Changing the configuration file name: FROM CLI.
  450. * Export:                               Menus.
  451. * File menu:                            Menus.
  452. * gadtools:                             OVERVIEW.
  453. * gadtools:                             THE GRAPHIC INTERFACE.
  454. * Installation:                         INSTALLING BANKER.
  455. * Introduction:                         OVERVIEW.
  456. * Invisible shortcuts:                  THE GRAPHIC INTERFACE.
  457. * Launching from CLI:                   LAUNCHING BANKER.
  458. * Launching from Workbench:             LAUNCHING BANKER.
  459. * locale:                               OVERVIEW.
  460. * Open:                                 Menus.
  461. * Overview:                             OVERVIEW.
  462. * Print:                                Menus.
  463. * Quit:                                 Menus.
  464. * Save:                                 Menus.
  465. * Save as:                              Menus.
  466. * Shortcuts:                            THE GRAPHIC INTERFACE.
  467. * Specifying an initial file:           FROM CLI.
  468. * Specifying the language:              FROM CLI.
  469. * String gadgets:                       THE GRAPHIC INTERFACE.
  470. * TAB:                                  THE GRAPHIC INTERFACE.
  471. * Tooltypes:                            LAUNCHING BANKER.
  472.  
  473.