modules/eventrepeat/README.txt

$Id: README.txt,v 1.3.6.3 2008/03/03 00:12:02 seanfuller Exp $

About
---------------

Eventrepeat enables the creation of repeating events 
for node types that are event-enabled.


Features
---------------
- Basic repeat types of daily, weekly, monthly or yearly.
- Repeating events limited by count or end date.
- Optional advanced controls to add repeats by:
   - every other, every third, etc.
   - day of week per month
   - xth day of week per month
   - xth from last day of week per month
   - month
   - number of the day per month
   - number of the day in the year
   - week number
- Exceptions (currently disabled)


Contact
---------------

Log bug reports and feature requests at
   http://drupal.org/project/issues/eventrepeat
   
Or send comments to sean@seanbfuller.com

If you'd be interested in providing financial sponsorship 
for continued development of this module, contact
thehunmonkgroup@yahoo.com


Requirements
------------

This module requires Drupal 6 or higher.
This module requires event.module 6.x-1.x.
This module requires cron, but it can be run manually (see below).


Installation
---------------

For installation instructions, see INSTALL.txt in this folder


Repeat Patterns
---------------

Eventrepeat's pattern creation was largely modeled on the iCal 
RRULE specification. At this time, it should support all RRULE 
parameters, with the following exceptions:

   1. Recurrence periods less than DAILY
   2. BYDAY declarations greater than 5 and less than -5 
      (ex. 20th Monday of the year is not supported).
      Other similar patterns can be built that should
      approximate this functionality.
   3. BYSETPOS parameter


Cron
---------------

For best results, cron should be enabled to hit cron.php on your site.
For more information on setting up cron, see

   http://drupal.org/cron

During the installation process, eventrepeat_cron() will be called and up to
2000 records will be inserted into the event_repeat_calendar_map table. 
Future calls to cron.php will create additional entries in this table, so that
the table contains 2000 entries, one for each day out to 2000 days from today.
Note that this assumes that you have not reduced the Render support period.

Calling cron.php will also delete any records in event_repeat_calendar_map
before yesterday in an attempt to keep this table from getting too large.


Settings
---------------

Event Display

 - Title tag
 
   Enter a tag that will be prepended to all events in a repeat sequence. 
   Leave this blank if you don't want any indicator to display.

Advanced Control

 - Show the following controls

   These options will appear in the advanced fieldset of the repeat 
   fieldset on nodes that use repeat events. Note that enabling all
   of these will confuse some users. Each option is described here:

    - Interval

      Frequency of repeat: 1 = every, 2 = every other, 3 = every 3rd, etc.

    - By day of the week

      This is a giant list of the seven days of the week, followed
      by additional options for more complex repeat patterns.
      Determines what day(s) of the week/month this event repeats on 
      by day of the week. Scroll down to get options such as "3rd from 
      Last Friday" or "1st Saturday".

    - By month

      This is a multiple-select box of the 12 month names.
      Selects what month(s) of the year this event repeats on

    - By days of the month

      This is a multiple-select box of numbers from 1 to 31 and -1 to -31.
      Determines what day(s) of the month this event repeats on
      (the actual day number in the month). Negative numbers count
      from the end of the month.

    - By days of the year

      This is a multiple-select box of numbers from 1 to 366 and -1 to -366.
      Determines what day(s) of the year this event repeats on. 
      Negative numbers count from the end of the year.

    - By number of the week

      This is a multiple-select box of numbers from 1 to 54 and -1 to -54.
      Selects what week(s) of the year this event repeats on. 
      Negative numbers count from the end of the year.

Repeat Sequence Behavior

 - Initial render period
 
   Initial period of time for which a repeat sequence is rendered upon 
   its creation - also the number of days from the current date that 
   repeating nodes are automatically updated (events outside this range 
   will only be rendered upon first viewing of a calendar period that 
   contains them, up to the rendering support period). 
   Default value is 90 days. Maximum allowed value is 730 days.

 - Render support period
   
   Number of days from current date that repeat rendering is supported. 
   Default is 2000 days, and it's recommended that this value be kept. 
   Maximum allowed value is 10000. Note that the database is refreshed 
   with this many rows from today's date on the first cron run or if 
   cron has not been run in a while. High values could, potentially, 
   cause a cron or database timeout. (See the section on cron below.)

 - Leave individual edits in sequence
 
   If selected, individually edited nodes will remain part of their repeat 
   sequence. WARNING: Subsequent mass edits involving the individually 
   edited node will overwrite the old data!

 - By default, apply edits to
 
   Sets the default selection for how repeating events are edited. 
   "All occurrences" will make the default to edit all events in the 
   sequence after today's date. "The event being edited and all 
   future occurrences" will make the default to edit events from 
   the date of the selected node forward. "Only the event being edited" 
   will make editing the one event the default and may remove the event 
   from the sequence depending on the setting above.

Form Display

 - Show the form elements in this order

   This will determine the order of date elements in the node form for 
   the repeat end and exception controls. This essentially localizes
   the date form elements for repeat event. Hopefully this will be taken
   care of by a more centralized setting in the future.

Credits
---------------

Written by hummonk (thehunmonkgroup@yahoo.com)
Currently maintained by Sean B. Fuller (sean@seanbfuller.com)
Currently maintained by Robert Middleswarth (rmiddle)
1	$Id: README.txt,v 1.3.6.3 2008/03/03 00:12:02 seanfuller Exp $
2
3	About
4	---------------
5
6	Eventrepeat enables the creation of repeating events
7	for node types that are event-enabled.
8
9
10	Features
11	---------------
12	- Basic repeat types of daily, weekly, monthly or yearly.
13	- Repeating events limited by count or end date.
14	- Optional advanced controls to add repeats by:
15	- every other, every third, etc.
16	- day of week per month
17	- xth day of week per month
18	- xth from last day of week per month
19	- month
20	- number of the day per month
21	- number of the day in the year
22	- week number
23	- Exceptions (currently disabled)
24
25
26	Contact
27	---------------
28
29	Log bug reports and feature requests at
30	http://drupal.org/project/issues/eventrepeat
31
32	Or send comments to sean@seanbfuller.com
33
34	If you'd be interested in providing financial sponsorship
35	for continued development of this module, contact
36	thehunmonkgroup@yahoo.com
37
38
39	Requirements
40	------------
41
42	This module requires Drupal 6 or higher.
43	This module requires event.module 6.x-1.x.
44	This module requires cron, but it can be run manually (see below).
45
46
47	Installation
48	---------------
49
50	For installation instructions, see INSTALL.txt in this folder
51
52
53	Repeat Patterns
54	---------------
55
56	Eventrepeat's pattern creation was largely modeled on the iCal
57	RRULE specification. At this time, it should support all RRULE
58	parameters, with the following exceptions:
59
60	1. Recurrence periods less than DAILY
61	2. BYDAY declarations greater than 5 and less than -5
62	(ex. 20th Monday of the year is not supported).
63	Other similar patterns can be built that should
64	approximate this functionality.
65	3. BYSETPOS parameter
66
67
68	Cron
69	---------------
70
71	For best results, cron should be enabled to hit cron.php on your site.
72	For more information on setting up cron, see
73
74	http://drupal.org/cron
75
76	During the installation process, eventrepeat_cron() will be called and up to
77	2000 records will be inserted into the event_repeat_calendar_map table.
78	Future calls to cron.php will create additional entries in this table, so that
79	the table contains 2000 entries, one for each day out to 2000 days from today.
80	Note that this assumes that you have not reduced the Render support period.
81
82	Calling cron.php will also delete any records in event_repeat_calendar_map
83	before yesterday in an attempt to keep this table from getting too large.
84
85
86	Settings
87	---------------
88
89	Event Display
90
91	- Title tag
92
93	Enter a tag that will be prepended to all events in a repeat sequence.
94	Leave this blank if you don't want any indicator to display.
95
96	Advanced Control
97
98	- Show the following controls
99
100	These options will appear in the advanced fieldset of the repeat
101	fieldset on nodes that use repeat events. Note that enabling all
102	of these will confuse some users. Each option is described here:
103
104	- Interval
105
106	Frequency of repeat: 1 = every, 2 = every other, 3 = every 3rd, etc.
107
108	- By day of the week
109
110	This is a giant list of the seven days of the week, followed
111	by additional options for more complex repeat patterns.
112	Determines what day(s) of the week/month this event repeats on
113	by day of the week. Scroll down to get options such as "3rd from
114	Last Friday" or "1st Saturday".
115
116	- By month
117
118	This is a multiple-select box of the 12 month names.
119	Selects what month(s) of the year this event repeats on
120
121	- By days of the month
122
123	This is a multiple-select box of numbers from 1 to 31 and -1 to -31.
124	Determines what day(s) of the month this event repeats on
125	(the actual day number in the month). Negative numbers count
126	from the end of the month.
127
128	- By days of the year
129
130	This is a multiple-select box of numbers from 1 to 366 and -1 to -366.
131	Determines what day(s) of the year this event repeats on.
132	Negative numbers count from the end of the year.
133
134	- By number of the week
135
136	This is a multiple-select box of numbers from 1 to 54 and -1 to -54.
137	Selects what week(s) of the year this event repeats on.
138	Negative numbers count from the end of the year.
139
140	Repeat Sequence Behavior
141
142	- Initial render period
143
144	Initial period of time for which a repeat sequence is rendered upon
145	its creation - also the number of days from the current date that
146	repeating nodes are automatically updated (events outside this range
147	will only be rendered upon first viewing of a calendar period that
148	contains them, up to the rendering support period).
149	Default value is 90 days. Maximum allowed value is 730 days.
150
151	- Render support period
152
153	Number of days from current date that repeat rendering is supported.
154	Default is 2000 days, and it's recommended that this value be kept.
155	Maximum allowed value is 10000. Note that the database is refreshed
156	with this many rows from today's date on the first cron run or if
157	cron has not been run in a while. High values could, potentially,
158	cause a cron or database timeout. (See the section on cron below.)
159
160	- Leave individual edits in sequence
161
162	If selected, individually edited nodes will remain part of their repeat
163	sequence. WARNING: Subsequent mass edits involving the individually
164	edited node will overwrite the old data!
165
166	- By default, apply edits to
167
168	Sets the default selection for how repeating events are edited.
169	"All occurrences" will make the default to edit all events in the
170	sequence after today's date. "The event being edited and all
171	future occurrences" will make the default to edit events from
172	the date of the selected node forward. "Only the event being edited"
173	will make editing the one event the default and may remove the event
174	from the sequence depending on the setting above.
175
176	Form Display
177
178	- Show the form elements in this order
179
180	This will determine the order of date elements in the node form for
181	the repeat end and exception controls. This essentially localizes
182	the date form elements for repeat event. Hopefully this will be taken
183	care of by a more centralized setting in the future.
184
185	Credits
186	---------------
187
188	Written by hummonk (thehunmonkgroup@yahoo.com)
189	Currently maintained by Sean B. Fuller (sean@seanbfuller.com)
190	Currently maintained by Robert Middleswarth (rmiddle)