home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 8 / FreshFishVol8-CD1.bin / new / biz / dbase / quickfile / quickfile.doc < prev    next >
Text File  |  1994-10-23  |  37KB  |  1,061 lines
  1.   Quickfile v3.1 copyright 1992-1994 by Alan Wigginton
  2.  
  3. I accept no liability for any loss or damage resulting from the use of
  4. this program.  Users must evaluate the program and decide its usefulness
  5. for their own purposes.
  6.  
  7. QuickFile is not Public Domain, however it can be freely distributed
  8. provided all documentation and sample files are included unchanged.
  9.  
  10. QuickFile is a flexible, flat file database. It uses random access with
  11. indexing for fast access to records. Files can be larger than available
  12. ram, but as much of the file as possible is kept in ram to reduce disk
  13. accesses. Features include:
  14.  
  15.     - Multiple indexes with unique and non-unique keys
  16.     - Character, date, integer, floating point and calculation data types
  17.     - Up to 250 characters per field  and 250 fields per record.
  18.     - Form and list style displays and reports.
  19.     - Unlimited number of views of each file.
  20.     - Sort over any number of keys, ascending and descending order.
  21.     - Search operators include Like, Equal, Between, Sounds Like, Not Like
  22.       and Not Equal.
  23.     - Fields can be added, changed, or deleted at any time.
  24.     - ASCII export/import
  25.     - ulti column label printing.
  26.     - Multi-level grouping and totalling
  27.     - Any number of open windows
  28.     - Online context sensitive AmigaGuide help
  29.  
  30. System Requirements
  31.  
  32.     Any Amiga computer with 512K or more RAM
  33.     Workbench 2.04 or later
  34.     mathieeesingtrans.library
  35.     mathieeedoubbas.library
  36.     mathieeedoubtrans.library
  37.  
  38. QuickFile is written in C using DICE version 3.0.
  39.  
  40. ====== CONDITIONS OF USE =====
  41.  
  42. This version of the program is free, but please let me know if you find it
  43. useful - a postcard would be great.
  44.  
  45. Donations of money, stamps, software etc will be gratefully accepted. If
  46. you require bug fixes or support, please send $20.00 to the address below.
  47. Overseas users please use International money order or bank draft - not
  48. personal cheques. Any cash currency is OK, but send it at your own risk.
  49.  
  50.       Alan Wigginton
  51.       23 Carissa Street
  52.       SHAILER PARK
  53.       Queensland       4128
  54.       AUSTRALIA
  55.  
  56. I need feedback. Please let me know if you find it useful or I will assume
  57. I am wasting my time.
  58.  
  59. WARNING. QuickFile is a random access data base that buffers records in
  60.      memory. Failure to exit the program properly after updates are
  61.      made will result in lost updates.
  62. ALWAYS     exit the program before a reboot or power off.
  63. DO     backup your files regularly.  When backing up a data base make
  64.      sure you backup all of the files - definition, data and indexes.
  65.  
  66. To install QuickFile to a hard disk or floppy, drag the QuickFile icon to
  67. the drawer of your choice. If you want to use the AmigaGuide help system,
  68. copy QuickFile.guide to the same directory. To install AmigaGuide
  69. doubleclick on the InstallAmigaGuide icon.
  70.  
  71. Icons are not generated by the program. Sorry, but if you want them you
  72. will have to create them yourself.
  73.  
  74.  
  75. ===== About Views ======
  76.  
  77. Views allow you to display data from a file in different ways. There are
  78. two basic types FORM and LIST.
  79.  
  80. Each view has its own field titles, positions and lengths, window size and
  81. report details. Once you have a view set out the way you want it, you can
  82. save it for future use.
  83.  
  84. The Define View requester is used to select or change the fields included
  85. in a view. The positions of fields on a form can be changed by dragging
  86. them around with the mouse.
  87.  
  88. When you open a file, QuickFile looks for a view called filename.VIEW. To
  89. automatically use your favourite view, save it as filename.VIEW in the
  90. same directory as the data base.
  91.  
  92. If you want to keep things simple and are happy with the default view, you
  93. need not define a view at all.
  94.  
  95. Views are typically used to print labels, export or import selected fields
  96. or print lists containing only selected fields.
  97.  
  98. =========== Keyboard ===================
  99.  
  100. The following keys are available when the cursor is not in a string
  101. gadget (Press return to de-activate a string gadget):
  102.  
  103.    RETURN          Same as OK button
  104.    ESC              Same as CANCEL button
  105.    HELP           Displays help text using AmigaGuide.
  106.  
  107. The following keys can be used in string gadgets:
  108.  
  109.    TAB              Move to next field
  110.    Shift-TAB          Move to previous field
  111.    Down arrow          Move to next field
  112.    Up arrow          Move to previous field
  113.    Return          De-activate string gadget
  114.    right Amiga-X      Erase all text in the gadget (as does Control-X)
  115.    right Amiga-Q      Restores the text that was present before you
  116.               changed it.
  117.    Shift-left arrow   Moves the cursor to the beginning of the field.
  118.    Shift-right arrow  Moves the cursor to the end of the field.
  119.    Shift-Del          Erases all characters from the cursor to the end of
  120.               the gadget.
  121.    Shift-Backspace    Erases all characters to the left of the cursor.
  122.  
  123. ============== MAIN WINDOW =================
  124.  
  125. ===== Form Display ======
  126.  
  127. The FORM DISPLAY shows a single record per screen in the format specified
  128. by the current view.
  129.  
  130. Field positions can be changed by dragging fields around the window with
  131. the mouse.
  132.  
  133. To add or delete fields, change field titles or displayed lengths, press
  134. the VIEW button;
  135.  
  136. ===== List Display ======
  137.  
  138. The LIST display shows as many records as will fit in the window with a
  139. single line per record.
  140.  
  141. To update a record double click on it with the left mouse button
  142.  
  143. Before using the Modify or Delete buttons, select a record using a single
  144. press of the left mouse button.
  145.  
  146. ===== Buttons =====
  147.  
  148. GoTo
  149.   GoTo finds a record by key value using the current index. This makes
  150.   access extremely fast, even on large files.
  151.  
  152.   You only need to enter enough of the key to identify the record you
  153.   want, but you must start at the first key field.
  154.  
  155. Modify
  156.   Allows you to modify the current record. The horizontal scroll gadget
  157.   can be used to scroll the display and access fields that do not fit in
  158.   the window.
  159.  
  160. Insert
  161.   Displays a blank form for you to enter values for a new record.
  162.  
  163.   The Copy button will copy the contents of the previous record. This is
  164.   useful if you are entering records with similar values in some fields of
  165.   each record. Warning - it replaces anything currently on screen.
  166.  
  167.   Press Cancel (or ESC) to return to Browse mode.  NB When Cancel is
  168.   pressed any values displayed on the screen will be lost.  Press Insert
  169.   to insert the record, then Cancel.
  170.  
  171. Delete
  172.  
  173.   Deletes the current record. A requester is displayed to confirm.
  174.   Once the record has been deleted you cannot get it back.
  175.  
  176. Form/List
  177.   Toggles the current view between FORM and LIST formats.
  178.  
  179. View
  180.   Pressing the VIEW button displays the Define View requester with the
  181.   current view.
  182.  
  183. ===== Scrolling =====
  184.  
  185.   Scrolling is controlled by two slider type gadgets.
  186.  
  187.   Vertical Slider
  188.     This controls movement through the file and works in the usual way.
  189.     Scrolling may also be done using the up and down arrow keys for a
  190.     single record, or the shifted keys for a full screen.
  191.  
  192.   Horizontal Slider
  193.    If there are more fields than will fit in the current window, this
  194.    can be used to display the next group of fields.
  195.  
  196. ===========PROJECT  MENU ===================
  197.  
  198. OPEN
  199. Opens a new file in a new window.
  200.  
  201. LOAD
  202. Opens a new file, replacing the file in the current window.
  203.  
  204. SAVE
  205. Writes all updated blocks and indexes to disk.
  206.  
  207. CLOSE
  208. Writes all updated records and indexes to disk and closes the file and
  209. window.  Closing the last window will exit the program.
  210.  
  211. SAVE AS
  212. Creates a new file from the current file. Indexes for the new file are not
  213. created - they will be built when you first open the new file.
  214.  
  215. NEW
  216. Opens a new window for you to define a new file.
  217.  
  218. ALTER
  219. Displays the file definition panel for you to alter the current file
  220. definition. Note that the data and any updated views are saved first.
  221.  
  222. EXPORT
  223. Writes all, or selected, records to an ASCII file for exchanging data with
  224. other applications such as word processors, other data bases etc. The
  225. order and length of the fields in the export file is determined by the
  226. current view. Before doing the export, you may need to create a new view
  227. to give the record layout you want. See export section for details.
  228.  
  229. IMPORT
  230. Loads records from an ASCII file into your data base. The sequence