]> code.delx.au - comingnext/blobdiff - Readme.txt
updated readme/changelog
[comingnext] / Readme.txt
index 46862534dd584a56114afdc3051c602cb1bbbc12..6f3a06b5e7ad311933d3fcec7dbba0535040a363 100644 (file)
@@ -1,49 +1,79 @@
-------------------------------------\r
- ComingNext & Coming Next B for N97\r
-------------------------------------\r
-This widget was originally created by Dr. Cochambre and was extended by \r
-Oxidative <X_X_L@gmx.net>. It will display the next 8 upcoming events \r
-on your N97 homescreen. It consists of two seperate widgets, each displaying\r
-4 events.\r
-\r
-For more info or to report bugs, please refere to \r
-http://sourceforge.net/projects/comingnext\r
+-------------------------------\r
+ ComingNext for Symbian Phones\r
+-------------------------------\r
+This widget was originally created by Dr. Cochambre and is now developed and \r
+maintained by Michael Prager <X_X_L@gmx.net>. It displays the next 12 upcoming \r
+events on your S60 5th Edition phone's home screen. It consists of tree \r
+separate widgets, displaying 4 events each.\r
+\r
+For more info or to report bugs, please refer to \r
+http://comingnext.sf.net/\r
   and\r
 http://www.symbian-freak.com/forum/viewtopic.php?t=38045\r
 \r
 You can change the appearance (background color, font color, font size etc.) \r
-and settings by modifying the widget:\r
-\r
-  1. rename comingNext.wgz to comingNext.zip\r
-  2. edit comingNext.zip/comingNext/index.html and customize the settings\r
-     at the top of the document. For example, to change the background to \r
-     a solid red color, set:\r
-       .background { ... background-color:#ff0000; ... }\r
-       useBackgroundImage = false;\r
-  3. rename comingNext.zip back to comingNext.wgz\r
-  4. do the same for comingNextB.wgz\r
-\r
-To add your custom background/fake transparency, follow these steps:\r
-\r
-  1. rename comingNext.wgz to comingNext.zip\r
-  2. replace comingNext.zip/comingNext/background_landscape.png and \r
-     background_portrait.png with your desired background.\r
-  3. rename comingNext.zip back to comingNext.wgz\r
-  4. do the same for comingNextB.wgz\r
-  \r
-I recommend to use a program to make a screenshot of your current \r
-homescreen background, then use a painting program like GIMP to \r
-cut out the pieces you need. Use background_mask_landscape.png and \r
-background_mask_portrait.png for guidance on what parts of the screen are\r
-used by widgets.\r
-\r
-\r
-known limitations:\r
+and settings from within the widget now. To make the widget background \r
+transparent, follow these steps:\r
+\r
+  1. install "ComingNext Skin Fetcher" on your phone\r
+  2. start it on your phone and click on "Generate". It will ask you for the\r
+     positions of the ComingNext widgets on the homescreen.\r
+  3. In the ComingNext widget, enable the "use background image" option and set\r
+     "background image location" to "external"\r
+\r
+\r
+Supported Devices:\r
+------------------\r
+This widget should be compatible with any Symbian S60 5th and \r
+Symbian^3 Edition phone. The homescreen mini view however will only be \r
+available on devices which support homescreen widgets.\r
+\r
+ComingNext has been tested on the following devices:\r
+Nokia N97, N97 mini, C6-00, C6-01, C7-00, C7 Astound, E6-00, E7-00, N8-00, \r
+X7-00\r
+\r
+The fullscreen version of this widget also works on the following devices:\r
+Nokia 5800 XpressMusic, 5530 XpressMusic, 5230, 5250, 5228, 5230 Nuron, \r
+5235 Ovi Music Unlimited, X6-00\r
+\r
+\r
+Known limitations:\r
 ------------------\r
 - ToDos might show up although they have been marked "done". This is a bug in \r
-  Nokias WRT library: entry.Status sometimes is undefined.\r
+  Nokia's WRT library: entry.Status sometimes is undefined.\r
 - real transparent background: I haven't found a way todo this yet. All the \r
   widgets that have transparent background are no WRT widgets. Nokia?\r
+- There is no automatic detection if you're in a timezone that uses daylight\r
+  saving time (DST). By default, the widget assumes that you're in a timezone\r
+  that has a 1h DST. If this is not the case, please change the \r
+  "enable Daylight Saving" setting within the widget.\r
+- Some users may get an error like "Error: Loading Calendar Service". This is\r
+  due to a corrupted Symbian configuration file in C:\Private\2000f847. You \r
+  will have to reset your phone to get rid of the error. Do not restore files\r
+  from a backup, or you will restore the broken config too. An alternative is \r
+  to replace the corrupted config file manually, but you will need to hack \r
+  your phone in order to have access to it. You can find the non-corrupted \r
+  version of that config here:\r
+  http://sourceforge.net/tracker/download.php?group_id=276816&atid=1175663&file_id=401828&aid=2956758\r
+  More info on this in the bug tracker:\r
+  http://sourceforge.net/tracker/?func=detail&aid=2956758&group_id=276816&atid=1175663\r
+- "all day" events with location information won't be displayed with location \r
+  information. This is yet another bug in Nokia's firmware, please wait for a \r
+  patch.\r
+\r
+\r
+How to obtain log file for solving issues:\r
+------------------------------------------\r
+In order to analyse problems or bugs, it can help to obtain the detailed widget \r
+log file. You can generate a log by following these steps:\r
+\r
+1. Within the widget, go to Settings and check "Enable Logging"\r
+2. Open your browser and go to Web > Settings > General\r
+3. Set "JavaScript Error Notification" to "Create Log file"\r
+4. Remove the widget from your homescreen and add it again\r
+\r
+The log file will be generated here: C:\Data\jslog_widget.log. When you report\r
+a problem, send along this file so that the developers can analyse the issue.\r
 \r
 \r
 License:\r
@@ -65,7 +95,7 @@ Changelog:
     reduction)\r
   - calendar app launches and closes much faster\r
   - more explicit error messages (post them here if you get one)\r
-1.10 (2009-08-27) by Oxidative\r
+1.10 (2009-08-27) by Michael Prager\r
   - Only 4 lines per widget, also use the bigger default font and a bigger \r
     font size\r
   - added icons to easier distinguish between todos, meetings, birthdays etc\r
@@ -80,7 +110,7 @@ Changelog:
   - display all todos from within the last year, if they are not marked as \r
     "done". The original version will only display todos that have a \r
     termination time in the future.\r
-1.11 (2009-08-27) by Oxidative\r
+1.11 (2009-08-27) by Michael Prager\r
   - added fix suggested by yves: use InstanceStartTime instead of StartTime \r
     if available\r
   - use a <table> to align columns instead of loose <div> boxes\r
@@ -90,21 +120,21 @@ Changelog:
     - added changelog to keep track of changes more easily\r
     - added switch (var panelNum) so the same code can be used for both, \r
       "ComingNext" and "ComingNextB" widgets\r
-1.12 (2009-08-28) by Oxidative\r
+1.12 (2009-08-28) by Michael Prager\r
   - support for all date formats (YYYY-MM-DD, DD-MM-YYYY, MM-DD-YYYY)\r
   - format dates and times as 01.01 instead of 1.1\r
   - output more details to error log if JavaScript logging is enabled in web \r
     browser\r
   - added variable to enable/disable ToDos in the event list\r
   - added variable to define the number months to include in the event list\r
-1.13 (2009-08-28) by Oxidative\r
+1.13 (2009-08-28) by Michael Prager\r
   - support for ToDos without dates\r
   - support for events without summary\r
   - fixed date format parsing for MM-DD-YYYY (finally ;-))\r
   - fixed months beeing off by 1\r
-1.14 (2009-08-28) by Oxidative\r
+1.14 (2009-08-28) by Michael Prager\r
   - support for fake transparent backgrounds.\r
-1.15 (2009-08-30) by Oxidative\r
+1.15 (2009-08-30) by Michael Prager\r
   - added separate Readme.txt\r
   - use the date format defined by the system (e.g. "31.12" or "12.31")\r
   - show a colored "Today" for the current day instead of full date\r
@@ -115,7 +145,7 @@ Changelog:
     begin of index.html so they are easy to spot.\r
   - fixed table alignment for very long event descriptions\r
   - comingNext is now licensed under the GPLv3\r
-1.16 (2009-08-31) by Oxidative \r
+1.16 (2009-08-31) by Michael Prager \r
   - applied patch by pcmoore: Fixed a bug where all times are reported as \r
     "AM" regardless of the actual event time\r
   - applied patch by pcmoore: new option to define which calendar app to \r
@@ -135,21 +165,22 @@ Changelog:
   - added option to force a specific date format. dateFormat='auto' \r
     (default) will use your phone's setting, 'DDMM' will display day first, \r
     'MMDD' will display month first.\r
-1.17 (2009-09-02) by Oxidative\r
+1.17 (2009-09-02) by Michael Prager\r
   - fixed anniversaries for today not showing\r
   - new option "eventsPerWidget": with this you can define the number of \r
     events that will be shown for each widget.\r
   - added new CSS class "icon": change this to modify the icon size (very\r
     useful if you want to change the number of events)\r
-1.18 (2009-09-04) by Oxidative\r
+1.18 (2009-09-04) by Michael Prager\r
   - fixed ToDos being shown although includeTodos=false was set\r
   - fixed ToDos being shown twice\r
   - show text "No further events within 2 months" if there are no events\r
     in the list. This behaviour and the text can be changed in the settings\r
-1.19 (2009-09-04) by Oxidative\r
+1.19 (2009-09-04) by Michael Prager\r
   - refixed problems that 1.18 should have solved (todos not showing, entries \r
     showing twice)\r
-1.20 (2009-09-05) by Oxidative\r
+1.20 (2009-09-05) by Michael Prager\r
+  - new project website at http://sourceforge.net/projects/comingnext\r
   - fixed memos/anniversaries showing although they have already passed\r
   - don't display weekday if date is 'Today'\r
   - changed default 'Now' color to #ff00ff to make it different from the \r
@@ -160,4 +191,92 @@ Changelog:
     - Add a new feature to only display the time for events happening today \r
       and only the date for events beyond today (showCombinedDateTime)\r
     - Add a new feature to disable showing the location of appointments \r
-      (showLocation) 
\ No newline at end of file
+      (showLocation)\r
+1.21 (2009-10-13) by Michael Prager\r
+  - support daylight saving time (DST). This is based on the modifications \r
+    from Manfred Hanselmann (thanks for that!)\r
+  - added option "enableDaylightSaving" to disable DST. In case you are in a \r
+    timezone that has no DST, you should use this option\r
+  - some code cleanup (by Paul Moore)\r
+  - fixed alignment when calendar entries have very long description\r
+1.22 (2009-12-07) by Michael Prager\r
+  - show "Tomorrow" instead of date if "showTodayAsText" is enabled\r
+1.23 (2009-12-18) by Michael Prager\r
+  - added fullscreen mode (can list 30 events)\r
+  - added settings menu. Need to modify the widget manually anymore. \r
+  - fixed table cell alignment in cases where the event summary was very long\r
+  - fixed display of "tomorrow" text if CombinedDateTime is enabled\r
+1.24 (2010-01-01) by Michael Prager\r
+  - localization support added by Christophe Milsent\r
+  - added french translation by Christophe Milsent\r
+  - added german translation\r
+  - new option "hide Widget On Calendar Open". When enabled, this will close \r
+    the fullscreen widget when opening the calendar app\r
+  - code cleanup and size reduction\r
+  - update interval to detect screen rotation increased from 3 to 1 secs\r
+  - open calendar app when clicking anywhere in fullscreen view\r
+1.25 (2010-02-21) by Michael Prager\r
+  - fixed reoccurring events not beeing shown\r
+  - added "check for updates" feature\r
+  - added "ComingNext Skin Fetcher v1.1" tool\r
+  - support for external background images (useful in combination with the\r
+    new skin fetcher tool). With this, you won't need to modify the widget\r
+    anymore to use a custom background image\r
+  - added portuguese-brazilian translation by Flavio Nathan\r
+1.26 (2010-03-18) by Michael Prager\r
+  - fixed second panel showing the same events as the first panel\r
+  - mark overdue ToDo events (this feature can be disabled in the settings)\r
+  - support for 3 panels\r
+  - automatically change text size to fit the requested number of events. You\r
+    can now easily change the number of events per widget for example to 3, 5 \r
+       or 6 by simply changing the 'Events Per Widget' setting.\r
+  - includes Skin Fetcher 1.2 which now also supports 3 panels\r
+1.27 (2010-03-21) by Michael Prager\r
+  - fixed ToDo events without due date to cause error\r
+1.28 (2010-10-11) by Michael Prager\r
+  - compatible with N8 and any other device with multi-calendar support\r
+  - added persistent settings. Settings will no longer be lost when updating \r
+    the widget. Also, all widgets now use the same settings, you no longer have\r
+    to modify the settings in each widget individually.\r
+  - added russian translation (thanks to tokeda)\r
+  - updated portuguese-brazilian (thanks to Flavio Nathan)\r
+  - new app icon\r
+  - updated "ComingNext Skin Fetcher" tool to version v1.3 (supports all 6 \r
+    panel positions)\r
+1.29 (2010-10-13) by Michael Prager\r
+  - fixed events showing as "undefined" on Symbian^3\r
+  - startup performance improvements\r
+  - stylish default background image\r
+  - first release available on Ovi Store\r
+1.30 (2010-11-28) by Michael Prager\r
+  - fixed an issue with daylight saving time not being used properly resulting\r
+    in events around time shifts to be off by one day or hour\r
+  - added option to change daylight saving offset (for time zones which have\r
+    more than a +1h time shift)\r
+  - fixed changes to calendars not being shown if affected calendar is not\r
+    default calendar\r
+  - added color indicator to show to which calendar an event belongs to (can be\r
+    disabled in settings)\r
+  - added option to exclude specific calendars from the list\r
+1.31 (2011-03-26) by Michael Prager\r
+  - added spanish translation (thanks to dragomerlin)\r
+  - added italian translation (thanks to Marcella Ferrari and Venos)\r
+  - fixed "About" link opening inside browser instead of widget\r
+  - fixed sorting of events without date\r
+  - fixed calendar indicators not showing in some cases\r
+  - fixed homescreen widget not updating properly on N8\r
+  - added help menu\r
+1.32 (2011-05-14) by Michael Prager\r
+  - improved performance and battery life (reloading and sorting calendar \r
+    data has been reduced)\r
+  - fixed settings being lost when updating to a newer version\r
+  - added support for Location field for "all day" events. You'll have to wait \r
+    until Nokia fixes their firmware before this change will be visible though :-P\r
+  - fixed and improved spanish translation\r
+  - added "enableLogging" option which needs to be turned on if you want to \r
+    generate debug logs\r
+1.33 () by Michael Prager\r
+  - added support for X7-00, E6-00 and other "Anna" devices\r
+  - improved error handling: don't break widget when a system backup is made\r
+  - updated included "Skin Fetcher" tool to version 1.4 (which now properly \r
+    supports N8-00, E7-00, C6-00, C6-01, C7-00, C7 Astound and X7-00)\r