home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 637a.lha / WBase_v1.2 / WBase.Doc.pp / WBase.Doc
Encoding:
Text File  |  1992-05-29  |  12.7 KB  |  329 lines

  1.  
  2.                             WBase V1.2
  3.                         © 1992 Simon Dick
  4.  
  5. This program uses reqtools.library and powerpacker.library.
  6. Also if it can't find reqtools.library then it tries to use
  7. kd_freq.library for its file requester (which isn't
  8. included, but is worth getting).
  9.  
  10. This program is Freeware which means that you can copy it
  11. and give it to anybody you want as long as you don't ask
  12. for any money for it except perhaps a small bit for disks
  13. and copying.
  14.  
  15. If WBase can't find reqtools.library then it will use its
  16. own requesters which aren't actually that good.
  17.  
  18. About WBase
  19. ===========
  20.  
  21.    I wrote this because I kept on finding that I needed to
  22. quickly use a database on Workbench but all of the others
  23. which I have got are all to large for my liking so I
  24. thought that I might as well write my own as I had already
  25. written one in AmigaBasic but which was much to slow to be
  26. really useful so I started to convert it to GFA Basic
  27. when I got it, but soon gave up and just rewrote it from
  28. scratch, here is the result. This will run if you have
  29. only half meg but will be most useful with more memory. I
  30. haven't been able to test this out thoroughly with
  31. Kickstart 2.0 yet, but I think it works though.
  32. ** PLEASE DON'T TRUST WBASE WITH ANY VITAL DATA UNLESS YOU
  33. ARE SURE THERE AREN'T ANY DANGEROUS BUGS IN IT, I AM NOT
  34. SURE IF I HAVE GOT RID OF ALL OF THE BUGS!!! **
  35.  
  36.  
  37. The Menus
  38. =========
  39.  
  40. File
  41.  
  42.  
  43.    New -   This lets you create a new database in memory.
  44.            You can have a maximum of 10 fields and a
  45.            maximum of 150 records. After finding out how
  46.            big a database you want it them goes and asks
  47.            you for each fieldname.
  48.    Load -  This lets you load a previously saved data
  49.            file. It handles both crunched and uncrunched.
  50.            It also does a bit of checking to make sure that
  51.            the file is valid.
  52.    Save
  53.       Crunched   - This saves a crunched version of the
  54.                    data which is currently stored in the
  55.                    memory. This only works if you have
  56.                    version 35 or above of
  57.                    powerpacker.library installed. It
  58.                    crunches it with best efficiency with a
  59.                    medium speedup buffer.
  60.       Uncrunched - This just saves out the data stored in
  61.                    the memory as an ASCII file which you
  62.                    can easily edit in any text editor if
  63.                    you don't like the editing in WBase.
  64.    Delete- This simply lets you delete a file from a disk,
  65.            it hasn't got anything to do with deleting
  66.            records from memory.
  67.    About - Tells you stuff like my address and the version
  68.            of WBase.
  69.    Quit -  This lets you exit from WBase (why would you
  70.            want to do that ?). You can also do this by
  71.            clicking on the close gadget, pressing escape or
  72.            pressing 'Q' while the window is active.
  73.  
  74.  
  75. Edit
  76.  
  77.    Record -   This lets you change the data which has
  78.               already been entered into memory.
  79.    Fieldname- This lets you change any of the current
  80.               fieldnames.
  81.    Delete
  82.       All            - If you select this it erases all of
  83.                        the records which where stored in
  84.                        memory (after making sure you
  85.                        didn't accidentally select it).
  86.       Section        - This lets you delete a section of
  87.                        records from memory (eg. from 1 to
  88.                        14 or 102 to 324).
  89.       Single record  - This lets you delete a single
  90.                        record, unfortunately you need to
  91.                        know the actual record number
  92.                        beforehand though.
  93.  
  94.  
  95. View
  96.  
  97.    All     - This lets you look through all of you records
  98.              one by one. There are the following options:
  99.                 F - Goes forward one record
  100.                 P - Prints the current record
  101.                 B - Goes back one record
  102.                 M - Lets you mark and unmark a record
  103.                 G - Lets you jump straight to a record by
  104.                     the record number
  105.                 D - Lets you delete the current record
  106.                 E - Lets you edit the current record
  107.    Section - This is done in the same way as the Delete
  108.              Section (I mean by entering the start and
  109.              finish record numbers not by deleting the
  110.              records) apart from that it has the same
  111.              options as View All.
  112.    Single  - You type in the number of the record that
  113.              you want to view. It has the following
  114.              options:
  115.                 P - Prints the current record
  116.                 F - } these don't do anything
  117.                 B - }
  118.                 M - Lets you mark a record
  119.                 D - Lets you delete the current record
  120.                 E - Lets you edit the current record
  121.                 Q - Lets you quit to the menu
  122.    Marked  - This lets you view all of the records which
  123.              you have marked and has the same options as
  124.              View Single has.
  125.  
  126.  
  127. Print (this menu can be disabled by using the Printer menu
  128.        item, see later for more information)
  129.  
  130.    All     - If you select this then WBase will ask you
  131.              if you are ready to print before printing
  132.              each record and also allowing you to cancel
  133.              printing that record.
  134.    Section - The same as the above except for being able
  135.              to choose a section of records to view.
  136.    Single  - This lets you view a single records by record
  137.              number.
  138.    Marked  - This lets you print all of the previously
  139.              marked records.
  140.  
  141.  
  142. Sort
  143.  
  144.    All     - All that you need to tell this options is
  145.              what field you want the whole file to be
  146.              sorted by.
  147.    Section - This works the same as the above except that
  148.              it asks for start and finish record numbers
  149.              as well and it only sorts the records between
  150.              those numbers (inclusive).
  151.  
  152.  
  153. Misc.
  154.  
  155.    Input Record    - This is one of the more important
  156.                      functions as it allows you to enter
  157.                      data into the data file which is
  158.                      currently in memory.
  159.    Search for data - This is mostly pretty straight
  160.                      forward except for one part, that is
  161.                      when it asks you for the field to
  162.                      search in, if you enter 0 there then
  163.                      it searches through all of the fields
  164.                      and not just by one. This has the same
  165.                      options as View Single has.
  166.    Palette        - If you have reqtools.library installed
  167.                      then this option will bring up a
  168.                      palette requester. Not much point to
  169.                      it in a database but it only added a
  170.                      few lines so I thought I might as well
  171.                      put it in.
  172.    Printer         - This simply toggles whether or not
  173.                      the Printer menu will be enabled or
  174.                      not. If there is a tick next to it
  175.                      then it is enabled.
  176.    Command         - If you select this it allows you to
  177.                      run normal DOS commands. If you run
  178.                      WBase from Workbench then it will
  179.                      open its own window to display the
  180.                      commands output (WARNING:don't use
  181.                      ARP's ARun command with the NOIO
  182.                      switch because it will crash when you
  183.                      quit or try to run a command thanks to
  184.                      the GFA-BASIC compiler.). Also if you
  185.                      type in '*' as a command a file
  186.                      requester opens up to let you choose a
  187.                      file.
  188.  
  189.  
  190. Marking Records
  191. ===============
  192.    As a new addition to this version you can now mark
  193. records whenever you are viewing records, even when you
  194. are viewing records which have been found by searching.
  195. Whenever you delete records all of your marks are erased.
  196. There are two new menu items to do with this, They are :
  197.           View Marked
  198.           Print Marked
  199.  
  200.  
  201. Other Features
  202. ==============
  203.  
  204.    So far there are only a few extra feature but they could
  205. come in handy. One simply scans six of the most common
  206. vectors in memory which viruses can use and tells you if
  207. they have been altered. I make no claim that WBase can
  208. replace a virus killer though, also it could be other
  209. programs that have altered them such as virus killers and
  210. recoverable ram disks so be careful when using this. The
  211. second is that WBase tries to trap guru meditations to let
  212. you save your data first, I'm not sure how well this works
  213. though. And the final one is PowerPacker file support if
  214. you have the powerpacker.library V33+ installed. If you
  215. have this then at the moment it will first try to decrunch
  216. it to T: then to RAM: and finally to DF0:. This is because
  217. I haven't worked out a way to read it straight from memory
  218. yet.
  219.  
  220.  
  221. Bugs
  222. ====
  223.  
  224.    I have found that when WBase is run for the first time
  225. on my machine you can't move, close or depth arrange the
  226. window, I don't know why this happens, but I think it is
  227. something to do with the GFA-Basic compiler. The strange
  228. thing is that if you quit from WBase and then load it up
  229. again then the window is alright. It works fine on the
  230. interpreter though! If anyone knows what is happening then
  231. please could you tell me so that I can try to fix it.
  232.  
  233.  
  234. Possible future improvements
  235. ============================
  236.  
  237.    An ARexx port (once I find out how to)
  238.    Including graphics as fields (what do you think? And how
  239.     could it work?)
  240.    Reading a powerpacked file straight from memory instead
  241.     of from a temporary file.
  242.    Any necessary bug fixes
  243.    Any other suggestions that you make.
  244.    (Please suggest something as I am running out of
  245.     ideas !!! I will try to include it if it is sensible
  246.     enough.)
  247.  
  248.  
  249.  
  250. Please send any bug reports, ideas about improvements,
  251. criticism (constructive), and anything else to:
  252.  
  253.  
  254.                         Simon Dick,
  255.                         31 Salisbury Road,
  256.                         Bexley,
  257.                         Kent,
  258.                         England
  259.  
  260. I will also be happy to try to help you if you can't work
  261. some function out, just write to me and I will try to help
  262. you out.
  263.  
  264.  
  265. If anyone is interested, I have just finished writing a
  266. test version of WNet, a file sender through the serial
  267. port, it also allows the sending of messages and commands,
  268. you can also get files from the other computer. If anyone
  269. would like to test it for me, I can't as I only have 1
  270. Amiga, please send a disk and postage and I will send you a
  271. pre-release test version.
  272.  
  273.  
  274. kd_freq.library is Copyright 1990,1991 Khalid Aldoseri.
  275.  
  276.  
  277. Changes from V1.1
  278. =================
  279.  
  280.  - I added support for reqtools.library instead of the
  281.    old req.library.
  282.  - A much better file requester thanks to reqtools.library.
  283.  - The search printed the records into the small window
  284.    instead of opening a new window for it.
  285.  - The 'Print Section' and 'Print Single' weren't
  286.    actually included accidentally.
  287.  - Before if you tried to load a crunched file which
  288.    wasn't a WBase file it wouldn't delete it from disk
  289.    which meant that you had a file called WB.tmp
  290.    floating around somewhere.
  291.  - You can now go forward AND backwards in the view and
  292.    search sections.
  293.  - You can now exit from viewing a section.
  294.  - Some functions didn't let you cancel them, this is
  295.    fixed now.
  296.  - If you select cancel after selecting 'New' your file
  297.    is now kept.
  298.  - You are asked if you are ready to print before printing
  299.    each record.
  300.  - Changed the position of the window slightly as it got in
  301.    my way.
  302.  - You can now delete records while you are viewing.
  303.  - You can also goto records while you are viewing all or
  304.    a section.
  305.  - And you can even edit records while you are viewing
  306.    them instead of having to remember which number they
  307.    where.
  308.  - I have included the option of marking records. You mark
  309.    records while you are viewing and you can then go back
  310.    and either view or print the marked records. When you
  311.    delete records the marks are all cleared.
  312.  - If you have reqtools.library installed then choosing
  313.    how many fields you want is made much easier (try it).
  314.  - You now have the option of crunching files before you
  315.    save them to disk. This only works if you have V35+ of
  316.    powerpacker.library installed. (It should have been
  317.    included with this program)
  318.  - Apart from using the menu to quit you can also press
  319.    escape or 'Q'.
  320.  - WBase is now more multitasking friendly. In previous
  321.    versions it just used a loop to check the menus, etc.,
  322.    but now it uses Wait() to wait for them. It also seems
  323.    slightly faster this way as well.
  324.  - The file requester remembers the last file and last
  325.    directory which were used and puts them ready in the
  326.    next file requester.
  327.  - WBase can now use the kd_freq.library file requester if
  328.    reqtools.library isn't found.
  329.