]> code.delx.au - comingnext/blob - Readme.txt
* added localization support
[comingnext] / Readme.txt
1 ------------------------------------
2 ComingNext & Coming Next B for N97
3 ------------------------------------
4 This widget was originally created by Dr. Cochambre and was extended by
5 Michael Prager <X_X_L@gmx.net>. It will display the next 8 upcoming events
6 on your N97 homescreen. It consists of two seperate widgets, each displaying
7 4 events.
8
9 For more info or to report bugs, please refere 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. Only if you want to use a custom
16 background image or face transparency, you still need to modify the widget,
17 following these steps:
18
19 1. rename comingNext.wgz to comingNext.zip
20 2. replace comingNext.zip/comingNext/background_landscape.png and
21 background_portrait.png with your desired background.
22 3. rename comingNext.zip back to comingNext.wgz
23 4. do the same for comingNextB.wgz
24 5. in the widget settings enable "use background image"
25
26 I recommend to use a program to make a screenshot of your current
27 homescreen background, then use a painting program like GIMP to
28 cut out the pieces you need. Use background_mask_landscape.png and
29 background_mask_portrait.png for guidance on what parts of the screen are
30 used by widgets.
31
32
33 known limitations:
34 ------------------
35 - ToDos might show up although they have been marked "done". This is a bug in
36 Nokias WRT library: entry.Status sometimes is undefined.
37 - real transparent background: I haven't found a way todo this yet. All the
38 widgets that have transparent background are no WRT widgets. Nokia?
39 - There is no automatic detection if you're in a timezone that uses daylight
40 saving time (DST). By default, the widget assumes that you're in a timezone
41 that has a 1h DST. If this is not the case, please change the
42 "enable Daylight Saving" setting within the widget.
43
44
45 License:
46 --------
47 This software is open source and licensed under the GPLv3. See License.txt
48 for details.
49
50
51 Changelog:
52 ----------
53 1.0 (2009-08-25) by cochambre
54 - initial release by cochambre
55 1.01 (2009-08-25) by cochambre
56 - fix some language localizations
57 1.02 (2009-08-27) by cochambre
58 - jquery library removed (ram footprint reduction, about 1 mb now)
59 - displaying ToDos from current day
60 - calendar is loaded up to 2 months ahead of current day (ram footprint
61 reduction)
62 - calendar app launches and closes much faster
63 - more explicit error messages (post them here if you get one)
64 1.10 (2009-08-27) by Michael Prager
65 - Only 4 lines per widget, also use the bigger default font and a bigger
66 font size
67 - added icons to easier distinguish between todos, meetings, birthdays etc
68 - removed the big icon and the today's date info as this info is already
69 present on the homescreen
70 - format months as numbers instead of text to give more room for the actual
71 event text
72 - display location if set in meetings
73 - only update once per hour. But at the same time, react instantly on any
74 calendar changes made by the user. This is done using a callback. Should
75 save a lot of battery
76 - display all todos from within the last year, if they are not marked as
77 "done". The original version will only display todos that have a
78 termination time in the future.
79 1.11 (2009-08-27) by Michael Prager
80 - added fix suggested by yves: use InstanceStartTime instead of StartTime
81 if available
82 - use a <table> to align columns instead of loose <div> boxes
83 - output line number in case of an error. This should help debugging
84 problems
85 internals for developers:
86 - added changelog to keep track of changes more easily
87 - added switch (var panelNum) so the same code can be used for both,
88 "ComingNext" and "ComingNextB" widgets
89 1.12 (2009-08-28) by Michael Prager
90 - support for all date formats (YYYY-MM-DD, DD-MM-YYYY, MM-DD-YYYY)
91 - format dates and times as 01.01 instead of 1.1
92 - output more details to error log if JavaScript logging is enabled in web
93 browser
94 - added variable to enable/disable ToDos in the event list
95 - added variable to define the number months to include in the event list
96 1.13 (2009-08-28) by Michael Prager
97 - support for ToDos without dates
98 - support for events without summary
99 - fixed date format parsing for MM-DD-YYYY (finally ;-))
100 - fixed months beeing off by 1
101 1.14 (2009-08-28) by Michael Prager
102 - support for fake transparent backgrounds.
103 1.15 (2009-08-30) by Michael Prager
104 - added separate Readme.txt
105 - use the date format defined by the system (e.g. "31.12" or "12.31")
106 - show a colored "Today" for the current day instead of full date
107 - added options for showTodayAsText, todayText, dateSeparator and
108 weekDayLength. These options can be found at the begin of index.html
109 - added CSS classes for weekday, date, time and description so you can
110 customize everything very easily. Moved these CSS definitions to the
111 begin of index.html so they are easy to spot.
112 - fixed table alignment for very long event descriptions
113 - comingNext is now licensed under the GPLv3
114 1.16 (2009-08-31) by Michael Prager
115 - applied patch by pcmoore: Fixed a bug where all times are reported as
116 "AM" regardless of the actual event time
117 - applied patch by pcmoore: new option to define which calendar app to
118 start when clicking the widget (calendarApp). By default this is the
119 buildin calendar, but you can run Epocware Handy Calendar or any other
120 app.
121 - 5 new options: showNowAsText, nowText, dateFormat, updateDataInterval
122 and calendarApp
123 - events that last for multiple days will now properly show "Today"
124 - if an event is currently taking place, display "Now" instead of the
125 event staring time. This behaviour can be disabled with the
126 showNowAsText option. You can change the color of the "Now" text by
127 changing the .now CSS class
128 - users can now configure the update interval. The default setting is now
129 5 minutes. This should not use too much battery, but at the same time
130 keep the "Now" text up-to-date
131 - added option to force a specific date format. dateFormat='auto'
132 (default) will use your phone's setting, 'DDMM' will display day first,
133 'MMDD' will display month first.
134 1.17 (2009-09-02) by Michael Prager
135 - fixed anniversaries for today not showing
136 - new option "eventsPerWidget": with this you can define the number of
137 events that will be shown for each widget.
138 - added new CSS class "icon": change this to modify the icon size (very
139 useful if you want to change the number of events)
140 1.18 (2009-09-04) by Michael Prager
141 - fixed ToDos being shown although includeTodos=false was set
142 - fixed ToDos being shown twice
143 - show text "No further events within 2 months" if there are no events
144 in the list. This behaviour and the text can be changed in the settings
145 1.19 (2009-09-04) by Michael Prager
146 - refixed problems that 1.18 should have solved (todos not showing, entries
147 showing twice)
148 1.20 (2009-09-05) by Michael Prager
149 - new project website at http://sourceforge.net/projects/comingnext
150 - fixed memos/anniversaries showing although they have already passed
151 - don't display weekday if date is 'Today'
152 - changed default 'Now' color to #ff00ff to make it different from the
153 'Today' color
154 - patch by pcmoore:
155 - Fix problem with appointments starting at 12p where they
156 would display as starting 12h later (midnight the following day)
157 - Add a new feature to only display the time for events happening today
158 and only the date for events beyond today (showCombinedDateTime)
159 - Add a new feature to disable showing the location of appointments
160 (showLocation)
161 1.21 (2009-10-13) by Michael Prager
162 - support daylight saving time (DST). This is based on the modifications
163 from Manfred Hanselmann (thanks for that!)
164 - added option "enableDaylightSaving" to disable DST. In case you are in a
165 timezone that has no DST, you should use this option
166 - some code cleanup (by Paul Moore)
167 - fixed alignment when calendar entries have very long description
168 1.22 (2009-12-07) by Michael Prager
169 - show "Tomorrow" instead of date if "showTodayAsText" is enabled
170 1.23 (2009-12-18) by Michael Prager
171 - added fullscreen mode (can list 30 events)
172 - added settings menu. Need to modify the widget manually anymore.
173 - fixed table cell alignment in cases where the event summary was very long
174 - fixed display of "tomorrow" text if CombinedDateTime is enabled
175 1.24 () by Michael Prager
176 - localization support added by Christophe Milsent
177 - added french translation by Christophe Milsent
178 - new option "hide Widget On Calendar Open". When enabled, this will close
179 the fullscreen widget when opening the calendar app
180 - code cleanup and size reduction
181 - update interval to detect screen rotation increased from 3 to 1 secs
182 - open calendar app when clicking anywhere in fullscreen view