Software: Fothofax Licence: GPL Author: Tom Fotherby (www.tomfotherby.com) Latest Version: 0.41 (Oct 08) --------------------------------------------- = Version 0.41 Installation Instructions = 1. To install fothofax, you need write permissions to a directory accessible to a webserver that runs PHP (The software has been tested using PHP Version 4.4.0). 2. Download fothofax.zip from the google hosting site. When you unzip it, a new directory called "FothoFax_0_41" will be created. Move the new directory to a location accessible to your webserver via a URL (rename it at the same time if you wish). 3. Use a browser to look at the index.php file in the FothoFax_0_41 directory. Hopefully, you can see a copy of this page that has a working version of fothoFax using dummy data. There is a README file that contains further information such as the release notes. * If you can't see any events or birthday reminders it is probally a permissions problem. Make sure the 3 files called AddressBook.txt, EventsBook.txt and NoteBook.txt has read and write permissions for your webserver. 4. Optional: embed fothofax into another part of your website (it's not much good in a page all on it's own). To do this you will need to call setUpFothoFaxData with a relative path to Fothofax (i.e. setUpFothoFaxData('FothoFax_0_41');). Once installed, you can replace the dummy data so fothofax has some meaningful data to display. Do this by hovering over the "?" and clicking edit People and edit Events. You need to keep the text structure exactly the same otherwise FothoFax will not be able to parse the data. This is an example of the structure of the file used to store birthdays: * Name: Edd * Birthday: 09/Jul/1983 * Name: James * Birthday: 20/Jun/1992 * Name: Test * Birthday: 25/Aug/1992 * Name: Dad * Birthday: 17/Sep/1953 * Deathday: 27/Jul/2001 * Name: Mum * Birthday: 28/Apr/1954 This is an example of the structure of the file used to store events: * Date: 01/Dec * Event: Go for a walk on the riverbank. * Date: 03/Dec * Event: kill an hour with a wiskey sour. * Date: 08/Dec * Event: Feed the ducks with stale bread. * Event: Try to not think about polar bears * Date: 15/Dec/06 * Event: Notice that this event has a year. i.e. it is not recuring! * Event: Have a staring contest with ourselfs in the mirror. * Event: Snap our fingers as if suddenly we have a bright idea and see if we get any. * Date: 25/Dec * Event[red]: Christmas day * Date: 23-26/May/08 * Event[pink]: Kix in Barcelona * Date: 24/Jun-16/Jul/08 * Event[green]: Europe Trip * Date: 03/Feb/1999 * Anniversary[100]: Kix and my going out Anniversary = Upgrade Instructions = 1) Delete all old FothoFax files EXCEPT your addressBook, eventsBook and noteBook. 2) Follow installation instructions 3) Copy your old addressBook, eventsBook, noteBook over the dummy file that comes with the new installation = Changelog = === Done in v0.41 (Oct 2008) === * Sep/07 - Fixed bug in the configurable date range - Cancel now works. * Sep/07 - Added Notebook to compliment AddressBook and EventsBook. Example use: Keep ToDo list. * 9/Dec/07 - Fixed bug where "\"s were multiplying cos the PHP directive "magic_quotes_gpc" is on by default, and it runs addslashes() on all POST data. Therefore we have to remember strip them off before saving. * 25/Mar/08 - Edit mode now sends you a seperate page with full width and 35em height. It was nice doing inline editing but too small to be useful. * Apr/08 - Added "Anniversary" event type with a configuarble day step. * 06/May/08 - Added ability to add a colour to an event. This will cause the table cell to be filled with this colour. * 16/May/08 - Added ability for an event to span multiple days, months or even years. Multi-day events conviniently only appear once in the adgenda. * Oct/08 - Added phpDocumentor style comments. Merged fothoFaxConfig.inc into fothoFaxCode.php as the seperation was unnecessary. === Done in v0.4 (May 2007) === * Users can now edit the AddressBook and EventsBook directly inside Fothofax. So now the data is truly dynamic (whereas the previous versions relied on a external wiki). * The date range of FothoFax is now configurable by clicking on the title text and entering the new date range in the popup form. === Done in v0.31 (May 2006) === * Separated config variables into a config file * Made popup happen anywhere on day rather than just on icon. * Fixed a bug which occured if single-quotes were used in events. * Added year to events (but allowed for recursive events too). * Increased width to 290px to allow icons to be on the same line as the day number in all occasions. * Added error message if problem whilst reading Events file. * Added error message if problem whilst reading bday file. * Added utility function than can gather upcoming bdays or dates (e.g. to display the agenda). * Added anniversary reminder. * Removed the animated gif icons (e.g. when there are birthdays and rememberances on the same day). * Fixed various css errors that were causing display problems in IE. * Added this README file. === Done in v0.3 (Feb 2006)=== * Added events * Used an appropriate symbol to show when birthday and event on same day. - e.g. an animated gif flicking between bulb and candle. === Done in v0.25 (Dec 2005) === * Coped with dead people so it says something like "Dad would have been 52" * Used a remembrance icon (e.g. a poppy). * Coped with leap year birthdays (puts their birthday on the 28th if not leap year) * Coped with birthdays where the year isn't known. === Done in v0.2 (Nov 2005) === * Display birthdays using data in a text file - Text file editable using moinmoin. - Use overlib to provide popup information * Make birthday discovery more efficient. Pass once into an array? * Add birthday-edit icon * Put title in popup e.g. "Birthdays on dd/mm/yy" * Change color of popup to fit css. * Combine multiple birthdays into a single candle - Perhaps mark repetitions in some way. (e.g. superscript, diff image)? * Make sure clicking a candle doesn't do anything. * Add "about box" which lists location of input text file with a link. (overlib popup) * use gif images and put transparency where nessesary - convert -delay 400 candle.jpg remembranceCandle.jpg -loop 0 birthAndDeath.gif === Done in ToDO v0.1 (Oct 2005) === * Display list of weeks (current week, x back and y forward). * Style using css - Seperate out the css into a seperate file * highlight current day * Make edit-link link direct to edit mode. * If end of the month -> display seperator. * Colour weekend differently from weekdays * Create a project webpage. * Put GPL header in source files. = Instructions to zip code back up after making changes = 1) Use this command from the directory that contains the FothoFax_0_4 directory: sudo zip fothoFax.zip FothoFax_0_41/index.php FothoFax_0_41/README FothoFax_0_41/fothoFax.css FothoFax_0_41/fothoFaxCode.php FothoFax_0_41/fothoFax.js FothoFax_0_41/overlib.js FothoFax_0_41/favicon.ico FothoFax_0_41/EventsBook.txt FothoFax_0_41/AddressBook.txt FothoFax_0_41/NoteBook.txt FothoFax_0_41/FothoFaxImages/* 2) Move the zip file into place: sudo mv fothoFax.zip FothoFax_0_41/