You are here

README2.x.txt in Availability Calendars 7.2

/**
 * README for Availability Calendars module
 * @author Dan Karran (geodaniel) <dan at karran dot net>
 * @author Nicholas Alipaz (nicholas.alipaz)
 * @author Erwin Derksen (http://drupal.org/user/750928)
 */

NOTE: THIS INFORMATION IS OUTDATED AND NEEDS TO BE UPDATED TO REFLECT THE
      CURRENT FEATURES.

The availability calendars module allows for a site administrator to display
availability information on specified content types. You can choose the number
of months to show on each node as well as which day of the week to start the
calendars on for that node. Each week can have a short note displayed about it
(e.g. a rental price for that week) and each day can have a colour-coded status.

Installation
============

To install the Availability Calendars module you should:

 1. Extract the availability_calendars module (zip/tarball) into your
    sites/[sitename]/modules directory if it is just for use on a single site,
    or to the sites/all/modules directory if there is more than one site running
    on your Drupal installation that will be using this module.

 2. Enable the module under Administer -> Site building -> Modules.

 3. Setup permissions for your user roles under
    Administer -> User management -> Permissions.
      * 'edit availability calendars' allows a user role to edit all
        availability calendars on a site.
      * 'edit own availability calendars' allows a user role to only edit the
        availability on calendars attached to nodes they are the owner of.

 4. Enable availability calendars for any node type you wish (you may want to
    create a custom one content type) under Administer -> Content management ->
    Content types. The setting can be found in the 'Availability calendar
    settings' part of the form.

 5. Choose the global settings for the availability calendars under
    Administer -> Site configuration -> Availability calendars. You can choose
    how many months will be shown for each node and whether or not to display
    the calendars on the node page itself. Note that users with  enough
    permissions will see three extra months on nodes with availability calendars
    to allow them to set up the availability before those months are shown to
    users of the site. You can disable the display of calendars on nodes if you
    are comfortable with using the theming function to display them in another
    place (for example if you want to put all the availability calendars for
    your site on a single page).  There are additional settings here that you
    may want to consider setting to your preferences.

Setting availability information
================================

For each content type that has availability calendar support enabled, you will
see an 'Availability calendar settings' section on the node edit page where you
can change the following general option for the availability calendar on that
node:

  * First day of week
    This will be the day that shows first in each week of the calendars for that
    node.
  * Show a key for the availability calendars
  * Use only the first letter from the day of the week
  * Set all calendars to have their past dates shown as fully booked

When looking at a node that has availability calendars enabled, you can click
edit on any month you have the permission to edit, where you'll be able to set:

  * Note
    A note to show beside each week, for example a price.

  * Availability
    The status for each day.

File

README2.x.txt
View source
  1. /**
  2. * README for Availability Calendars module
  3. * @author Dan Karran (geodaniel)
  4. * @author Nicholas Alipaz (nicholas.alipaz)
  5. * @author Erwin Derksen (http://drupal.org/user/750928)
  6. */
  7. NOTE: THIS INFORMATION IS OUTDATED AND NEEDS TO BE UPDATED TO REFLECT THE
  8. CURRENT FEATURES.
  9. The availability calendars module allows for a site administrator to display
  10. availability information on specified content types. You can choose the number
  11. of months to show on each node as well as which day of the week to start the
  12. calendars on for that node. Each week can have a short note displayed about it
  13. (e.g. a rental price for that week) and each day can have a colour-coded status.
  14. Installation
  15. ============
  16. To install the Availability Calendars module you should:
  17. 1. Extract the availability_calendars module (zip/tarball) into your
  18. sites/[sitename]/modules directory if it is just for use on a single site,
  19. or to the sites/all/modules directory if there is more than one site running
  20. on your Drupal installation that will be using this module.
  21. 2. Enable the module under Administer -> Site building -> Modules.
  22. 3. Setup permissions for your user roles under
  23. Administer -> User management -> Permissions.
  24. * 'edit availability calendars' allows a user role to edit all
  25. availability calendars on a site.
  26. * 'edit own availability calendars' allows a user role to only edit the
  27. availability on calendars attached to nodes they are the owner of.
  28. 4. Enable availability calendars for any node type you wish (you may want to
  29. create a custom one content type) under Administer -> Content management ->
  30. Content types. The setting can be found in the 'Availability calendar
  31. settings' part of the form.
  32. 5. Choose the global settings for the availability calendars under
  33. Administer -> Site configuration -> Availability calendars. You can choose
  34. how many months will be shown for each node and whether or not to display
  35. the calendars on the node page itself. Note that users with enough
  36. permissions will see three extra months on nodes with availability calendars
  37. to allow them to set up the availability before those months are shown to
  38. users of the site. You can disable the display of calendars on nodes if you
  39. are comfortable with using the theming function to display them in another
  40. place (for example if you want to put all the availability calendars for
  41. your site on a single page). There are additional settings here that you
  42. may want to consider setting to your preferences.
  43. Setting availability information
  44. ================================
  45. For each content type that has availability calendar support enabled, you will
  46. see an 'Availability calendar settings' section on the node edit page where you
  47. can change the following general option for the availability calendar on that
  48. node:
  49. * First day of week
  50. This will be the day that shows first in each week of the calendars for that
  51. node.
  52. * Show a key for the availability calendars
  53. * Use only the first letter from the day of the week
  54. * Set all calendars to have their past dates shown as fully booked
  55. When looking at a node that has availability calendars enabled, you can click
  56. edit on any month you have the permission to edit, where you'll be able to set:
  57. * Note
  58. A note to show beside each week, for example a price.
  59. * Availability
  60. The status for each day.