You are here

README.txt in Date Repeat Entity 7.2

Same filename and directory in other branches
  1. 7 README.txt
-- SUMMARY --

The Date Repeat Entity Module complements the Date suite of modules, in
particular the Date Repeat module.  For repeating dates that follow a
recurring rule, this module creates a unique entity for each date instance in
the series.

When an entity that belongs to a repeating date series is updated
or deleted, the user is offered the choice of updating/deleting the current
entity, all current and future entities or all entities in the series.

If the recurring rule for a date series is changed significantly (and this
can be controlled through a hook - see Customization section below) the existing
entities are replaced by a new set of entities that is generated to represent
the new series.  In this case the module provides a warning to the user if
referenced entities, associated with the current date entity, may be affected.

Note: The module includes code that specifically targets 'node' entities.
However, many of the functions have been written generically so that they
will work with other entity types.

-- REQUIREMENTS --

The following modules must be installed and enabled for this module to work:

* Date, Date API, Date Repeat, Date Repeat Field (all part of Date module)
* Entity
* Replicate
* UUID

-- INSTALLATION --

* Install as usual.  For more information see
 https://drupal.org/documentation/install/modules-themes/modules-7

-- CONFIGURATION --

* Go to admin/config/date/date_repeat_entity and check each content type that
  you want to enable for this module.

* The module will create two additional fields for each enabled content type.

* If necessary, add a date field to each content type.  (Make sure the date
  field is configured as a repeating date with an end date.)

-- CUSTOMIZATION --

* When a date series is changed it may be  significant enough that the existing
  entities in the series should be deleted and replaced by a new series.  This
  module provides HOOK_repeat_entity_repeating_date_has_changed that gives other
  module developers the ability to determine when the change is significant such
  that the series is replaced.

* If a date series that is changed and the change is not significant to generate
  a new series the existing entities representing each date in the series are
  updated.  A separate HOOK_repeating_date_update is provided to enable other
  module developers to determine which properties and fields of each entity
  should be updated.

-- CONTACT --

Current maintainers:
* Simon Shutter (eft) - https://drupal.org/user/458578
* Tom Metzger (tmetzger) - https://drupal.org/user/423974

This project has been sponsored by:

* Groupanizer Technology Services

  We create websites and online tools that help choirs, choruses and music
  groups manage and organize members, music and more while creating a
  captivating public presence.  Visit http://www.groupanizer.com/ for more
  information.

File

README.txt
View source
  1. -- SUMMARY --
  2. The Date Repeat Entity Module complements the Date suite of modules, in
  3. particular the Date Repeat module. For repeating dates that follow a
  4. recurring rule, this module creates a unique entity for each date instance in
  5. the series.
  6. When an entity that belongs to a repeating date series is updated
  7. or deleted, the user is offered the choice of updating/deleting the current
  8. entity, all current and future entities or all entities in the series.
  9. If the recurring rule for a date series is changed significantly (and this
  10. can be controlled through a hook - see Customization section below) the existing
  11. entities are replaced by a new set of entities that is generated to represent
  12. the new series. In this case the module provides a warning to the user if
  13. referenced entities, associated with the current date entity, may be affected.
  14. Note: The module includes code that specifically targets 'node' entities.
  15. However, many of the functions have been written generically so that they
  16. will work with other entity types.
  17. -- REQUIREMENTS --
  18. The following modules must be installed and enabled for this module to work:
  19. * Date, Date API, Date Repeat, Date Repeat Field (all part of Date module)
  20. * Entity
  21. * Replicate
  22. * UUID
  23. -- INSTALLATION --
  24. * Install as usual. For more information see
  25. https://drupal.org/documentation/install/modules-themes/modules-7
  26. -- CONFIGURATION --
  27. * Go to admin/config/date/date_repeat_entity and check each content type that
  28. you want to enable for this module.
  29. * The module will create two additional fields for each enabled content type.
  30. * If necessary, add a date field to each content type. (Make sure the date
  31. field is configured as a repeating date with an end date.)
  32. -- CUSTOMIZATION --
  33. * When a date series is changed it may be significant enough that the existing
  34. entities in the series should be deleted and replaced by a new series. This
  35. module provides HOOK_repeat_entity_repeating_date_has_changed that gives other
  36. module developers the ability to determine when the change is significant such
  37. that the series is replaced.
  38. * If a date series that is changed and the change is not significant to generate
  39. a new series the existing entities representing each date in the series are
  40. updated. A separate HOOK_repeating_date_update is provided to enable other
  41. module developers to determine which properties and fields of each entity
  42. should be updated.
  43. -- CONTACT --
  44. Current maintainers:
  45. * Simon Shutter (eft) - https://drupal.org/user/458578
  46. * Tom Metzger (tmetzger) - https://drupal.org/user/423974
  47. This project has been sponsored by:
  48. * Groupanizer Technology Services
  49. We create websites and online tools that help choirs, choruses and music
  50. groups manage and organize members, music and more while creating a
  51. captivating public presence. Visit http://www.groupanizer.com/ for more
  52. information.