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