Permalink
Browse files

documentation

  • Loading branch information...
1 parent 580690a commit a76b4c3bba40fd14b3e3092c9768394f55dd81aa @angelic angelic committed Jun 24, 2009
Showing with 12 additions and 8 deletions.
  1. +12 −8 README.markdown
View
20 README.markdown
@@ -10,17 +10,21 @@ To generate the ScheduleFu migrations, run:
Below is a diagram of the models. The database diagram can be found in docs/database.png along with the original Dia file.
-Calendar_recurrences is used for specific information on
-particular recurring dates. Calendar_event_mods stores any modification to a particular
-calendar_event. Calendar_event_types stores the different kinds of events.
-Calendar_dates has a row for every day and will automatically generate rows for a
+## Tables
+
+* calendars: distinct calendar that can be associated with your own models
+* calendar_recurrences: specific information on particular recurring dates
+* calendar_event_mods: modification to a particular calendar_event
+* calendar_event_types: different types of events
+* calendar_dates: has a row for every day and will automatically generate rows for a
year before or after any date used in an event.
+* calendar_event_dates: a view that has a row for each date included in the event, original or modified information if a column was modified (time, description, etc), plus some additional informational columns
-Calendar_event_dates is a view that has a row for each date included in the event, plus some additional informational columns.
+## Informational columns in calendar_event_dates
-* added: True if this date was added as a mod and not in the original event.
-* modified: For dates that are included in the original event but have been modified (time, description, etc). Any modified columns will have the modified data rather than the original in this view.
-* removed: true if this particular date was removed. There are named scopes in calendar_event_dates for :removed and :not_removed.
+* added: true if this date was added as a mod and not in the original event
+* modified: for dates that are included in the original event but have been modified (time, description, etc)
+* removed: true if this particular date was removed. There are named scopes in calendar_event_dates for :removed and :not_removed
![database.png](http://angelic.github.com/schedule_fu/database.png)

0 comments on commit a76b4c3

Please sign in to comment.