AGENDA 2.0 ------------------------------------------------------------------- Rui Anastacio (ranastacio@mail.telepac.pt) ------ CONTENTS ---- - - Introduction - Files - Installation - Running the program - The event file format - Comments - User count INTRODUCTION ------------ Agenda is a small event manager. You define events, wich are written to a text file, and then the computer informs you about these events. It's a very simple tool wich runs on a wide variety of platforms because it's written in Tcl/Tk. Consult pages and for more information on this language. Since it uses a text file with a simple format to store the events its easy to exchange and distribute, events for example trought the internet. Agenda's home page is FILES ----- You should have the following files: - Readme (this file) - agenda - agenda_chk INSTALLATION ------------ Four steps: 1. IF you are a UNIX user: - Copy the files "agenda" and "agenda_chk" to some PATH directory. - Check the first line of the scripts. They should point to the wish program (the tcl interpreter). - Check that both are executable IF you are a Windows user do: - Copy the files "agenda" and "agenda_chk" to some directory 2. Edit your startup script and include the command "agenda_chk". This will call the agenda checker at startup, to inform you about events. In Windows do this by creating a shortcut to call wish80 with the agenda_chk as parameter, something like "c:\tcl\wish80 \agenda_chk" where is the directory of step 1. 3. Edit the parameters in the first lines of the files "agenda" and "agenda_chk". They are: in agenda: EVENT_FILE : the path and name of the text file wich will store the events. If you are a UNIX user you can leave as it is (~/.events). If not change it to something like c:\data\events in agenda_chk: EVENT_FILE : should be the same as in agenda WIDTH : number of columns in list of events POS_X, POS_Y : position of window on screen LIST_FONT : the font used in the list fonts: courier, times and helvetica For example: LIST_FONT "courier 10" LIST_FONT "times 12 bold" CALL1,CALL2 : the command associated with the button "Call Agenda" In Unix set CALL1 to "agenda" and CALL2 to "&" in DOS/Windows set CALL1 to the wish80 call and CALL2 to the argument, for example CALL1 "c:/tcl/wish80.exe" CALL2 "c:/data/agenda" NOTE: in Windows use the "/" insted of "\" 4. Create an empty event file. If agenda does not find the event file it aborts so just create an empy text file. In UNIX you can do a "touch ~/.events" and you are done. RUNNING THE PROGRAM ------------------- Call "agenda". Press to add a new event. You have the following fields: Event : the event type: Maria's aniversery Day : the day of the event type: 5 Month : the month type: 12 Year : the year Any year should do, so type: * You can use as asterisc in Day and Month. Before: number of days before the event you want to be noticed. if you type 4 then you will be informed 4 days before, that is, from day 1 After : days after event you should still be noticed. if you type 3 then you will be noticed until day 8 Ciclic: if on the event will remain in the file. If not, after Day+After it is removed to EVENT_FILE.log For an aniversery you should turn on this flag Once : if on you are noticed only once. After that the flag dont show is turned on. Leave it off Don't Show: if on the event will not be showned Leave it off Command: Command you want to run. Type for example: "modplay birthday" if you have a modplay + birthday song installed Comments: Extra Comments: Type for example: Buy a new boat for her collection ----------------------------------------------------------------------------------- VERY IMPORTANT: DO NOT USE the colon (:) in any of the fields because it is the field separator used in the text file ----------------------------------------------------------------------------------- Press OK to enter the event. To edit press Edit. To mark as deleted or unmark press the button. And VERY INPORTANT is writing to the file. Don't forget this operation if you want the changes to be saved to the event file. Insert some events and then call agenda_chk to see what happens. If nothing is displayed its because the are no events to show. Otherwise a window will popup showing the events. An asterisc tells the event has comments. Double click in event to show them. After the valid period of an event it is deleted from the EVENT_FILE and appended to the EVENT_FILE.log THE EVENT FILE FORMAT --------------------- day:month:year:before:after:flags:command:event or day:month:year:before:after:flags:command:event \ comment line 1 \ comment line 2 \ ... \ comment last line COMMENTS -------- Send them to me (ranastacio@mail.telepac.pt) USER COUNT ---------- If you are using this program please send me a mail with your platform type (Linux, Windows, ...) This is to count the number of users only. Please let me know about your existence. Only if a large number of persons use this program I may continue to develop it.