You are here

Home » API reference » Availability Calendars 5

README.txt in Availability Calendars 5

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
  3. 7.5 README.txt
  4. 7.3 README.txt
  5. 7.4 README.txt
/**
 * README for Availability Calendars module
 * @author Dan Karran (geodaniel) <dan at karran dot net>
 */

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. drag the availability_calendars directory 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 access controls for your user roles under Administer -> User management -> Access control.
    * '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. You will find the option under 'Availability calendar support'.
 
 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. You can disable this if you are comfortable with using the theming function to display them in another location.

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.
   
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

README.txt
View source 
  1. 

  2. /**

  3.  * README for Availability Calendars module

  4.  * @author Dan Karran (geodaniel) 

  5.  */

  6. 

  7. 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.

  8. 

  9. Installation

  10. ============

  11. 

  12. To install the Availability Calendars module you should:

  13. 

  14.  1. drag the availability_calendars directory 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.

  15. 

  16.  2. enable the module under Administer -> Site building -> Modules.

  17.  

  18.  3. setup access controls for your user roles under Administer -> User management -> Access control.

  19.     * 'edit availability calendars' allows a user role to edit all availability calendars on a site.

  20.     * 'edit own availability calendars' allows a user role to only edit the availability on calendars attached to nodes they are the owner of.

  21.  

  22.  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. You will find the option under 'Availability calendar support'.

  23.  

  24.  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. You can disable this if you are comfortable with using the theming function to display them in another location.

  25. 

  26. Setting availability information

  27. ================================

  28. 

  29. 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:

  30. 

  31.  * First day of week

  32.    This will be the day that shows first in each week of the calendars for that node.

  33.    

  34. 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:

  35. 

  36.  * Note

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

  38.    

  39.  * Availability

  40.    The status for each day.