updated readme/changelog
[comingnext] / Readme.txt
1 -------------------------------
2 ComingNext for Symbian Phones
3 -------------------------------
4 This widget was originally created by Dr. Cochambre and is now developed and
5 maintained by Michael Prager <X_X_L@gmx.net>. It displays the next 12 upcoming
6 events on your S60 5th Edition phone's home screen. It consists of tree
7 separate widgets, displaying 4 events each.
8
9 For more info or to report bugs, please refer to
10 http://comingnext.sf.net/
11 and
12 http://www.symbian-freak.com/forum/viewtopic.php?t=38045
13
14 You can change the appearance (background color, font color, font size etc.)
15 and settings from within the widget now. To make the widget background
16 transparent, follow these steps:
17
18 1. install "ComingNext Skin Fetcher" on your phone
19 2. start it on your phone and click on "Generate". It will ask you for the
20 positions of the ComingNext widgets on the homescreen.
21 3. In the ComingNext widget, enable the "use background image" option and set
22 "background image location" to "external"
23
24
25 Supported Devices:
26 ------------------
27 This widget should be compatible with any Symbian S60 5th and
28 Symbian^3 Edition phone. The homescreen mini view however will only be
29 available on devices which support homescreen widgets.
30
31 ComingNext has been tested on the following devices:
32 Nokia N97, N97 mini, C6-00, C6-01, C7-00, C7 Astound, E6-00, E7-00, N8-00,
33 X7-00
34
35 The fullscreen version of this widget also works on the following devices:
36 Nokia 5800 XpressMusic, 5530 XpressMusic, 5230, 5250, 5228, 5230 Nuron,
37 5235 Ovi Music Unlimited, X6-00
38
39
40 Known limitations:
41 ------------------
42 - ToDos might show up although they have been marked "done". This is a bug in
43 Nokia's WRT library: entry.Status sometimes is undefined.
44 - real transparent background: I haven't found a way todo this yet. All the
45 widgets that have transparent background are no WRT widgets. Nokia?
46 - There is no automatic detection if you're in a timezone that uses daylight
47 saving time (DST). By default, the widget assumes that you're in a timezone
48 that has a 1h DST. If this is not the case, please change the
49 "enable Daylight Saving" setting within the widget.
50 - Some users may get an error like "Error: Loading Calendar Service". This is
51 due to a corrupted Symbian configuration file in C:\Private\2000f847. You
52 will have to reset your phone to get rid of the error. Do not restore files
53 from a backup, or you will restore the broken config too. An alternative is
54 to replace the corrupted config file manually, but you will need to hack
55 your phone in order to have access to it. You can find the non-corrupted
56 version of that config here:
57 http://sourceforge.net/tracker/download.php?group_id=276816&atid=1175663&file_id=401828&aid=2956758
58 More info on this in the bug tracker:
59 http://sourceforge.net/tracker/?func=detail&aid=2956758&group_id=276816&atid=1175663
60 - "all day" events with location information won't be displayed with location
61 information. This is yet another bug in Nokia's firmware, please wait for a
62 patch.
63
64
65 How to obtain log file for solving issues:
66 ------------------------------------------
67 In order to analyse problems or bugs, it can help to obtain the detailed widget
68 log file. You can generate a log by following these steps:
69
70 1. Within the widget, go to Settings and check "Enable Logging"
71 2. Open your browser and go to Web > Settings > General
72 3. Set "JavaScript Error Notification" to "Create Log file"
73 4. Remove the widget from your homescreen and add it again
74
75 The log file will be generated here: C:\Data\jslog_widget.log. When you report
76 a problem, send along this file so that the developers can analyse the issue.
77
78
79 License:
80 --------
81 This software is open source and licensed under the GPLv3. See License.txt
82 for details.
83
84
85 Changelog:
86 ----------
87 1.0 (2009-08-25) by cochambre
88 - initial release by cochambre
89 1.01 (2009-08-25) by cochambre
90 - fix some language localizations
91 1.02 (2009-08-27) by cochambre
92 - jquery library removed (ram footprint reduction, about 1 mb now)
93 - displaying ToDos from current day
94 - calendar is loaded up to 2 months ahead of current day (ram footprint
95 reduction)
96 - calendar app launches and closes much faster
97 - more explicit error messages (post them here if you get one)
98 1.10 (2009-08-27) by Michael Prager
99 - Only 4 lines per widget, also use the bigger default font and a bigger
100 font size
101 - added icons to easier distinguish between todos, meetings, birthdays etc
102 - removed the big icon and the today's date info as this info is already
103 present on the homescreen
104 - format months as numbers instead of text to give more room for the actual
105 event text
106 - display location if set in meetings
107 - only update once per hour. But at the same time, react instantly on any
108 calendar changes made by the user. This is done using a callback. Should
109 save a lot of battery
110 - display all todos from within the last year, if they are not marked as
111 "done". The original version will only display todos that have a
112 termination time in the future.
113 1.11 (2009-08-27) by Michael Prager
114 - added fix suggested by yves: use InstanceStartTime instead of StartTime
115 if available
116 - use a <table> to align columns instead of loose <div> boxes
117 - output line number in case of an error. This should help debugging
118 problems
119 internals for developers:
120 - added changelog to keep track of changes more easily
121 - added switch (var panelNum) so the same code can be used for both,
122 "ComingNext" and "ComingNextB" widgets
123 1.12 (2009-08-28) by Michael Prager
124 - support for all date formats (YYYY-MM-DD, DD-MM-YYYY, MM-DD-YYYY)
125 - format dates and times as 01.01 instead of 1.1
126 - output more details to error log if JavaScript logging is enabled in web
127 browser
128 - added variable to enable/disable ToDos in the event list
129 - added variable to define the number months to include in the event list
130 1.13 (2009-08-28) by Michael Prager
131 - support for ToDos without dates
132 - support for events without summary
133 - fixed date format parsing for MM-DD-YYYY (finally ;-))
134 - fixed months beeing off by 1
135 1.14 (2009-08-28) by Michael Prager
136 - support for fake transparent backgrounds.
137 1.15 (2009-08-30) by Michael Prager
138 - added separate Readme.txt
139 - use the date format defined by the system (e.g. "31.12" or "12.31")
140 - show a colored "Today" for the current day instead of full date
141 - added options for showTodayAsText, todayText, dateSeparator and
142 weekDayLength. These options can be found at the begin of index.html
143 - added CSS classes for weekday, date, time and description so you can
144 customize everything very easily. Moved these CSS definitions to the
145 begin of index.html so they are easy to spot.
146 - fixed table alignment for very long event descriptions
147 - comingNext is now licensed under the GPLv3
148 1.16 (2009-08-31) by Michael Prager
149 - applied patch by pcmoore: Fixed a bug where all times are reported as
150 "AM" regardless of the actual event time
151 - applied patch by pcmoore: new option to define which calendar app to
152 start when clicking the widget (calendarApp). By default this is the
153 buildin calendar, but you can run Epocware Handy Calendar or any other
154 app.
155 - 5 new options: showNowAsText, nowText, dateFormat, updateDataInterval
156 and calendarApp
157 - events that last for multiple days will now properly show "Today"
158 - if an event is currently taking place, display "Now" instead of the
159 event staring time. This behaviour can be disabled with the
160 showNowAsText option. You can change the color of the "Now" text by
161 changing the .now CSS class
162 - users can now configure the update interval. The default setting is now
163 5 minutes. This should not use too much battery, but at the same time
164 keep the "Now" text up-to-date
165 - added option to force a specific date format. dateFormat='auto'
166 (default) will use your phone's setting, 'DDMM' will display day first,
167 'MMDD' will display month first.
168 1.17 (2009-09-02) by Michael Prager
169 - fixed anniversaries for today not showing
170 - new option "eventsPerWidget": with this you can define the number of
171 events that will be shown for each widget.
172 - added new CSS class "icon": change this to modify the icon size (very
173 useful if you want to change the number of events)
174 1.18 (2009-09-04) by Michael Prager
175 - fixed ToDos being shown although includeTodos=false was set
176 - fixed ToDos being shown twice
177 - show text "No further events within 2 months" if there are no events
178 in the list. This behaviour and the text can be changed in the settings
179 1.19 (2009-09-04) by Michael Prager
180 - refixed problems that 1.18 should have solved (todos not showing, entries
181 showing twice)
182 1.20 (2009-09-05) by Michael Prager
183 - new project website at http://sourceforge.net/projects/comingnext
184 - fixed memos/anniversaries showing although they have already passed
185 - don't display weekday if date is 'Today'
186 - changed default 'Now' color to #ff00ff to make it different from the
187 'Today' color
188 - patch by pcmoore:
189 - Fix problem with appointments starting at 12p where they
190 would display as starting 12h later (midnight the following day)
191 - Add a new feature to only display the time for events happening today
192 and only the date for events beyond today (showCombinedDateTime)
193 - Add a new feature to disable showing the location of appointments
194 (showLocation)
195 1.21 (2009-10-13) by Michael Prager
196 - support daylight saving time (DST). This is based on the modifications
197 from Manfred Hanselmann (thanks for that!)
198 - added option "enableDaylightSaving" to disable DST. In case you are in a
199 timezone that has no DST, you should use this option
200 - some code cleanup (by Paul Moore)
201 - fixed alignment when calendar entries have very long description
202 1.22 (2009-12-07) by Michael Prager
203 - show "Tomorrow" instead of date if "showTodayAsText" is enabled
204 1.23 (2009-12-18) by Michael Prager
205 - added fullscreen mode (can list 30 events)
206 - added settings menu. Need to modify the widget manually anymore.
207 - fixed table cell alignment in cases where the event summary was very long
208 - fixed display of "tomorrow" text if CombinedDateTime is enabled
209 1.24 (2010-01-01) by Michael Prager
210 - localization support added by Christophe Milsent
211 - added french translation by Christophe Milsent
212 - added german translation
213 - new option "hide Widget On Calendar Open". When enabled, this will close
214 the fullscreen widget when opening the calendar app
215 - code cleanup and size reduction
216 - update interval to detect screen rotation increased from 3 to 1 secs
217 - open calendar app when clicking anywhere in fullscreen view
218 1.25 (2010-02-21) by Michael Prager
219 - fixed reoccurring events not beeing shown
220 - added "check for updates" feature
221 - added "ComingNext Skin Fetcher v1.1" tool
222 - support for external background images (useful in combination with the
223 new skin fetcher tool). With this, you won't need to modify the widget
224 anymore to use a custom background image
225 - added portuguese-brazilian translation by Flavio Nathan
226 1.26 (2010-03-18) by Michael Prager
227 - fixed second panel showing the same events as the first panel
228 - mark overdue ToDo events (this feature can be disabled in the settings)
229 - support for 3 panels
230 - automatically change text size to fit the requested number of events. You
231 can now easily change the number of events per widget for example to 3, 5
232 or 6 by simply changing the 'Events Per Widget' setting.
233 - includes Skin Fetcher 1.2 which now also supports 3 panels
234 1.27 (2010-03-21) by Michael Prager
235 - fixed ToDo events without due date to cause error
236 1.28 (2010-10-11) by Michael Prager
237 - compatible with N8 and any other device with multi-calendar support
238 - added persistent settings. Settings will no longer be lost when updating
239 the widget. Also, all widgets now use the same settings, you no longer have
240 to modify the settings in each widget individually.
241 - added russian translation (thanks to tokeda)
242 - updated portuguese-brazilian (thanks to Flavio Nathan)
243 - new app icon
244 - updated "ComingNext Skin Fetcher" tool to version v1.3 (supports all 6
245 panel positions)
246 1.29 (2010-10-13) by Michael Prager
247 - fixed events showing as "undefined" on Symbian^3
248 - startup performance improvements
249 - stylish default background image
250 - first release available on Ovi Store
251 1.30 (2010-11-28) by Michael Prager
252 - fixed an issue with daylight saving time not being used properly resulting
253 in events around time shifts to be off by one day or hour
254 - added option to change daylight saving offset (for time zones which have
255 more than a +1h time shift)
256 - fixed changes to calendars not being shown if affected calendar is not
257 default calendar
258 - added color indicator to show to which calendar an event belongs to (can be
259 disabled in settings)
260 - added option to exclude specific calendars from the list
261 1.31 (2011-03-26) by Michael Prager
262 - added spanish translation (thanks to dragomerlin)
263 - added italian translation (thanks to Marcella Ferrari and Venos)
264 - fixed "About" link opening inside browser instead of widget
265 - fixed sorting of events without date
266 - fixed calendar indicators not showing in some cases
267 - fixed homescreen widget not updating properly on N8
268 - added help menu
269 1.32 (2011-05-14) by Michael Prager
270 - improved performance and battery life (reloading and sorting calendar
271 data has been reduced)
272 - fixed settings being lost when updating to a newer version
273 - added support for Location field for "all day" events. You'll have to wait
274 until Nokia fixes their firmware before this change will be visible though :-P
275 - fixed and improved spanish translation
276 - added "enableLogging" option which needs to be turned on if you want to
277 generate debug logs
278 1.33 () by Michael Prager
279 - added support for X7-00, E6-00 and other "Anna" devices
280 - improved error handling: don't break widget when a system backup is made
281 - updated included "Skin Fetcher" tool to version 1.4 (which now properly
282 supports N8-00, E7-00, C6-00, C6-01, C7-00, C7 Astound and X7-00)