COUNTER v3.3a
=============

UPDATED RELEASE v3.3a
15/8/1996
REGISTERED RELEASE v3.3
1/6/1996

DISCLAIMER
==========
Counter v3.3.  This program is copyright Shane Brooks, 1996, and  is 
not supported by Monash University.

Although every endeavour has been made to ensure that counter V3.3 is 
bug free and stable, no warranty is given for any computer 
malfunction or data loss incurred whilst using Counter. Users of 
Counter v3.3 do so at their own risk.

IF THESE TERMS ARE UNACCEPTABLE you must  uninstall Counter v3.3 
immediately.

LICENSE CONDITIONS
==================
The evaluation copy of Counter v3.3 will not export data to an ASCII 
file.  This is the only feature that differs from the licensed copy.

You are entitled to copy and redistribute the evaluation copy 
freely, so long as this text file is distributed with the COUNTER.EXE 
executable and both the text file and executable remain unchanged.

The fully functional program costs $60 Australian for a single user 
license (one computer - multiple users) and A$150 for an unlimited
site license.  All proceeds are paid to Monash University and go
towards my current research programs as part reimbursement for my
time spend programming COUNTER.  COUNTER was developed by me 
personally as a hobby to assist my research, and is NOT a product of 
Monash University.

All registered users will be sent FREE updates whenever there are bug 
fixes or features added.

Until the end of 1997 - contact me at:

	Shane Brooks
	Dept. Ecology and Evolutionary Biology
	Monash University
	Clayton Campus
	Clayton 3168
	Australia 

If I leave in 1998 - I will leave a forwarding address.



INTRODUCTION
============
COUNTER v3.3 is a DOS software program that uses an IBM compatible 
computer as a multi-element digital lab counter.  Keyboard keys are 
assigned to up to 120 user configurable objects.  COUNTER keeps a 
database of counts for these objects for up to 898 samples that can 
be exported as an ASCII file and imported into most spreadsheet 
programs and statistical software.  Count data, objects and key 
assignments can be edited at any time, and multiple databases can be 
maintained on the computer.  The user can switch between samples or 
databases at any time.  COUNTER uses a 3 tier data backup strategy to 
maintain the data.  Data integrity is maintained even in the event of 
power failure.  All database backing up is automatic.

The program was originally written to count the abundances of 
different invertebrate species in stream benthic samples, but it 
could just as easily count seeds in soil samples, cells types in 
tissue cultures.... you get the picture.

COUNTER runs in DOS to make use of the many IBM XT and 286 computers 
that are gathering dust in laboratories and are now worth far less 
than mechanical laboratory counters (our last 5 element counter was  
$500.00, an IBM 286 is now about $50!).  All you need is enough bench 
real estate for the screen and keyboard (we stick the computer itself 
under the bench) - unless you have a notebook computer.


INSTALLATION
============
COUNTER v3.3 comes in a self extracting archive COUNT33.EXE.  When run, 
this will put the executable file COUNTER.EXE and a copy of this 
ASCII file COUNTER.TXT in the directory with COUNT33.EXE.  After 
verifying that COUNTER.EXE works, you may safely delete COUNT33.EXE.  A 
sample database SAMPLE.COU is provided for you to familiarise 
yourself with COUNTER.


FILES
=====
README.TXT      - Late breaking news READ THIS FIRST!!!!
COUNTER.EXE     - Counter v3.3 (in program path).
COUNTER.TXT     - This text file (in program path).
COUNTER.INI     - Saved defaults (in program path).
xxxxxxxx.COU    - Database file of item names (species names) 
			(in database path).
xxxxxxxx.COD    - Database file of counts for each item 
			(in database path).
xxxxxxxx.LOG    - automatic log of all changes made to database for 
		   emergency database restoration (in database path).
xxxxxxxx.BKN    - Auto-Backup copy of xxxxxxxx.COU (in backup path).
		   Can be simply renamed to xxxxxxxx.COU.
xxxxxxxx.BKD    - Auto-Backup copy of xxxxxxxx.COD (in backup 
		   path).  Can be simply renamed to xxxxxxxx.COD.



RUNING COUNTER
==============
The first time you run COUNTER.EXE you will be prompted for the 
default path for you database and backup files.

You will then be prompted to open a database.  You can search for an 
existing database (SAMPLE.COU), or simply type in a new name in the
filename box to create a new database.  The extension .COU will be
added automatically.

For a new database you will be prompted for a SAMPLE LABEL and then 
for the name of the first counter item.  This item will be given "1" 
as its counter key definition.  All subsequent addition to the 
counter will need count key definitions added manually <ctrl-K>.
You can edit the counter key definitions, item names, sample names at 
ANY TIME.

Every key press is written directly to the hard disk.  If the power 
goes off, you can just restart COUNTER and the program will pick up 
where it left off.


LIMITATIONS
===========
COUNTER v3.3 can only display 4 digits per item on the screen.  It 
will count beyond 9999, and you can manually edit data above 9999.  
If this is seen as a restrictive limitation, I will consider 
releasing an update (free) that can display more digits.  The big problem 
is just finding enough room on the DOS screen!.

COUNTER supports up to 998 samples (A convenient size to limit 
database files so they fit on a 360K 5.5" floppy disk for backing up)

COUNTER can count up to 120 items.  This limit is imposed by screen 
real estate only.

You can assign 90 Counter key definitions to the 120 objects (limited 
by number of keys on the standard IBM keyboard).  By all means have 
120 objects in the database and enter data manually for the 30 (rare 
items) that are left out (see below - EDIT DATA).


A FEW RULES OF THUMB
====================
NEVER separate the xxxxxxxx.COD and xxxxxxxx.COU files.  They are 
BOTH needed for each database.

You can have as many different databases as you want.  For example, 
one for each different experiment you conduct.

NEVER use SPACES in ITEM names or SAMPLE names.  Most statistical 
packages do not allow this anyhow.  Use a "_" instead.  COUNTER will
automatically convert spaces to "_" when you export data.

You can delete the xxxxxxxx.LOG file at will if it gets too big - but 
you are on your own if you need an emergency restoration.  Note this 
is SEPARATE and has NOTHING TO DO with the backup files xxxxxxxx.BKN 
and xxxxxxxx.BKD.

Backup manually <ctrl-B> whenever you change sorting trays, go on a 
break, get disrupted for a chat or whatever - just to be sure.

INVALID KEYS: Due to a quirk in the programming language, you can not 
use the   %   &  ( ' or , keys as counter keys.


THE SAMPLE DATABASE "SAMPLE.COU"
================================
Use the file menu OPEN/NEW command to open the SAMPLE.COU database.
This displays a few features and will allow you to become familliar
with COUNTER.

Notice that not all ITEMS need a counter key.  Rare occurences of
an item can easily be added manually at any time using EDIT menu,
EDIT DATA or <ctrl-D>.

You can use blank ITEM NAMES and "----------" as "Spacers" to make the
screen look tidy.  Any ITEM NAME entered starting with a "-" will
be convereted to "----------".
Any Item name starting with a "*" is considered a "Header".

Spacers and Headers are not exported to the ASCII file unless you have the
EXPORT KEY DEFINITIONS box checked.

You should try to EDIT the NAMES, KEYS and count DATA. (See below for
instructions.  ONCE YOU ARE IN EDIT MODE, YOU HAVE TO REPEAT THE
EDIT MENU COMMAND TO RESUME COUNTING.

the SAMPLE database contains 9 separate samples.  You can switch between
them using the EDIT, CHANGE SAMPLE command or <ctrl-C>.

After you have done some editing, you can look at the SAMPLE.LOG file
to see what info is written here.  This is a third level- last resort
"Oh my god I was not using the Autobackup feature!!!" source to allow
you to manually re-create your database if needed.


REARRANGING ITEM NAMES ON THE SCREEN/DELETING SAMPLES
=====================================================
In order to keep COUNTER v3.3 small and executing at a fast pace, I 
have not included these features in COUNTER v3.3.  It is a simple 
matter to export the data as a Comma Separated Value file and use any 
spreadsheet program to edit the row/column order in the ITEM x 
SAMPLE matrix before importing the new matrix back into COUNTER.

Remember to check the EXPORT KEY DEFINITIONS checkbox to export
your counter keys and screen spacers as well.

If there is sufficient demand for these features, I will consider 
adding them in a revised version at a later date.  But it would
take a lot of work :(

IMPORTING ASCII DATA
====================

Data files must be in either of the following formats.
	Comma Separated Value (.CSV)
	Space Delimited (.TXT)
	Tab Delimited (.TXT)
Although the import file box defaults to *.CSV you can enter any filename.
Files must be recatangular matrices with SAMPLES AS ROWS and
COUNTER ITEMS IN COLUMNS.
The first row must contain the counter item names.
Sample lables should have the header "Sample$".
If counter key assignments are to be imported also, they must be
  on the second row with the label "CountKey>".
The CountKey> row is OPTIONAL import data into Counter.
e.g.

Sample$   Species1  Species2  Species3  Species4
CountKey> q         w         e         r
Sample1   23        123       1234      654
Sample2   78        88        7         45
   "       "         "         "         "
   "       "         "         "         "
Samplex   xxxx      xxxx      xxxx      xxxx   		

EXPORTING ASCII DATA
====================
Spacers are item names entered as: "---------"
Headers are item names entered as" "*xxxxxxxx"

Spacers and Headers are not exported to the ASCII file unless you have the
EXPORT KEY DEFINITIONS box checked.

Exported ascii files are in standard Comma Separated Value (.CSV)
format and can be read into most spreadsheet and statistical packages.

What's New with release v3.3a
=============================

15/8/1996
Release Counter v3.3a
=====================
Added a "Convert Backup" button to the open database dialog box.
This enabled users to convert a backup file to a database,
regardless of whether the database is present on the system to
start with. - Usefull for transfering databases between computers
using the Backup files that are on the floppy disk.

Increased Data security:
    (1)  Added extra level of backup.  Existing Backup files
(*.BKN, *.BKD) are renamed (*.~~N, *.~~D ) and new backups are saved.
*.~~N and *.~~D are your "backup of your backup" files.  I did this
because if you exited Counter on discovering a problem, "AutoBackup"
would save the problem file over your good backup files. (In this
event the Data is still recoverable from the *.LOG file).
    (2)  To this end I added "KILL" to the File Menu.  Kill will exit
Counter WITHOUT SAVING A BACKUP.  IF YOU SUSPECT A PROBLEM WITH YOUR
DATABASE USE KILL TO GET OUT.  Make copies of all relevant files
(*.COD, *.COU, *.BKN, *.BKD, *.LOG, *.~~N, *.~~D) and ONLY THEN start
trying to restore your Database.  Then if you make any mistake you
have copies of all the important data files to fall back on.
	REMEMBER: *.BKN and *.~~N can be renamed to *.COU
		  *.BKD and *.~~D can be renamed to *.COD
    (3)  Increased frequency that item names are written to *.LOG file.
	Your *.LOG file is a 4th level last resort.

CONTACTING THE AUTHOR
=====================
Until the end of 1997, I can be contacted by e-mail at  
Shane.Brooks@sci.monash.edu.au

see the FILE menu - ABOUT

Please contact me if you have any comments, bug reports, criticisms, 
or notice any glaring omissions from the text file.
I can do customisations on request (for free if minor).   Any 
feedback is welcome.


THE EDIT MENU
=============
The <alt> key activates the menus - just like windows!

EDIT
-----------------
Add Item        -Appends a new item to all samples in the 
database.
Add Sample      -Adds a new sample to the database, resetting all 
		  screen values to zero.
Change Sample   -Switch between the stored samples.
Edit Sample Label       -as it says
-----------------
Edit Data       -Activates the EDIT DATA box. Just position the 
		  box with the arrow keys and enter the new data 
                  values. YOU MUST HIT THIS MENU OPTION AGAIN OR
		  USE THE SHORTCUT <CTRL-D> TO RESUME COUNTING.
Edit Names      -Activates the EDIT NAMES box. Just position the 
		  box with the arrow keys and enter the new name.  
		  YOU MUST HIT THIS MENU OPTION AGAIN OR USE THE 
		  SHORTCUT <CTRL-N> TO RESUME COUNTING.
-----------------
Counter Keys    -Activates the EDIT KEYS box.  Just position the 
		  box with the arrow keys and hit the new counter 
		  key.  <shift>-X is allowed.  YOU MUST HIT THIS 
		  MENU OPTION AGAIN OR USE THE SHORTCUT <CTRL-K> TO 
		  RESUME COUNTING.  Use the <space> bar to clear 
		  individual key definitions.  Counter will check 
		  for duplicate definitions.
Wipe Counter Keys       -Clears ALL key definitions.

-------------------------------------------------------------------

THE FILE MENU
=============
The <alt> key activates the menus - just like windows!

File
-----------------
Open/New        -Select a new database to count data for.  If you 
		  are starting a NEW database just enter a new name 
		  in the FILENAME box.
Save Backup     -Updates the BACKUP copies of your database.  Use 
		  this between sorting trays, when taking a break 
		  or whenever.  The if you make a load of mistakes 
		  or loose you place in your sorting tray you can 
		  use the "Reload from Backup" menu item to restore 
		  your database back to where it was the last time 
		  you backed up.  This backup is also done 
		  automatically if you have the Option 
		  "Autobackup" set, whenever you add a sample, 
		  change to a different sample, open a new 
		  database, or exit the program.
Reload from Backup      -Copies your backup files over the top of your 
			  database files BE CAREFULL HERE.
-----------------
Export          -Exports the entire ITEM x SAMPLE matrix, with or 
		  without counter key definitions, to an ASCII 
		  comma separated value file.  This file can be 
		  read into all(?)  spreadsheet packages and most 
                  statistical packages.
Import          -Imports a comma or tab separated value file, with 
		  or without counter key definitions.  IT IS 
		  IMPORTANT THAT YOU DO NOT HAVE SPACES IN YOUR 
		  ITEM NAMES OR SAMPLE LABLEL.  I would stick to 
		  Comma separated value files if you have any 
		  trouble.
-----------------
About           -My blurb
-----------------
Kill (NO Backup)-Kill will exit Counter WITHOUT SAVING A BACKUP.
                  If you suspect a problem with your database use
                  KILL to get out so that "AutoBackup" does not write
                  over your Backup files with a corrupt database.
                  There is still a 2nd Backup and the *.LOG file if
                  the primary Backup is corrupted.
		  In the event of a problem get out of Counter using
                  KILL.  Then make copies of all relevant files
                  (*.COD, *.COU, *.BKN, *.BKD, *.LOG, *.~~N, *.~~D) and
                  ONLY THEN start trying to restore your Database.
Exit            -Exit the program.

-------------------------------------------------------------------

THE OPTIONS MENU
================
The <alt> key activates the menus - just like windows!

Options
-----------------
File Paths      -Define your default database and backup file 
		  locations
Autobackup      -When this is checked (a little dot next to it) 
		  your database will be automatically backed up 
		  whenever you add a sample, change to a different 
		  sample, open a new database, or exit the program.
                  I STRONGLY SUGGEST YOU LEAVE THIS CHECKED!
Control Panel   -Sets screen colours.

-------------------------------------------------------------------
