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