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