BusClock v1.2_2004 Readme

Authors: Pierre Dragicevic & Stéphane Huot



1. Description -----------------------------------------------------------------

   BusClock is a personal bus schedule manager that uses the SpiraClock
   vizualisation technique for short-term events.
   This version contains 2003-2004 schedules of TAN as displayed at http://www.tan.fr
   Handled schedules are:
   * Buses 72 (Beaujoire), Gachet and Beaujoire stops.
   * Bus 22 (Dervallieres), Beaujoire stop.

   Contacts: Pierre.Dragicevic@emn.fr
             Stephane.Huot@emn.fr

   Web: http://www.emn.fr/spiraclock

   Users Group an Discussion Board: http://groups.yahoo.com/group/spiraclock

   Please, to report bugs join the logfile "BusClock_err.log" in your main
   BusClock directory.

   The 'Always on top' feature is developed by
   Oliver Pfeiffer (http://www.mysrc.net/eng/).



2. What's New In BusClock ----------------------------------------------------

 In v1.2_2004
  * New schedules for 2003-2004
  * Schedules are now loaded from a text file
  * Added persistent options for selecting bus lines, and configuring
    time offsets

 In v1.1e_2003
  * New schedules for 2002-2003

 In v1.1e_ete2002
  * New schedules for Summer 2002

 In v1.1e
  * Now works with java 1.4 (but performs better with 1.3)
  * Date and digital hour are displayed according to the system language
  * Window initialization bugs fixed

 In v1.1d
  * Bug #002 fixed (display of next year events)
  * Logfile added for each session to perform bug tracking
  * About menu added

 In v1.1c:
  * Bug #001 fixed (exception thrown when hands come back)
  * Support for hour coordinates frame !
  * Reaching a distant visible event is now easy
  * Double-clicking on the window will no more toggle window borders

 In v1.1b
   * New display property: showNight (see section 7).
   * Ability to view event description by clicking on it.

 In v1.1a
   * Spiraclock properties recovering on each launch.
   * Splash screen on applications start.

 In v1.0f
   * The 'Always on top' option is now implemented (Windows only).
   * Ability to move the window using 'shift' key.



3. Known bugs ------------------------------------------------------------------

   * #001 Moving hands too far (i.e. several months) will throw an exception
	 while they return to their original position (fixed in v1.1c).
   * #002: Spiraclock only displays events from the current year (fixed).



4. Requirements ----------------------------------------------------------------

   Java 1.3 or higher.



5. Installation ----------------------------------------------------------------

   * If you don't have JavaTM 2 Runtime Environment v1.3 or higher,
     install it from http://java.sun.com/j2se/1.3/jre/
   * Unzip busclock.zip in a folder of your choice (e.g. c:\busclock in windows).
     If an older version of busclock is already installed, use the same folder
     and overwrite the files.
   * Double-click on busclock.jar
   * ...or from the command line, go to busClock directory and type:
     'java -jar busclock.jar'
     After a while, you should see a window on the top right corner of your
     screen.


   Making a shortcut to busclock (Windows):

   * If double-clicking on .jar does not work:
   * Search for the file 'javaw.exe' in your java bin directory.
   * Make a shortcut to this file and rename it, e.g. 'BusClock'.
   * Open 'BusClock' shortcut properties window (right click), and add
     in the text field ' -jar busclock.jar'.
     Then set the start directory to be busclock's directory.
   * additionnally, you can set the icon property of the link on the
     provided spiraclock icon in the CalendarClock main directory.



6. Schedules -------------------------------------------------------------------

   See busclock homepage for a description of the way bus schedules
   are displayed.
   http://www.emn.fr/spiraclock/busclock
   
   You can change some display settings using the contextual menu (right button)



7. Using SpiraClock ------------------------------------------------------------

   * Spiraclock Applets and Applications:

   - Looking ahead/backward in time: Drag the minute hand.
   - Fast looking ahead/backward: Drag the hour hand.
   - Resetting to current time: Move the mouse out of the component.
   - Changing time extent: Drag the spiral toward its center or its border.
   - Showing/hiding the digital clock or current date: use the contextual
	 menu (right button in Windows).
   - View event full description (if exists): click on the event and keep
    the button pressed
   - Reaching an event: double-click on the event
   - Toggle minute/hour coordinates frame: double-click on minute/hour hand

   * SpiraClock Applications only:

   - Resizing the clock: Drag window background toward spiral's center or
	 outside.
   - Moving the window: Shift-drag window background.
   - Using the contextual menu, you can also add/remove window borders, close
	 the window, or set it to be always on top. This last feature works only
          in Windows platforms. Some window managers have this feature built-in.
   - The showNight option progressively shadows the Spiraclock window
         background during "night". User can specify begin and end day time
         using the contextual menu.
   - Disable the Splash screen using the contextual menu.