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