Skip to content

Commit f0e83e6

Browse files
committed
update README
1 parent f8d0cf6 commit f0e83e6

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,18 @@
22

33
A demo/test page using the files in this repository can be found at [codesprite.com/rc/test.html](http://codesprite.com/rc/test.html)
44

5+
## Objective
6+
To create an alternative to the FullCalendar jquery plugin. Improvements over FullCalendar include:
7+
* Tableless layout
8+
* Overridable rendering functions
9+
* Events become independent objects that can be transferred between Calendars
10+
* Events support pre-meeting and post-meeting gaps built into the event
11+
* A new Resource container class, giving a hierarchy of Calendar -> one or more Resources -> zero or more Events
12+
* Extensible Policies - locked events, nudge later events on insert
13+
14+
515
## Status
6-
Working framework in place, currently ~95% feature-complete for the first calendar view (view one week for each
7-
resource associated with a calendar, time slots arranged vertically). At this point you can:
16+
Working framework in place, currently feature-complete for the first calendar view (view one week for each resource associated with a calendar, time slots arranged vertically). At this point you can:
817
* Drag one of the predefined meeting types onto any of the resource calendars
918
* Drag meetings within and between resources
1019
* Click on meetings to open an event-editing box
@@ -18,14 +27,6 @@ replaced by, or enhanced with server-side storage using Ajax transactions. The d
1827
event persistence when creating the calendar; these can be replaced without modifying the calendar plugin.
1928

2029

21-
## Objective
22-
To create an alternative to the FullCalendar jquery plugin. Improvements over FullCalendar include:
23-
* Tableless layout
24-
* Overridable rendering functions
25-
* Events become independent objects that can be transferred between Calendars
26-
* A new Resource container class, giving a hierarchy of Calendar -> one or more Resources -> zero or more Events
27-
* Extensible Policies - locked events, nudge later events on insert, inter-event gaps
28-
2930
## Implementation Notes
3031
Some existing code will be refactored to group customizable functionality in easy to find locations. To a large extent
3132
in the code that has been implemented so far, anything that is application-specific has been abstracted out, but
@@ -36,13 +37,9 @@ manipulation it has been included at this point in order to simplify these opera
3637
it shall be eliminated.
3738

3839
Examples of customizability include:
39-
* Rendering of calendars and events is carried out by doT javascript template functions. These can be found
40-
in the templates directory; the raw doT template code is shown in comments. These are compiled into js functions using the
41-
cut and paste compiler on http://olado.github.io/doT/. UPDATE: These are now compiled on the fly when the page is loaded
42-
* The functions used to render the calendars and events are defined in the rc_calendar default settings at the
43-
top of rc_calendar.js, but can be overridden by options passed into the rc_calendar constructor
44-
* The resources associated with the calendar are defined in <resource> tags in the html code (see test.html). I'm not
45-
sure this is good practice, so may replace it with an alternative method
40+
* Rendering of calendars and events is carried out by doT javascript template functions. These can be found in the test.html file as "SCRIPT" blocks of type "text/plain". The templates use the doT syntax format, and are compiled on page load
41+
* The functions used to render the calendars and events are defined in the rc_calendar default settings at the top of rc_calendar.js, but can be overridden by options passed into the rc_calendar constructor. Currently only view_week functions are available; view_day and view_month function will follow
42+
* The resources associated with the calendar are defined in <resource> tags in the html code (see test.html). I'm not sure this is good practice, so may replace it with an alternative method
4643
* The resource definitions include a reference to a js validation function, and a set of parameters that is passed to the
4744
validator when an event is dropped onto the resource. The example function in test.html shows how the data parameters can
4845
be used to perform bounds checking on event attributes, without writing additional code

0 commit comments

Comments
 (0)