home *** CD-ROM | disk | FTP | other *** search
/ Amiga MA Magazine 1998 #3 / amigamamagazinepolishissue1998.iso / bazy / b-base / birdbase.doc < prev    next >
Text File  |  1980-12-12  |  16KB  |  409 lines

  1.  
  2.  BIRD-BASE V1.1 (FEBRUARY 1996) Copyright © Marek Walford 1995-96.
  3.  
  4.  
  5.  What does it do?
  6.  ----------------
  7.  BIRD-BASE is basically a computerised version of a field checklist.
  8.  Obviously you couldn't take your Amiga into the field, this program is for
  9.  storing you British list, Year list, County list, the birds you've seen
  10.  while sitting on the toilet etc.. when you get home.
  11.  
  12.  BIRD-BASE enables you to enter the birds you've seen on your birding trips
  13.  by means of a simple interface; these are then added to your British list,
  14.  Year list or what ever else you had previously defined. In this way a
  15.  number of lists can be updated simultaneously. For instance if I saw a
  16.  Dodo at Holkham it would be added to my British List, County list and
  17.  Year list, but not my back garden list. 
  18.  
  19.  These sort of programs are widely available on the PC, both shareware and
  20.  commercial, yet there don't seem to be any on the Amiga. I hope Bird-Base
  21.  fills a gap in the market but if you do know of any such Amiga programs I
  22.  would like to hear from you.
  23.  
  24.  
  25.  Shareware
  26.  ---------
  27.  This program is shareware. This means if you like it and use it then you
  28.  should send the registration fee (a very reasonable £5.00) to one of the
  29.  addresses at the bottom of this page. In return you will receive the
  30.  latest version which will also have your name on the about window, WOW! 
  31.  
  32.  Send a cheque/postal order/euro cheque, cash (notes only and it's at your
  33.  own risk) for £5 (or more if you really want to) to one of the following
  34.  addresses, feel free to make comments or suggestions. No foreign cheques
  35.  or foreign cash please, it is a great hassle trying to change them.
  36.  
  37.  Home Address:                        Term Address:
  38.  
  39.  30 Smiths Lane                       110 Bevendean Crescent
  40.  Fakenham                             Brighton
  41.  Norfolk                              East Sussex
  42.  NR21 8LS                             BN2 4RD
  43.  England                              England
  44.  
  45.  Tel: 01328 862555                    Tel: 01273 383562
  46.  
  47.  Or you could E-Mail me at mw71@alpha2.bton.ac.uk
  48.  But I'll only be able to answer while I'm in Brighton.
  49.  
  50.  When ordering please include details about your Amiga (memory, hard
  51.  drives, workbench version etc) If you find any bugs (there shouldn't be
  52.  anything major, I've tested it enough) then please let me know. Also if
  53.  you don't want to reigster but have some constructive criticisms or
  54.  suggestions then please write, phone or e-mail.
  55.  
  56.  It would be better if you sent the order to my home address, there may be
  57.  a slight delay because I get my post from home sent to me once a week. If
  58.  you want to order while I'm at university and can't wait to get your
  59.  hands on this magnificent program then phone me first to make sure I'm
  60.  still living there or haven't been thrown off my course or run out of
  61.  money and died. I should be in Brighton till 1999. Incidentally, if by
  62.  some complete fluke somebody has got this program who is studying at
  63.  Brighton get in touch with me, cheers.
  64.  
  65.  
  66.  Copyright
  67.  ---------
  68.  The program "BirdBase" and all it's associated files are © Copyright 1996 
  69.  Marek Walford. The shareware version ONLY may be freely distributed
  70.  providing all files in the archive remain intact, these are:
  71.  
  72.  BirdBase1.1 - The Program
  73.  BirdBase.quide - The Guide File
  74.  BirdBase.doc - The Doc File
  75.  Bird.config - The Config file
  76.  DATA - Directory containing the example files
  77.  
  78.  No profit must be made by distributing BirdBase, the shareware version
  79.  may be freely spread providing the price of a disk containing BirdBase
  80.  does not exceed £3 (or equivelant currency). Please feel free to distribute
  81.  the shareware version of BirdBase over the internet and as part of CD-ROMS.
  82.  All rights for the fully registered version remain with the author, the
  83.  registered version MUST NOT be distributed, details of version and register
  84.  status are held in the About menu.
  85.  
  86.  The program is presented as is, no warranty is made of any kind, be it
  87.  expressed or implicit. Anyone using this program does so at their own risk.
  88.  In no way can the author be made responsible for any damage directly or
  89.  indirectly caused by the use or misuse of the program.
  90.  
  91.  "Amiga" is a registered trademark of Amiga Technologies GmbH.
  92.  
  93.  
  94.  Features
  95.  --------
  96.  Since the last release (version 1.0), Bird-Base has had a few new features
  97.  implemented and some of the code has been tweaked. Here are the most 
  98.  significant new features for this version:
  99.  
  100.  · The stats option has been updated to include the best year and day lists. 
  101.  
  102.  · The ability to add pictures has been expanded so you can now add pictures 
  103.    to individual birds rather than just one bird for the whole list. 
  104.  
  105.  · The search facility has also been improved so that you can now search for
  106.    a particular bird by name rather than having to enter a page number.
  107.  
  108.  · An extra function has been added to the PROJECT menu which enables you to
  109.    output your lists to ascii files and then load them into your favourite 
  110.    word processor.
  111.  
  112.  
  113.  Requirements
  114.  ------------
  115.  BIRD-BASE has no special system requirements and should work with any Amiga
  116.  with at least ONE MEG OF RAM.
  117.  
  118.  This version has been tested on the following systems:
  119.  
  120.  Amiga 1200 with 4 Megs of Ram.
  121.  
  122.  
  123.  Installation
  124.  ------------
  125.  BIRD-BASE can very easily be installed onto a hard disk.
  126.  
  127.  1. Create a new drawer on your hard disk (e.g B-BASE)
  128.  2. Copy all the files into your newly created drawer.
  129.  3. Add the following line to your user-startup:
  130.  
  131.         assign >nil: BIRD-BASE DH1:B-BASE/
  132.     
  133.  4. Reset your Amiga and when WorkBench boots click on the BirdBase icon.
  134.  
  135.  
  136.  The Future
  137.  ----------
  138.  I originally programmed BIRD-BASE for my own use but I intend to update it
  139.  if there is a demand. Please send any suggestions. But don't expect
  140.  miracles, it is written in Amos and I'm teaching myself as I go along so I
  141.  can't guarantee anything but I'll certainly try.
  142.  
  143.  I may do a PRO version which will have a complete British and Irish list
  144.  (about 550 species). It may also have detailed statistics on each species
  145.  so you could tell how many times you've seen a particular bird, what was
  146.  the earliest date you saw migrants? This version may cost more and I have
  147.  no idea when I will get round to doing it.
  148.  
  149.  
  150.  The Author
  151.  ----------
  152.  If you want to contact me then you have the choice of two addresses, 
  153.  although it is highly unlikely if I'll be at both at the same time. I am
  154.  currently studying BA Computing and Information Systems at the University
  155.  of Brighton. This is great because I get an e-mail address so you can mail
  156.  me if you like (mw71@alpha2.bton.ac.uk) I am also on the WWW if you want to
  157.  look at my poor excuse for a web page:
  158.  (http://www.comp.it.bton.ac.uk/~mw71).
  159.  
  160.  This superb piece of software was created on an Amiga 1200 with a 120 meg
  161.  hard drive, 4 megs of ram (2 megs of chip, 2 megs of fast), Star LC-10
  162.  printer, replacement mouse, akura TV and a ZipStik joystick (coz I like
  163.  playing games and I am a God at SWOS)
  164.  
  165.  I'd like to take this opportunity to thank Steve Hall for all the help he's
  166.  given me in trying to learn how to use Amos. Here is a quick mention to a
  167.  bunch of people who over the years I've come to regard as people I met:
  168.  
  169.  Chris, Dec, Seth, Ralph, Tony.
  170.  
  171.  I would also like to thank Commodore for bringing out the Amiga and Escom
  172.  for saving? it. I would finally like to say that PC's are crap!!
  173.  
  174.  
  175.  History
  176.  -------
  177.  V1.0 - First Public Release
  178.  
  179.  V1.1 - Major Update. Improved stats and search functions and output files
  180.         and picture links added as well as slight tweaking of the code.
  181.  
  182.  
  183.  Menu Options
  184.  ------------
  185.  Menu option: NEW
  186.  Icon: None
  187.  Function: Set up new database file.
  188.  
  189.  On selecting the NEW option you will be asked whether you want to clear the 
  190.  present data, this is so you can change the name of the lists whilst
  191.  keeping the data intact. If you answer N then all the data will be cleared
  192.  and you can enter the names for an entirely new database; if you answer Y
  193.  then the data will not be cleared but you can still change the names of the
  194.  lists.
  195.  
  196.  Menu option: LOAD
  197.  Icon: 2
  198.  Function: Load in a previously saved database file.
  199.  
  200.  On selecting this option a file requester will come up from which you can 
  201.  select the database file you wish to load.
  202.  
  203.  Menu option: SAVE
  204.  Icon: None
  205.  Function: Save the current database file under the current name.
  206.  
  207.  On selecting this option the currently loaded database will be re-saved 
  208.  under the filename it was loaded, or last saved as. Please note, no warning
  209.  is given before the database is saved! 
  210.  
  211.  Menu option: SAVE AS
  212.  Icon: 3
  213.  Function: Save the current database via a file requester.
  214.  
  215.  On selecting this option a file requester will come up from whuch you can 
  216.  select the file name you wish to save as. 
  217.  
  218.  Menu option: PRINT
  219.  Icon: 4
  220.  Function: Send the current list to a printer.
  221.  
  222.  On selecting this option you will be asked whether you are sure you want to
  223.  print. Press Y and the list will be printed out, press N and the operation
  224.  will be cancelled. Make sure that your printer is on-line before proceeding 
  225.  to print!
  226.  
  227.  Menu option: OUTPUT TO FILE
  228.  Icon: None
  229.  Function: Saves the current list as an ascii file for importing into a WP.
  230.  
  231.  On selecting this option a file requester will come up from which you can
  232.  enter the name you wish to save the list as.
  233.  
  234.  Menu option: DELETE FILE
  235.  Icon: None
  236.  Function: Deletes a file from disk via a file requester..
  237.  
  238.  On selecting this option a file requester will come up from which you can 
  239.  select the file you wish to delete. Be very careful when deleting files 
  240.  because you CANNOT get back what you delete.
  241.  
  242.  Menu option: ABOUT
  243.  Icon: None
  244.  Function: Brings up a window displaying information about the program.
  245.  
  246.  On selecting this option a window will come up dis[aying the program
  247.  version and a couple of other bits of useful information.
  248.  
  249.  Menu option: QUIT
  250.  Icon: 1
  251.  Function: Exits Bird-Base and returns to the workbench screen.
  252.  
  253.  On selecting this option you will be asked whether you are sure you want to 
  254.  quit; if you are then press Y and Bird-Base will quit, if not press N and
  255.  it won't. 
  256.  
  257.  You can also flip to workbench by using the far right icon or left Amiga
  258.  and M, but you must use left Amiga and M to flip back.
  259.  
  260.  Menu option: STATS
  261.  Icon: 5
  262.  Function: Display various statistics on the lists.
  263.  
  264.  On selecting this option a window will come up showing the number of birds
  265.  in each list as well as a few other facts about the lists.
  266.  
  267.  Menu option: NOTES
  268.  Icon: 8
  269.  Function: Displays previously edited notes on the current list.
  270.  
  271.  Text files can be linked to each list. This is to enable you to add any
  272.  additional notes, it can also be used to add any birds which are not in
  273.  the program.
  274.  
  275.  Text files must be saved in ASCII format (most WP can save in this format)
  276.  To link a text file to list number 1 you must call the file "1.txt" and
  277.  save it in the DATA/TXT drawer. Like wise if you want to link a text file
  278.  to list number 2 it should be called "2.txt".
  279.  
  280.  Menu option: CLEAR
  281.  Icon: 6
  282.  Function: Clear the data from the current list.
  283.  
  284.  On selecting this option you will be asked whether you are sure you want to
  285.  clear the current list. If you answer Y then the current list will be
  286.  cleared, if you answer N then it won't!
  287.  
  288.  Menu option: SEARCH
  289.  Icon: 7
  290.  Function: Search for a particluar bird.
  291.  
  292.  On selecting this option you can enter the name of the bird you wish to
  293.  search for. If the bird is found you will be moved to the corresponding
  294.  page.
  295.  
  296.  Menu option: NEW
  297.  Icon: None
  298.  Function: Create a new list.
  299.  
  300.  On selecting this option a window will come up from which you can enter a
  301.  number of details about the list: The Location, Date, Weather and Type.
  302.  The first three are fairly self explanatory. The "Type" is very important
  303.  because it determines which of the main lists will be updated.
  304.  
  305.  If you enter:
  306.  "COUNTY" then the County, County Year and Life lists will be updated.
  307.  
  308.  "SITE" then the Site, Site Year and Life lists will be  updated.
  309.  
  310.  "NORMAL" then just the Year and Life lists will be updated.
  311.  
  312.  If you don't enter anything at all (press Return) then NONE of the main
  313.  lists will be updated.
  314.  
  315.  Menu option: EDIT
  316.  Icon: None
  317.  Function: Edit the previously created list.
  318.  
  319.  On selecting this option a list of the birds contained within the program
  320.  are displayed, from which you can select the ones you've seen.
  321.  
  322.  Menu option: VIEW
  323.  Icon: None
  324.  Function: View the previously created list.
  325.  
  326.  On selecting this option the currently loaded list will be displayed.
  327.  
  328.  
  329.  Editing Lists
  330.  -------------
  331.  Before you edit any lists it is important that you have set up a new
  332.  database using the NEW option from the PROJECT menu.
  333.  
  334.  Once you have set up your lists you will see that they appear on both the
  335.  EDIT and VIEW menus. To edit one of the lists select it from the EDIT
  336.  menu, this will bring up a list of birds on the screen. To add one of
  337.  these birds to the list simply click on it with the left mouse button, it
  338.  will turn white, indicating that it has been added to the list. If you
  339.  want to remove a bird then simply click on it with the right button, it
  340.  will turn back to grey and consequently be removed from the list.
  341.  
  342.  This is the basic principle behind editing lists but there are also a few
  343.  options to help. The SEARCH option on the EDIT menu can be used to 
  344.  locate a particular bird. The arrow icons on the tool bar can be used to
  345.  move through the pages of birds, alternatively you can use the arrow keys
  346.  on the keyboard. To indicate what page you are on the page number is shown
  347.  on the right hand side of the status bar.
  348.  
  349.  
  350.  Viewing Lists
  351.  -------------
  352.  If you have set up some lists using the NEW option you will notice that 
  353.  they have appeared on the VIEW menu. To view one of the lists select it
  354.  from the VIEW menu and it will be displayed on the screen.
  355.  
  356.  If there is more than one page in the list you can use the ">" icon (or the
  357.  right arrow key on the keyboard) to go to the next page. Unfortuantly you
  358.  cannot go backwards as you can when editing lists, you will have to keep
  359.  going forwards until it loops round. 
  360.  
  361.  
  362.  Updating Lists
  363.  --------------
  364.  Lists are updated according to their type. When you first enter the names
  365.  of your lists using the @{"NEW" link new} option from the PROJECT menu you are
  366.  asked to enter names for the various list types. The predefined lists are
  367.  Life, Year, County, Site, Normal and Single. You can also have County Year
  368.  and Site Year.
  369.  
  370.  All lists are updated when you choose SAVE or SAVE AS from the PROJECT
  371.  menu. For example if you add a bird to your Year list when you select
  372.  save tbis bird will also be added to you Life list, if it not already
  373.  there. Lists are updated as follows:
  374.  
  375.  YEAR >>> LIFE
  376.  COUNTY >>> LIFE
  377.  SITE >>> LIFE
  378.  COUNTY YEAR >>> LIFE, YEAR, COUNTY
  379.  SITE YEAR >>> LIFE, YEAR, SITE
  380.  NORMAL >>> LIFE, YEAR
  381.  
  382.  
  383.  The Config File
  384.  ---------------
  385.  The config file should be in the Bird-Base directory and holds the
  386.  information telling Bird-Base where to look for pictures, text files
  387.  and the root directory for the saved files.
  388.  
  389.  You can edit this file in any text editor, so you can alter the name
  390.  and location of the save directories. Please be careful when editing
  391.  files and make sure you have made a back-up before you start altering
  392.  things.
  393.  
  394.  
  395.  Adding Pictures
  396.  ---------------
  397.  Pictures can be added to individual birds providing they are not in an
  398.  AGA screen mode (320x512 Half-Brite is recommended). Save the picture
  399.  into the DATA/PIC drawer as EXACTLY the same name which appears in the
  400.  program (including spaces). 
  401.  
  402.  To view the picture you must be editing the LIFE list. Press the SPACE
  403.  BAR and left click on the bird you want to view, if a picture file is
  404.  found it will be displayed. Press the left mouse button again to return
  405.  to the edit screen.
  406.  
  407.  
  408.  
  409.