CalendarClock v0.9 Help Authors: Stéphane Huot & Pierre Dragicevic powered by SpiraClock v1.1c by Pierre Dragicevic & Stéphane Huot 1. Description ----------------------------------------------------------------- CalendarClock is a personal events schedule manager that uses the SpiraClock vizualisation technique for short-term events. CalendarClock allows to import files in the calendar exchange format VCalendar (see specification at http://www.imc.org/pdi/). Contacts: Stephane.Huot@emn.fr Pierre.Dragicevic@emn.fr Web: http://www.emn.fr/spiraclock Users Group an Discussion Board: http://groups.yahoo.com/group/spiraclock The 'Always on top' feature is developed by Oliver Pfeiffer (http://www.mysrc.net/eng/). 2. VCalendar Files ------------------------------------------------------------- Calendar clock allows importing VCalendar files according to the 1.0 format specification. Extended recursion rules are used by our parser. VCalendar files are in most case well parsed (please, send us bug reports), but some features are not yet interpreted (and some features are not adapted to the SpiraClock display). Todo (optionnal features in the spec. are marked with (O)): * manage completed (for todos), due (for todos), priority, number recurrences (O), status event properties. * manage monthly and yearly recurrence rules. * manage nested recurrence rules (O). * manage recurrence dates/times (O). * manage exception rules(O). * manage exception dates/times (O). * manage properties parameters. * manage events alarms and reminders (O). Palm Desktop, KOrganizer or Gnomecal, for example, allow VCalendar export of one or more event. MSOutlook uses the ICalendar format that we also plane to manage later. 3. What's New In SpiraClock----------------------------------------------------- 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. 4. 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. * #C001: Parsing error when file contains DESCRIPTION property with "cr" or "lf" characters. So, description property must be on only one line. 5. Requirements ---------------------------------------------------------------- Java 1.3 or higher. 6. 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 calendarclock.zip in your application folder (e.g. Program Files) * From the command line, go to CalendarClock directory and type: 'java -jar CalendarClock.jar' After a while, you should see a window on the top right corner of your screen. Making a shortcut to CalendarClock (Windows): * Search for the file 'javaw.exe' in your java bin directory. * Make a shortcut to this file and rename it, e.g. 'CalendarClock'. * Open 'CalendarClock' properties window, and add in the text field ' -jar CalendarClock.jar' together with command line options (leave quotation marks on the left, if any). Set the start directory to be CalendarClock's directory. * additionnally, you can set the icon property of the link on the provided spiraclock icon in the CalendarClock main directory. 7. Using CalendarClock --------------------------------------------------------- * The first time you launch CalendarClock, a filechooser ask you a path to load VCalendar files (.vcs). Select a directory where your files are (principle is to put all your files in a directory). * Changing VCalendar files path using the "Change Dir..." command in the contextual menu. * Reloading all files in the current path using the "Reload" command in the contextual menu. * Configuring events properties using the contextual menu. A dialog box then appear showing properties for all known event categorie. For each category, you can change the display color, the ShowStart and ShowEnd properties (display marks at event extremities), the Allow Overlap property (simultaneous events are displayed with the same width), and the Fade On End property (event is displayed until its end). * See section 8 for Spiraclock using. 8. 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 shadowing the Spiraclock window background during "night". User can specify begin and end day time using the contextual menu. - Disabling the Splash screen using the contextual menu.