home *** CD-ROM | disk | FTP | other *** search
/ 17 Bit Software 2: Collection B / 17Bit_Collection_B.iso / files / 1478.dms / 1478.adf / AmiBase.DOC < prev    next >
Encoding:
Text File  |  1990-06-06  |  19.4 KB  |  504 lines

  1. ****************************************************************************
  2.  
  3.  
  4.  
  5.                                Instructions for
  6.  
  7.                              AmiBase Version 3.76
  8.  
  9.                       Written,devised and programmed by
  10.  
  11.                            Keith Grant August 1989
  12.  
  13.   MY ADDRESS -                  15 LAUREL DRIVE
  14.                                   TILEHURST
  15.                                    READING
  16.                                   BERKSHIRE
  17.                                    RG3 5DY
  18.                                    ENGLAND.
  19.  
  20.  
  21. *****************************************************************************
  22.  
  23. New Relase: Version 3.76:
  24.  
  25. From 2.0 to 3.76! AmiBase is now much, much better! A major problem with 2.0
  26. was that it was written in one massive block of code. It is now written in
  27. loads of modules. This will allow many more records to be allowed into the
  28. program at one time.
  29.  
  30. I have also written a 'system setup' program which allocates the best amount
  31. of memory, depnding on how you answer the questions.
  32.  
  33. Some minor bugs have been ironed out, and AmiBase has just generally been
  34. cleaned up.
  35.  
  36.  
  37.     *************************
  38.     *P L E A S E  N O T E ! *
  39.     *************************
  40.  
  41. AmiBase Version 3.76 is now Shareware. I spent many, many hours splitting it
  42. into modules, and debugging etc. IF YOU USE AMIBASE AND FIND IT HELPFUL AND
  43. OF SOME USE TO YOU. PLEASE SEND A CONTRIBUTION TO ME (£5 OR ANYTHING ABOVE
  44. GRATEFULLY ACCEPTED) WHICH WILL ENCOURAGE ME TO WRITE MORE AND BETTER(?)
  45. STUFF; and to allow me to purchase better utils, and hardware for my Amiga
  46. which allows me to do so. Sending me a contribution will put you on my
  47. mailing list for future versions of AmiBase, and any other programs I do.
  48. MY ADDRESS IS AT THE BOTTON OF THIS DOCUMENT, AND ALSO ON THE 'ABOUT'
  49. SCREEN DISPLAY ON THE ACTUAL PROGRAM.
  50.  
  51.       P L E A S E  S U P P O R T  S H A R E W A R E  W R I T E R S !
  52.  
  53.                             T H A N K Y O U !
  54.  
  55.  
  56. YET ANOTHER NOTE:
  57. =================
  58.  
  59. If this doc. does not explain what you wish to know, or you have any
  60. problems, or if you discover ANY bugs (no matter how minor) then PLEASE
  61. write to me. Any communication is WELCOME. And I will reply to ALL letters.
  62.  
  63. Important Note!
  64. ---------------
  65.  
  66. If while reading this DOC you come across a place where it says the PATHS
  67. will be reset to default,IGONORE IT! IT will not happen,it has been
  68. ammended.
  69.  
  70.  
  71. ----------------------------------------------------------------------------
  72.  
  73.  
  74. AmiBase is a ShareWare database,with all the needed commands of a
  75. professional database.
  76. You can define upto eight different fields,and have as many records as you
  77. wish (memory permitting,of cause!)
  78.  
  79. This program is Shareware,and so can be swapped,copied,and used by anyone and
  80. everyone.It CANNOT be sold for any purpose by anyone.This rule does not
  81. apply to PD dealers who may charge a minimal copying fee,etc.
  82. This program was originally programmed for Ray Burt-Frost`s PD library,and
  83. so is the first and original distributor.
  84.  
  85. NOTE TO DISTRIBUTORS : This program must be distributed on it`s own disk as
  86. originally supplied.This document must also be kept intact on this
  87. disk.Failure to copy ALL files on this disk,will most probably result in the
  88. program not working 100% !
  89.  
  90. Anyway onto the instructions.The program itself is very simple and easy to
  91. use,and should be easy to get the hang of,using this document only as
  92. reference.Absolute beginners however should read all of this document.
  93.  
  94. AmiBase is a Menu/keyboard driven program.You select which option you want
  95. by means of pressing and holding the RIGHT mouse button,and moving the
  96. pointer over the bar at the top of the screen.
  97. There are three menus,these are :- PROJECT,AMMEND and MISC.
  98.  
  99. The commands on these menus are as follows:-
  100.  
  101. PROJECT MENU:
  102.  
  103. Make a new file
  104. Open an old file
  105. Save Current file
  106. Delete file
  107. Rename file
  108. Search for file
  109. Change Path
  110. Sort File
  111. Backup/duplicate file
  112. View Directory
  113. Move File
  114. About
  115. Quit
  116.  
  117. AMMEND MENU:
  118.  
  119. Add records
  120. Delete records
  121. Change record data
  122. Change file spec.
  123.  
  124. MISC MENU:
  125.  
  126. Next record
  127. Jump to record (X)
  128. Previous record
  129. First record
  130. Last record
  131. Print current record
  132. Print all records in file
  133. Clear file from memory
  134. List on a field
  135. Search file on a field
  136. Print current file spec.
  137.  
  138.  
  139. This document will now explain what each option does,and how to use it.
  140.  
  141.  
  142.  
  143. PROJECT menu : Option MAKE A NEW FILE
  144.  
  145. This is the option you select to initilize your own brand new file.
  146. If you have already got a file in memory when you select this option,and you
  147. have changed that file and not resaved it,you will be alerted and asked if
  148. you wish to cancel the option so that you can resave your file.This will
  149. happen as well on the following options : Open an old file,Backup/duplicate
  150. file.
  151. If you haven`t got a unsaved file,or you have already resaved it,the option
  152. will continue.
  153. It will then present a little window with the prompt `Please enter filename
  154. :`,here you type the name you wish to call your new file.Just type the
  155. name,don`t add any /`s or paths,because this is already done for you,and
  156. doing so will cause the program to report an error.
  157. You will then be asked how many records you want,this is just the
  158. initiation,it doesn`t mean how many record do you want,period,you can add
  159. records later.
  160. Then how many fields do you want.You can have a maximum of eight fields,this
  161. should be ample for everyone.Type a number between 1-8 (RETURN)
  162. You will then be asked for today`s date.This is simply for the creation
  163. date of the file.It effects nothing,and is simply for your reference.
  164. You will then be asked for a filenote.This is just like putting a COMMENT
  165. on a file in CLI,it is like the creation date,simply for your reference,if
  166. you don`t want one just hit return.
  167. Now you will be asked if all the data you have just typed in was
  168. correct,look under the window,and you will see all the data displayed in the
  169. black window,this appears as you type it in.Check the data,and if it is what
  170. you want,then type `y` or `yes` to the question.
  171. The screen will then clear,and a bigger window will appear,this is for
  172. typing in the name of your fields.You will be prompted as to what field
  173. number it is,and what you want to call it.Type in any name you wish,but I
  174. recommend keeping field characters to a minimum.As before,the data will
  175. appear under the window as you type,you will then be asked if the data below
  176. is correc,if you type `yes` or `y`,it continues,if you type `n` or `no` then
  177. you can retype the data.
  178. You will then be presented with a much bigger window,this is for typing in
  179. the actual record data.You will be told what record number it is,etc.When
  180. prompted,type in the data you want in each field.If you make a mistake,carry
  181. on,you can change it later with the `Change record data` option.
  182. When you have finished typing in the data,AmiBase will automatically save
  183. your new file to the path specified.Reporting it`s status as it does so.
  184. You have now finished initilizing your new file.It is now in memory and you
  185. can use all the options to manipulate it.
  186.  
  187.  
  188. PROJECT menu : OPEN AN OLD FILE.
  189.  
  190. Selecting this option with a unsaved changed file in memory will result in
  191. AmiBase giving you a warning and a chance to resave it,as explained in the
  192. Make a new file option.
  193. It will then warn you that the source and destination paths have been reset
  194. to default.This will be overcome in the next version.
  195. You will then be asked for the name of the file you wish to load into
  196. memory.Type the name with no /`s and paths as usual (e.g `File One`).AmiBase
  197. will then load the file.If it cannot be found an error will be found,and you
  198. told.If it is found.It will be loaded,showing the status.The program will
  199. then be memory to manipulate with all the options.
  200.  
  201.  
  202. PROJECT menu : SAVE CURRENT FILE.
  203.  
  204. If you select this option with no file resident in memory,you will be
  205. told,and returned to the main menu.The same applies if you haven`t changed
  206. the data in anyway.
  207. If you have changed/ammended the data in any way,the file will be resaved
  208. with the new data overwriting the old,display it`s status.You will then be
  209. returned to the main menu with the file still resident in memory.
  210.  
  211.  
  212. PROJECT menu : DELETE A FILE.
  213.  
  214. Having a file resident while selecting this does NOT effect the file.
  215.  
  216. Selecting this option will result in the usual small window
  217. appearing,asking for the name of the file you wish to delete.You will then
  218. be asked if you are sure that you wish to delete it.You answer by clicking
  219. in either of the two boxes displayed.One is `Ok,go ahead`,the other `Forget
  220. It!`,selecting Ok,go ahead will result in the file being erased from the
  221. current disk/path which cannot be returned.Selecting the other box (Forget
  222. it!) will result in the option being cancelled,and you being returned to the
  223. record you were last looking at (if you had a file in memory) otherwise it
  224. will return to the message asking you to make or open a file.
  225.  
  226.  
  227. PROJECT menu : RENAME FILE
  228.  
  229. Having a file resident while selecting this does NOT effect the file.
  230.  
  231. You will be asked for the filename of the file you wish to rename,you will
  232. then be asked for the new name you wish to call it.
  233. AmiBase will then rename the old file to the new name,this option does NOT
  234. change any other data in ANY way.You will be returned to the previous
  235. status.
  236.  
  237.  
  238. PROJECT menu : MOVE A FILE
  239.  
  240. This is used if you decide you wish to move a file to another path.
  241. You will simply be asked what filename and what path to move it to.
  242.  
  243.  
  244. PROJECT menu : CHANGE PATH
  245.  
  246. This option will allow you to change the current source and destination
  247. paths,I recommend that you do not do this and use this disk as it was
  248. designed with the directory `Datafiles` to store your files.But you may wish
  249. to change it,say if you have two drives,etc.
  250. It simply tells you what the current source/destination paths are,and then
  251. asks you for the new ones.Do not type a `/` at the end,as AmiBase does this
  252. automatically.So for example if you wanted to change the destination to
  253. `DF1:My Files` you would type exactly that,and NOT `DF1:My Files/`.
  254. You will then be returned to the previous status.
  255.  
  256.  
  257. PROJECT menu : SORT CURRENT FILE
  258.  
  259. This option sorts only the current file,so if you want a file sorted,open
  260. it first from the same menu,described above.
  261. It will sort the file either into alphabetical or numerical order depending
  262. on what data it comes across in the fields.If it finds numbers it will sort
  263. all the records into numerical order (smallest number will be record number
  264. 1).If it finds characters,which are normally the most common data,it will
  265. form all the records into alphabetical order.
  266. You can sort the file on any of your fields.(Max 8)
  267. AmiBase will ask you at the beginning what field you wish to sort the file
  268. on.(Printing all the fields for your reference.)
  269. You will then be returned access your file as usual,but now the file will
  270. be sorted.
  271. If you wish your file to be sorted on disk,you MUST resave it,after it has
  272. been sorted by using the `Save Current File` option,as described
  273. above.Amibase will warn you if you don`t and select a option which will lose
  274. the changes.You will then be given the chance to resave it.So don`t worry
  275. about forgetting to save it.Just always use the `Leave Database` option,as
  276. this will warn you.Resetting the computer won`t!!!
  277.  
  278.  
  279. PROJECT menu : BACKUP/DUPLICATE FILE
  280.  
  281.  After selecting this option you will be asked for the name of the file you
  282. wish to backup/duplicate.You will then be required to type the name you wish
  283. to call the duplicated file.Be careful not to use the same name as the
  284. original,as this would defeat the object of the option,although it would NOT
  285. lose you your file.You will then be returned to the previous status.
  286.  
  287.  
  288.   PROJECT menu : VIEW DIRECTORY
  289.  
  290.  
  291.  This simply does what it says,it will display a big window,which will then
  292. proceed in showing all the contents of the current SOURCE directory (default
  293. being `DF0:Datafiles/`) Clicking the left mouse button will close the window
  294. and return you to the previous status.You can select this option any when,as
  295. you can for the last six options.
  296.  
  297.  
  298.   PROJECT menu : ABOUT
  299.  
  300.  
  301.  This simply displays a window showing some credits,thanks,etc.Press the
  302. left mouse button to exit back to your file.It will not affect your current
  303. file in any way.
  304.  
  305.  
  306.   AMMEND menu : ADD RECORDS
  307.  
  308.  This option clears any files from memory,so make sure that you have resaved
  309. your ammended file,if you have one whilst selecting this option.
  310.  This will allow you to increase your file with more records,when the need
  311. arrives.
  312.  You will be asked for the name of the file you wish to add more records
  313. to,you will then be asked how many more records you want.You will then be
  314. presented with a big window and you will then be allowed to type in the
  315. data,exactly the same as when you made it with the `Make a new file`
  316. option.When you have finished,AmiBase will automatically save the new data
  317. at the end of the file under the same filename.That file will then become
  318. the current one.Allowing you to access it.YOU DO NOT HAVE TO RESAVE THE
  319. FILE.
  320.  
  321.  
  322.   AMMEND menu : DELETE RECORDS
  323.  
  324.  This option allows you to delete records from the CURRENT file,you will be
  325. asked how you wish to delete the records.You have two options here.One is to
  326. delete the records `one by one` which means AmiBase will go through the
  327. WHOLE file asking you whether you want the current record deleted,answer by
  328. pressing either the `y` or `n` key for yes and no respectively.
  329.  The other option is by entering the record number which you want to be
  330. deleted.AmiBase will then delete the record.
  331.  On both sub-options,there will be some disk accessing,AmiBase will need the
  332. master disk in DF0: for this operation.(Recommended to always use this
  333. disk!).Don`t panic it is not changing the current file which is on disk
  334. already,so you can delete records just in memory,and not bother resaving the
  335. data if you don`t want to.The original data will still be on the disk.If you
  336. do wish to save it with the deleted record(s) gone.Use the `Save current
  337. file` option as described above.
  338.  You will then be returned to the current file with the records missing from
  339. the file,because you just deleted them!
  340.  
  341.  
  342.   AMMEND menu : CHANGE RECORD DATA
  343.  
  344.  This option allows you to change the data in any record in the current
  345. file.For example you made a spelling mistake,and you just noticed it.You can
  346. select this option to ammend it.AmiBase will ask you if you wish to change
  347. the current record,that is the record you were last looking at.Press the `y`
  348. key or the `n` key for yes or no.If you select no,you will be asked for a
  349. record number.You will then be presented with the record data,as you will if
  350. you selected yes,you will be asked what field you want to change the data
  351. on.This is answered by typing 1-8 followed by enter.Typing one will change
  352. the first field,two,the second field,etc,etc.
  353. You will then be presented with a window,stating the current data in that
  354. field.You will then be asked for the new data,type it in and press
  355. return.The record will be reshown with the ammended field.You will be asked
  356. again for a field number,type `0` and return to exit back to previous
  357. status.(ACCESS mode)
  358.  You can then resave the data if you wish using the option in the PROJECT
  359. menu.If you don`t want to,just ignore any warnings.
  360.  
  361.  
  362.   AMMEND menu : CHANGE FILE SPEC
  363.  
  364.  This option really means `Change the creation data and/or the
  365. Filenote`,because the rest of the file specification can be changed with the
  366. other options.
  367.  You will be shown the current creation data,and asked if you want to change
  368. it,press `y` or `n` for yes and no,pressing `y` will result in you being
  369. allowed to type in the creation date,you will then be presented with the
  370. current filenote as you will if you just pressed `n`,you will be asked if
  371. you wish to change it.The results being the same as above.You will then be
  372. returned to ACCESS mode (previous status),you can then resave the file using
  373. the PROJECT menu.Or if not,ignore warnings.
  374.  
  375.  
  376.   MISC menu : NEXT RECORD
  377.  
  378.  This simply moves onto the next record in the current file.If you have
  379. reached the top of the file,you will be told.
  380.  A keyboard shortcut has been included for quick viewing,pressing the `n`
  381. key will result in the same way as selecting the option in the menu.
  382.  
  383.  
  384.   MISC menu : JUMP TO RECORD (X)
  385.  
  386.  This allows you to jump to any record in the current file,by simply typing
  387. it`s number in the window when asked.If you type past the files record
  388. range,a beep will be emitted,and you will be asked again.
  389.  
  390.  
  391.   MISC menu : PREVIOUS RECORD
  392.  
  393.  This moves back one record from the current record.E.G.If you are on record
  394. number 14,you will move back to record number 13.The keyboard shortcut is
  395. achieved by pressing the `p` key.
  396.  
  397.  
  398.   MISC menu : FIRST RECORD
  399.  
  400.  This simply displays the first record in the file.Pressing the `f` key has
  401. the same effect.
  402.  
  403.  
  404.   MISC menu : LAST RECORD
  405.  
  406.  This simply displays the last record in the file.Pressinhg the `L` key has
  407. the same effect.
  408.  
  409.  
  410.   MISC menu : PRINT CURRENT RECORD
  411.  
  412.  This option allows you to output the current records data to your connected
  413. printer.If you do not have a printer connected a error will be
  414. returned.Select your printer and the other options in preferences included on
  415. this disk.
  416.  You will then be asked for a title,if you don`t want one,just press RETURN.
  417.  The record(s) will then be printed via the printer.
  418.  When the task is completed,you will be returned to the previous status.
  419.  
  420.  
  421.   MISC menu : PRINT ALL RECORDS IN FILE
  422.  
  423.  
  424.  This option does exactly the same as the one above,but prints all the
  425. records.
  426.  
  427.  
  428.   MISC menu : CLEAR FILE FROM MEMORY
  429.  
  430.  
  431.  This will erase the current file from memory.If you have changed a file
  432. (ammended) then you will be warned.IF not,the command will be carried out
  433. straight away.
  434.  
  435.  
  436.   MISC menu : LIST ON A FIELD
  437.  
  438.  
  439.  This option will print all the data in one field in the current file.
  440. You will be asked what field you wish to list on.Press the required number
  441. (1 being the first field),AmiBase will then open a big window,and the data
  442. on that field will be listed.Once the end of the file is reached.Pressing
  443. the left mouse button will return to ACCESS mode.
  444.  
  445.  
  446.   MISC menu : SEARCH FILE ON A FIELD
  447.  
  448.  
  449.  This allows you to search for particular data on one field.For example,say
  450. you had a file set up for books you have read,and you wanted to find all the
  451. books written by Stephen King,you would type the number for the `Author`
  452. field,and AmiBase would then print every record it finds with that name in
  453. the `Author` field.Useful for finding records,etc.
  454.  
  455.  
  456.   MISC menu : PRINT CURRENT FILE SPEC
  457.  
  458.  
  459.  This simply provides reference on the current file,amount of fields,their
  460. names,current source/destination paths,etc,etc.Pressing the left mouse
  461. button will return you to ACCESS mode.
  462.  
  463.  
  464. ****************************************************************************
  465.  
  466.  
  467.  Well that`s about it,anything you don`t understand or you can`t get to
  468. work,write to me and let me know,I will do everything in my power to
  469. help/solve the problem.
  470.  
  471.  If you find ANY bugs no matter how small,please let me know,theres a free
  472. delivered copy of the new version for you,if you do.
  473.  
  474.  And if you have any ideas on how to improve AmiBase for later versions,let
  475. me know,and the above offer is the same.Fresh ideas from different people
  476. sometimes I don`t think of myself,everyone`s got differnent ideas,so let me
  477. hear them!
  478.  
  479.  If you get a error,click in the `DRUNKEN WISDOM` window and type RUN then
  480. hit return,and the progam will re-run.
  481.  
  482.  Write to me at the following address,or phone me up,ask for Keith.
  483.  
  484.  
  485.        Keith Grant,
  486.         15 Laurel Drive,
  487.          Tilehurst,
  488.           Reading,
  489.            Berkshire,
  490.             RG3-5DY,
  491.              England.
  492.  
  493.   Telephone : 422465
  494.  
  495.  
  496.      I hope AmiBase is useful and helpful to you.
  497.  
  498.  
  499.  
  500.               Thanks.........
  501.  
  502.  
  503.                      Keith Grant. Mayt 1990.
  504.