@database "KaiClock"
@node "Main"
@Master KaiClock.Guide
@author "Kevin Mckenna"
@$VER: 2.2
KaiClock 2.2 by Kai Software 1998

Welcome to the guide file for KaiClock 2.2

  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "Usage"}  Usage
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer
  @{" " link "History"}  History

Please read the sections above carefully before using KaiClock.
Please read Shareware and Copyright and Disclaimer information.

Thanks
-Gonzo- of Kai  26/6/98
@endnode


@Node "Intro"
Right, to start with, KaiClock is SHAREWARE
I now assume that you have read the SHAREWARE information and, the
condition of use.  If not do so now.

KaiClock is quite simply a digital clock for the Amiga (OS 2 and above)
Like most clock programs on the Amiga, it can be placed on the screen to
ascertain the time whenever you need it.  This is where most simalarities
end.

Ok, its only a digital clock, but, hey, I made it primarily for me, 
and I dont use analog clock programs (no offence, but I dont see the 
attraction of programs like TolleUhr - just me I guess!)

  @{" " link "Main"}  Index
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "SHAREWARE"}  Conditions of use
  @{" " link "Usage"}  Usage
  @{" " link "Copyright&Disclaimer"}  Copyright&Disclaimer
  @{" " link "History"}  History

@endnode

@Node "Features"

Features:

AppIcon Support
AppMenu Support
Upto 256 colours (AGA only)
Uses a nice font (on both Interlace and non-Interlace)
Can be placed anywhere on your workbench
Has a date and weekday function
Is configurable via tooltypes or a prefs program
Sets off an alarm every hour (configurable)
Alarm feature which displays a message of YOUR choice
Can have a Depth gadget, or not, (its up to you)
Low CPU usage
Has some nice MWB icons
Has some nice NewIcons

Anyway, thats most of the features.

  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Requirements"}  Requirements
  @{" " link "Usage"}  Usage
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer
  @{" " link "History"}  History

@Endnode

@Node "Usage"

KaiClock is mainly configured by use of Tooltypes.
These can be set with the prefs program I've made, though, it MAY not 
be available when you got KaiClock.

So I'll go over the tooltypes below:
(Its best, that when you cancel a tooltype, rather than just deleting 
it, just put brackets around it, this cancels it, but leaves the 
tooltype there, in case you want to use it another time, without 
trawling through these docs!)


DRAG
This tooltype either puts a dragbar on the window, or takes it off, 
when on, there is also a depth gadget.  The dragbar is the easiest way
to move the window around.

DATE
Either turns the date on or off, when its on, the window size will 
change, and the date will be placed under the time.  Kaiclock 
remembers where the window was, so, if the window appears, and it 
would go over the edge of the screen, it moves itself to the top left 
of the screen.  (this is a feature not a bug ok?)

WDAY
This places the weekday on the window (or takes it off), for this 
tooltype to work, the DATE tooltype must also be used, if DATE 
tooltype is not used, this tooltype will have no effect.

PLACE
This, I have found is the easiest way to place a window.  I used to 
use XPOS and YPOS, whereby you could just dump the numbers in, but, if
an unsuitable value (It went off screen) my Amiga GURU'd which really 
did get on my nerves after some time, so, instead, I decided to use 
the PLACE tooltype, it only has 4 values, 1 2 3 or 4
(Just the number)
1 = Top left of screen
2 = Top right of screen
3 = Bottom left of screen
4 = Bottom right of screen
If you want anywhere else, just use the drag bar

TEXTCOL
This is, as you might have guessed the text colour, you can have 
whatever colour from you rworkbench palette you want, you can pick it 
by entering a number between 0 and the number of colours available, on
an AGA, this can be upto 256.
The default value is 1 (Black)

BACKCOL
This, (like TEXTCOL) you might be able to guess for yourself, no?
Ok, this is the background colour, which has the same features of 
TEXTCOL, so read that.  The default is 0 (workbench background colour,
usuall grey)

ALARM
This can be ON or OFF, it turns the alarm on or off funnily enough.

ALARMSET
This can be any time in the day.
It goes in the format of:

HH:MM:SS

Where HH is the hour, MM is the minutes and SS the seconds.
One thing I should mention is, that each of the numbers, MUST be in 
double figures, so if you want the alarm to go off a 5 past 8 it would
be
08:05:00
NOT: 8:5:0
(Failure to set it properly, results in a failure for it to work)

MESSAGE
This can be ON or OFF, it turns the message on or off.

MESSAGESET
This is the message for MESSAGE
It can be as long as you set it.  To start a new line, use the |
(Thats the one next to DEL (with shift)

SCRIPT
This will turn on the script handling.
The Alarm feature must be active, so that when the alarm goes off,
the script can be executed.

SCRIPTNAME
Gives an alternative name for a script to be executed.
By default this is Kaiclock.scr and should be in the drawer
where KaiClock is.
The Script should be something like the startup-sequence
which can be executed... See the example below.

Script Example

Run >Nil: C:NewShell
Run >Nil: C:Fastview Work:Pics/Pic
C:Flush

APPICON
This is the appicon to use.
This appicon will be used when you put KaiClock to 'SLEEP'
Pick the info file to use, with the path, but DO NOT put the .info 
on the end of it.
I put the APPICON drawer in the same dir and use
APPICON=AppIcon/KaiApp

Anyway, the choice is yours

Below is an examples of these settings.

(DRAG)
(DATE)
(WDAY)
PLACE=2
TEXTCOL=1
BACKCOL=0
ALARM=ON
ALARMSET=08:05:31
MESSAGE=ON
MESSAGE=KaiClock V1.7c|by Kai Software
APPICON=AppIcon/KaiApp


What? Everything is set by tooltypes?
No.  There is also the pulldown menu, and the appmenu.

The pulldown menu is used to perform SOME of the above features.
The pulldown menu is laid out as:

Kai
Window

Kai
This has three selections available.
About
Sleep
Quit

About, gives some basic info
Sleep, places an appicon on workbench, and closes the window, its 
basically the same as quitting, but with the option of ressurecting it
later.  (Alarms do NOT work while it is 'sleeping')
Quit, quits.

Window, has four functions
Drag, same as the DRAG tooltype
Date, same as the DATE tooltype
Weekday, same as the WDAY tooltype
Place, same as the PLACE tooltype

Finally, however, there is the Appmenu.

On the normal Workbench menu, under TOOLS, you will get KaiClock Sleep
after starting the program, this works the same as the Sleep pulldown 
function.  Plus, when Kaiclock is 'sleeping' this will change to Wake 
KaiClock, so if there is a problem with the Appicon, you can still 
wake it up.

Thats it on the configurable stuff.

  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer
  @{" " link "History"}  History


@Endnode

@Node "Conditions"

Response on my previous programs has been pretty disappointing, when I
consider the time taken on them.  So I started to use Keyfiles, response
has picked up a little, however, I was still not satisified, as the keyfile
was easy to tamper with the keyfile to get it working.
So from now, I have intoduced a better keyfile system, which (I hope) will
not be breakable easily.

And thus, as I have spent a vast amount of time perfecting KaiClock to my
own strict requirements (See History)...

KaiClock is now SHAREWARE!

KaiClock will only cost you a measly £5.00

So, to recieve your keyfile, please pop £5 into an envelope, or cheques
and postal orders (Made out to Kevin Mckenna)

Then send it, with a note of your current setup, where you found KaiClock
What you thought of it, any bug reports or sugestions.
Then add the code:  KaiV2.2Clock
This will ensure that you will recieve the correct keyfile.

Also, you will recieve the latest version, and some other programs which
I have made that are still FREEWARE.

Send your registration to:

Kai c/o
Kevin Mckenna
11 Louis Braille Close
Netherton
Liverpool
L30 5SN   <----   (thats five S N)
ENGLAND
Also... 
I need feedback, I need to know if anyone is using my programs, because
if not I'll not waste my time on them, but rather carry on with some other
projects.   Even if you DONT want to register, please drop me a line and
give me some feedback!

  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "Usage"}  Usage
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer
  @{" " link "History"}  History

@Endnode

@Node "Requirements"
Requirements

You should have KaiClock.font in your FONTS: directory
You should have an appicon selected, but its not required.
To get the script working, you should have a script called KaiClock.scr
in the same directory.  This is until you change the script name via the
Tooltypes.

  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Usage"}  Usage
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer
  @{" " link "History"}  History

@Endnode

@Node "Copyright&Disclaimer"
Standard disclaimer:

THERE IS NO WARRANTY FOR THIS PROGRAM TO THE EXTENT PERMITTED BY APPLICABLE
LAW.  EXCEPT WHERE OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDER AND/OR
OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND,
EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.
SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY
SERVICING, REPAIR OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY REDISTRIBUTE THE PROGRAM
AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL,
SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR
INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR
DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.

Or in other words, it is all YOUR fault, you hear!

By using this program, you accept all blame and damages.

Copyright

a. This software is copyrighted by its developer(s). That means that you
   are NOT ALLOWED to modify the program(s) and documentation in any way.
   Especially you MUST NOT REMOVE the documentation or this text file.

b. You are NOT allowed to use this software or any part of it for any other
   purpose than that one mentioned in its documentation, this also includes
   any fonts,  images or samples.  If the developer(s)  did NOT include the
   source code of the program(s) in this package you are NOT allowed to de-
   compile any part of it.


  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Usage"}  Usage
  @{" " link "History"}  History
 
@Endnode

@Node "History"

This is version 2.2

KaiClock has undergone many changes since version 0.1
So below is a list of only the main ones

Version 0.1
KaiClock created, just a simple clock in a window
High CPU usage, ugly and loads of annoying bugs.

Version 0.4c
Arghh..
Lost source code in hard drive error.
Had to rewrite everything, using my basic Version 0.1
source code which was backed up to disk.
Therefore, some small changes which I haven't noticied

Version 0.8
Reorganised KaiClock, made it smaller, and changed the font
Added TOOLTYPE support

Version 0.9a
Changed the font again, and got rid of XPOS YPOS tooltypes
Put the PLACE tooltype in.

Version 1.2
Put a white background in, added Drag bar, date pulldown menu.
Pulldown menu has Quit and About
Annoying problem with About page.
Added procedure which used Topaz font if Kai.font was not found

Version 1.2b
Fixed About page bug.  Added Drag and Date to pulldown menu.

Version 1.4
Added Weekday
Added Force Topaz function to tooltypes under TOPAZ
Added Appmenu for Quit KaiClock

Version 1.4b
Added Weeday to pulldown menu, and fixed bugs with Weekday

Version 1.5
Added Hourly alarm to pulldown menu
Added Place to pulldown menu
Put in simple config file
(Intended to make prefs program)

Version 1.6
Removed config file.  Added different background and text colours.
Allowed colour changing to tooltypes
Removed TOPAZ feature
Fixed bugs
Rewrote sections of code to make it smaller with lower CPU usage

Version 1.7
Added Tooltype Alarm handling and message handling
Changed font for interlace use
Made prototype prefs program which writes tooltypes to icon

Version 1.7b
Added alarm variant which triggered a script to be executed
when the alarm went off.  Finished, but no way to control yet.

Version 1.7c
Changed font again
Simplified window handling code
Added AppIcon stuff, and changed AppMenu
Updated Prefs program to use APPICON tooltype.
Prefs still not finallised.
Still no way to control script execution yet, maybe

Version 2.0
A complete rewrite (seriously - it took ages)
The program was completely updated, to be faster, smaller with a
lower CPU usage, and with more features.  These are:

Changed font (for the last time hopefully)
Removed Hourly Alarm (well, just didn't put it in)
Dumped Alarm, Message and Script Handling features
Added simple error handling

Version 2.1
Added Commodity support

Version 2.2
Added Alarm, Message and Script Handling
Added keyfile and tamper proofing
Added information to About page

Thats it.  Theres some more smaller changes, but they are the
main ones.


  @{" " link "Main"}  Index
  @{" " link "Intro"}  Introduction
  @{" " link "Features"}  Features
  @{" " link "Requirements"}  Requirements
  @{" " link "Conditions"}  Shareware Information
  @{" " link "Usage"}  Usage
  @{" " link "Copyright&Disclaimer"}  Copyright & Disclaimer

@Endnode

@Endnode