Index: README.txt =================================================================== RCS file: /cvs/drupal/contributions/modules/eventrepeat/README.txt,v retrieving revision 1.3 diff -u -r1.3 README.txt --- README.txt 21 Feb 2006 01:28:02 -0000 1.3 +++ README.txt 30 May 2007 16:51:45 -0000 @@ -1,24 +1,189 @@ -//this module is currently in beta release. +$Id$ -Eventrepeat enables the creation of repeating events for node types that are event-enabled. +About +--------------- -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: +Eventrepeat enables the creation of repeating events +for node types that are event-enabled. - 1. Recurrance 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 + +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 + + +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 5 or higher. +This module requires event.module. +This module requires cron, but it can be run manually (see below). + + +Installation +--------------- For installation instructions, see INSTALL.txt in this folder -For more information on how to create repeat sequences, visit adiminister->help->eventrepeat -after module installation. -The following is a wish list for ugrades to this module. If you'd be interested in -providing financial sponsorship for any of these features, please email -thehunmonkgroup@yahoo.com +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 +--------------- -// TODO's -// 2. add ical support \ No newline at end of file +Written by hummonk (thehunmonkgroup@yahoo.com) +Currently maintained by Sean B. Fuller (sean@seanbfuller.com) Index: INSTALL.txt =================================================================== RCS file: /cvs/drupal/contributions/modules/eventrepeat/INSTALL.txt,v retrieving revision 1.4.2.2 diff -u -r1.4.2.2 INSTALL.txt --- INSTALL.txt 28 Mar 2007 14:24:47 -0000 1.4.2.2 +++ INSTALL.txt 30 May 2007 16:51:45 -0000 @@ -1,26 +1,40 @@ -TO INSTALL: -Note: It is assumed that you have Drupal up and running. Be sure to +$Id$ + +Requirements +------------ + +This module requires Drupal 5 or higher. +This module requires event.module. +Some functions of this module require cron. + +Installation +------------ + +It is assumed that you have Drupal up and running. Be sure to check the Drupal web site if you need assistance. If you run into problems, you should always read the INSTALL.txt that comes with the Drupal package and read the online documentation. -:Preparing for Installation: +You should also have event.module installed before you begin. + +You must have cron running on your site (and be visiting your site's cron.php +page) for eventrepeat to work properly, and it's suggested that the cron runs +happen at least twice a day. Note: Backing up your database is a very good idea before you begin! -1. Place the eventrepeat package into your Drupal modules/ directory. +1. Place the eventrepeat package into your Drupal sites/all/modules/ directory. 2. Enable the eventrepeat module by navigating to: administer > modules - Note: you must also install and enable the event package, as - eventrepeat depends on it! - Click the 'Save configuration' button at the bottom to commit your changes. 3. Configure the options for the module under Administer > Site Configuration > Repeating events + + See README.txt for an explanation of repeat settings. 4. In order for repeating events to be created for a node type, you must first configure that node type to be enabled for repeating events. Enable the node @@ -38,6 +52,6 @@ Administer > User management > Access control -7. You must have cron running on your site (and be visiting your site's cron.php - page) for eventrepeat to work properly, and it's suggested that the cron runs - happen at least twice a day. +7. Check that cron.php is working correctly. + + See the section on cron in the README.txt file.