home *** CD-ROM | disk | FTP | other *** search
/ Gold Fish 2 / goldfish_vol2_cd1.bin / files / util / wb / iconcalendar / iconcalendar.doc < prev    next >
Text File  |  1994-06-26  |  5KB  |  147 lines

  1.  
  2.                          IconCalendar 1.0
  3.  
  4.                    Copyright © 1994 Mika Kuulusa
  5.                       Written by Mika Kuulusa
  6.                         Released: 22-Jun-94
  7.  
  8.  
  9. DISTRIBUTION
  10.  
  11.     IconCalendar is CardWare. That means it is freely distributable, but
  12.     if you really like it, ought to send me a POSTCARD! My address is in
  13.     the end of this document.
  14.  
  15. DESCRIPTION
  16.  
  17.     This user-friendly utility gives your Workbench a nice touch:
  18.     it displays the number of the day in month as a nice AppIcon, and
  19.     the icon has the name of the month.  The user may translate month
  20.     names as he/she wishes, by writing the translations as arguments
  21.     in CLI or as tooltypes in Workbench (e.g. month January could be
  22.     translated to "Janvier" (French) or "Januari" (Swedish)).
  23.  
  24. REQUIREMENTS
  25.  
  26.     OS2.x or higher required. In order to use the program, Workbench
  27.     must be running, because IconCalendar uses an AppIcon.
  28.  
  29.     The program takes only about 12k bytes of memory when running.
  30.  
  31. INTRODUCTION
  32.  
  33.     As I use   cm   (calendar manager) in Sun Sparc workstations, it 
  34.     occurred to me that there was no such utility for Amiga that shows 
  35.     the date so nicely, on the background. Actually   cm   is much more
  36.     than just an icon on the background, it is a scheduler, too.
  37.  
  38.     After some careful planning I decided to program it, just for fun!
  39.     I cold bloodedly used   xv   to grab the icon from the Sparc. Then
  40.     I modified it a bit and also made those number fonts used in it.
  41.     Then I made some test with timer.device and other resources I needed,
  42.     tested it and gave it some finishing touches.
  43.  
  44.     I have still one remark to make: if you get the same good feeling 
  45.     about this nifty utility like I do, use it, and really like it...
  46.     DO SEND ME A POSTCARD! That way I know that people really use it
  47.     and maybe, just maybe, I could make an update some day...  ;-)
  48.  
  49.     My address is in the end of this document.
  50.  
  51. INSTALLATION
  52.  
  53.     From Workbench:
  54.         Just drag IconCalendar icon to the place where you want to use
  55.         it from. If you drag it to the WBStartup drawer, it will be executed
  56.         every time you boot your system.
  57.  
  58.     From CLI:
  59.         Copy "IconCalendar" file to a directory that is in your command
  60.         path (e.g. C:).
  61.  
  62.     I suggest you use IconCalendar with its icon from Workbench. By using
  63.     it this way, modifying the translations is *much* easier with tooltypes
  64.     than it is with command-line arguments.
  65.  
  66.  
  67. USAGE
  68.  
  69.     From Workbench:
  70.         Doubleclick the icon, and the AppIcon appears. You may modify the
  71.         tooltypes by selecting the IconCalendar icon and using 
  72.         "Information..." from the Workbench menu. 
  73.  
  74.     From CLI:
  75.         Simply execute the program by writing "IconCalendar". Arguments
  76.         are written after the commandname.
  77.  
  78.     Tooltypes (Workbench) and command-line arguments (CLI):
  79.  
  80.         XPOS/N
  81.         X position where topleft corner of AppIcon should apperar (e.g. 590
  82.         for right hand corner of the Workbench). Default: NO_ICON_POSITION
  83.  
  84.         YPOS/N
  85.         Y position where topleft corner of Appicon should appear (e.g. 210
  86.         for bottom edge of PAL:High Res screen). Default: NO_ICON_POSITION
  87.  
  88.         UPDATE/N
  89.         Time in seconds after which IconCalendar checks if it should update
  90.         the AppIcon (e.g. if 3 is set, the program checks every 3 seconds if
  91.         the date has changed). Default: 60, minimum: 1
  92.  
  93.         JANUARY/K   MARCH/K  MAY/K   JULY/K    OCTOBER/K    NOVEMBER/K
  94.         FEBRUARY/K  APRIL/K  JUNE/K  AUGUST/K  SEPTEMBER/K  DECEMBER/K
  95.         Month name translations (e.g. set JANUARY=Janvier if you want January
  96.         to be translated in french). All month names are translated in the 
  97.         same manner. Defaults to: English                                            
  98.  
  99.     Examples:
  100.  
  101.     > IconCalendar
  102.     (appears some free position, names in English, check every 60 seconds
  103.     for the date)
  104.  
  105.     > IconCalendar 550 30 15
  106.     (appears in position (550,30), names in English, check every 15 seconds
  107.     for the date)
  108.  
  109.     > IconCalendar 10 200 january=Janvier february=Février
  110.     (appears in position (10,200), translate January and February to french
  111.     (more tranlations should be added), check every 60 for the date)
  112.  
  113.     The same arguments could be given in tooltypes of Workbench.
  114.  
  115. BUGS
  116.  
  117.     When the AppIcon is refreshed (i.e. the date changes) and you have 
  118.     dragged the icon to some other place in the Workbench, the AppIcon
  119.     jumps back to its original place. Reason: I can't read the current 
  120.     position of the AppIcon (an OS bug?). Hints how to do it, anyone?
  121.  
  122. AUTHOR
  123.  
  124.     Any suggestions, comments, etc. are welcome! :)
  125.  
  126.     My address is:   Mika Kuulusa
  127.                      Yliopistonkatu 46 B 49
  128.                      33100  Tampere
  129.                      FINLAND
  130.                      Europe
  131.  
  132.          Internet:   sunshine@cs.tut.fi
  133.               IRC:   MKsa
  134.  
  135.     Sie können auch auf deutsch schreiben! Ni kan skriva på svenska också!
  136.  
  137.     Thanks to my betatester crew: Stefan Gybas, Patrik Lundquist, Hans
  138.     Ander Christiansen and Scott Pinard.
  139.  
  140.     Greetings to the nice ppl in Internet Relay Chat (IRC) in channels  
  141.     #amiga, #amiga! and #amigager. Special hi5s to: SpaceC, lundman, NeilM,
  142.     PatrikL, Xed and Dense.
  143.     
  144. HISTORY
  145.  
  146.     v1.0   26/06/94   Initial release.
  147.