Help/README

   1                         Memo
   2                         Reminds you about things
   3                         by Thomas Leonard
   4
   5 Brief
   6 ~~~~~
   7 Memo is a small utility which you can use to store appointments and 'TODO'
   8 items. It displays the next few entries in a small window, and can also be
   9 instructed to bring up alert windows at set times.
  10
  11 It's written in Python, so you don't need to compile it before using it.
  12 If you're NOT using Zero Install, you'll need to install ROX-Lib before
  13 running Memo:
  14
  15         http://rox.sourceforge.net/desktop/ROX-Lib
  16
  17 To run Memo, click on its icon in a filer window, or run the 'AppRun' script.
  18
  19 No installation is required, but you can copy it anywhere you want using
  20 the filer.
  21
  22 If you have a D-BUS notification service running then it will use that to
  23 display alarms. Otherwise, it will use a built-in dialog box. For more
  24 information about notification services, see:
  25
  26         http://www.galago-project.org/specs/notification/
  27
  28 Using D-BUS notification is the recommended, as it gives you the new features
  29 including early notification and custom Memo sounds.
  30
  31 The time display was inspired by Jon Ribbens' RoughtTime clock.
  32
  33 Memo can also be run as a panel applet on a ROX-Filer panel. This code is
  34 based on code from MiniClock, by Edoardo Spadolini and Dennis Tomas.
  35
  36
  37 Instructions
  38 ~~~~~~~~~~~~
  39 When run, a small window appears displaying the current time and a list of
  40 the next few memos (if any) below.
  41
  42 Right-click for a menu.
  43
  44 To create a new memo:
  45
  46 - Click on the button displaying the time - the 'Create memo:' window
  47   appears.
  48
  49 - Type in a message to yourself in the large white square. The first line
  50   will be used to display a summary of the memo.
  51
  52 - Use the calendar display to select a date for the memo.
  53
  54 - You can also specify a time for the memo by clicking on the 'At...'
  55   check box. Use the arrows that appear to set the time.
  56
  57   Memos with a time are alarms and will cause a box to appear when they go
  58   off. If Memo is not running when the alarm goes off, it will be shown next
  59   time Memo is run.
  60
  61   You may select the "Advanced Options" area for memos with a time for extra
  62   customization of the alarm.
  63
  64   Memos without times are just TODO items. They are displayed under the time
  65   until you get rid of them, but don't bring up an alert box.
  66
  67 - Click Set to add the memo to the list.
  68
  69 Changes are automatically saved.
  70
  71 If you set a time, then Memo will display the message in the best way it can.
  72 See the "Dbus Notifications" and "Old Popup" sections below.
  73
  74 To edit (or hide or delete) a memo from the main window, double-click on it in
  75 the list.
  76
  77 This brings up the editing box. When editing a memo (rather than creating a new
  78 one) there are two extra buttons. Hide works as in the alert box (described
  79 above), and Delete gets rid of the memo completely. There is no undelete;
  80 use Hide if you might want it back.
  81
  82 Not all memos are displayed in the main window. Hidden memos aren't shown, and
  83 neither are memos far in the future. To see all memos, open the menu and
  84 choose 'Show All...'. This window displays a list of all memos that Memo
  85 knows about.
  86
  87 You can click on the boxes in the 'Hide' column to hide or unhide memos.
  88 Hidden memos are never displayed in the main window and do not open alert
  89 boxes. Unhidden ones might or might not be displayed, depending on how far
  90 in the future they are and how full the main window is.
  91
  92 Delete allows you to permanently remove a group of memos (select them first),
  93 and Edit works like double clicking.
  94
  95 By choosing 'Options...' from the popup menu you can configure various
  96 things about Memo. Hold the pointer over an option to find out what it does.
  97
  98
  99 New Notifications
 100 ~~~~~~~~~~~~~~~~~
 101 If you have dbus and notification-daemon installed on your system (which is
 102 recommended!), Memo will use this to popup the message when the time is up, but
 103 only for Memos that have a time set.
 104
 105 You may configure a sound file in the Options pane, or for a specific Memo.
 106 This is passed to the notification-daemon as the 'sound-file' hint, and not
 107 actually played directly by the Memo program.  This means that unless your
 108 notification-daemon has sound support (Versions 0.3.6 and lower do not), you
 109 will not hear the sound.
 110
 111 If you have configured an "early" reminder in the Options pane (by default this
 112 is disabled), the Memo will first be displayed with "normal" urgency at the
 113 specified number of minutes before the actual Memo time.
 114
 115 When the Memo time arrives, the Memo will be displayed with "critical" urgency.
 116 The notification popup has four buttons:
 117
 118   Hide memo
 119         Removes the message from the main window.  You can still retrieve it
 120         later.  If you hide an early reminder, you will NOT be notified when the
 121         real Memo time is reached.
 122
 123   Delete
 124         Removes the message from the main window and deletes it.  You will not
 125         be able to retrieve it.   If you hide an early reminder, you will NOT be
 126         notified when the real Memo time is reached.
 127
 128   Edit
 129         Returns you to the box used to create the memo. You can use this to
 130         move the memo to a later date (useful for repeating memos) or delete
 131         it.
 132
 133   Ok/Later
 134         This simply closes the notification.  In the case of early notification,
 135         you will be notified by a critical alert when the actual Memo time is
 136         reached.  The button is labeled 'Later' for early notifications, or
 137         'Ok' otherwise.
 138
 139
 140 Old Popups
 141 ~~~~~~~~~~
 142 The 'Old Popups' method does not play sounds or support early notifications.
 143
 144 If dbus is not avialable, then Memo will beep twice and display the message in
 145 a dialog box when the time is up. The alert box that appears has three buttons:
 146
 147   Hide memo
 148         Removes the message from the main window. You can still retrieve
 149         it later.
 150
 151   Edit
 152         Returns you to the box used to create the memo. You can use this to
 153         move the memo to a later date (useful for repeating memos) or delete
 154         it.
 155
 156   OK
 157         The memo remains displayed in the main window until you get rid of it.
 158         No futher alarm boxes will appear for it unless you edit it again.
 159
 160
 161 Timezones
 162 ~~~~~~~~~
 163 All times are displayed and input in your local time, but stored internally
 164 as seconds since a fixed date.
 165
 166 Therefore, if you set an alarm for 7pm and then change timezones, the alarm
 167 may now appear to have changed time. It will go off when the time is 7pm IN
 168 THE ZONE WHERE YOU SET THE MEMO.
 169
 170
 171 Troubleshooting
 172 ~~~~~~~~~~~~~~~
 173 Problem: "None of the sound files I have specified are playing!"
 174
 175 Reason:  Sounds are only supported with D-BUS and notification-daemon, and will
 176 not be played with the old-style dialog popup.
 177
 178 Furthermore, at the time of this writing, notification-daemon does not yet play
 179 sounds (notification-daemon-0.3.6 and earlier).
 180
 181 There is a trac ticket against notification-daemon at http://trac.galago-project.org/ticket/111 with a patch against the current SVN version, which will
 182 hopefully be applied and available in a later release.  This patch uses
 183 gstreamer to play any 'sound-file' hint specified
 184
 185
 186 Conditions
 187 ~~~~~~~~~~
 188 This program is free software; you can redistribute it and/or modify
 189 it under the terms of the GNU General Public License as published by
 190 the Free Software Foundation; either version 2 of the License, or
 191 (at your option) any later version.
 192
 193 This program is distributed in the hope that it will be useful,
 194 but WITHOUT ANY WARRANTY; without even the implied warranty of
 195 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 196 GNU General Public License for more details.
 197
 198 You should have received a copy of the GNU General Public License
 199 along with this program; if not, write to the Free Software
 200 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 201
 202 Please report any bugs to the mailing list:
 203
 204         http://rox.sourceforge.net/desktop/lists