Products.PloneBooking 2.2.1

PloneBooking Documentation
==========================


Required products
-----------------

* Plone 3.1.x



Installing PloneBooking
-----------------------

* with easy install::

easy_install Products.PloneBooking

* with buildout, just add Products.PloneBooking in your egg list then::

bin\buildout

* Use portal_quickinstaller to install the PloneBooking in ZMI (or use plone_setup in pmi)



Overview
--------

PloneBooking proposes several content types for Plone: a booking center that
contains bookable objects and bookings.
You can do some configuration in your booking center like choosing the default view
or determining types and categories for bookable objects.

How to book objects ?

1. Add a booking on a bookable object.

* There are two methods :

- Browse the calendar and click on the '+' in one of the cells.

- Click "add booking" on a bookable object.

* Then :

- fill out the form: title (not necessary), your name and email.

- Choose an interval for your booking.

- You might want to add a comment.

- Validate. Perhaps there is an other booking for the same object at the same time. If so change your request.

2. Adding periodicity settings to your booking (Wich will regularly duplicate your booking).

- Select your booking in your calendar or in the listing view.

- Click on the periodicity tab.

- There are 3 kinds of periodicity.

- Set the finishing date of your periodicity.

- Click "display results". It will show you every booking to create.

- Click "Create bookings" if you agree with the results.

* Note:

- The first booking isn't shown as it's your original booking.

- Some might be already booked. Select an other date or interval by coming back on the 'edit' tab.

3. Removing a booking

- Come back to your booking throught the calendar view or listing view.

- Click "Retract"

- That's it, your booking has been removed.

* Bookings you've just created can be in a pending state. (depending how your booking center has been set up). Just wait for a moderator to validate it.

How to install and configure it ?

1. Uncompress it in your Products/ folder of your plone instance.

2. Install it via "Plone Site" -> "Plone Setup" -> "Add / Remove Products":
Select PloneBooking then click "Install"

3. Add a booking center through the Plone Interface. (Adding a Booking Center through the ZMI won't work).//

* Write a short description about your booking service.

* Add the kind of ressources we might book.

* Add categories of your ressources (not especially needed).

* Select in wich kind of display you want to see your bookings (in a listing or a calendar).

* Select listings available for a whole day, week, month or a year.

* Choose the interval your calendar will display by day.

* If you wish, choose custom colors to display 'pending' and 'booked' bookings.

* Choose if you want to wait for a moderator to publish or not your bookings.

* You'll have to publish this object to allow members to add their bookings.

4. Add a bookable object in your booking center.

* Set the name of your item.

* Fill out a short description of you object.

* Choose the kind of ressource and the category corresponding to your object.

* Fill out a full text for more information.

* Note: Your booking center and bookable objects might have to be published to let members to add bookings. (Depending how you set them up)

PloneBooking Content Types

* BookingCenter: it is the main container. You can create one or more BookingCenter on a plone site.

* BookableObject: this is a ressource that users could book (like a room for example).

* Booking: you create this kind of objet to book a BookableObject.

Additional tools

- **BookingTool**

A tool is installed by the installer. It provides mainly some datemanagement methods.

Credits

Concept, development and tests

The Ingeniweb team http://www.ingeniweb.com

Translations

Dutch by Sander van Geloven <sander@atopia.nl>

Italian by Vincenzo Barone <vincenzo.barone@abstract.it>

CHANGELOG
=========


2.2.1 - 2008/11/21

* Product is eggified

* Plone 3.1 compliance : javascript don't use RegisterPloneFunction and
other old methods anymore, uses jquery instead.

* Fix javascript error when there's no category

2.2.0 - 2008/04/08

* Full ajax to add bookings

* Is Plone 3 compliant, Older release are not supported

* Export is now available

* Added Czech translation (initial) by Lukas Zdych

* Does not display links to add booking when you don't have the permission

* Added german translation, thanks to Sebastian Stark (seb AT biskalar de)

* Changed plonebooking_macros.pt to only show the possibility of adding
bookings when this is permitted. (Suggested by Sebastian Stark (seb AT biskalar de))

2.0.12 - 2006/11/13

* Cleaned up .po files (Maik Röder)

* Fix for a translation issue where there was no month name in month view. (Maik Röder)

* Added Dutch translation by Sander van Geloven

2.0.11 - 2006/04/19

* Add ajax to display booking information in a popup in calendar view

* Display "+" button on BookableObject calendar view for anonymous

* Fix a bug in plonebooking_add script when portal_factory is not activated
on Booking objects

2.0.10 - 2006/04/07

* Release on Plone.org

* Make it compatible with Plone 2.1

* Do not shows booking in the navtree anymore

2.0.9 - 2006/03/23

* Check date when creating a new booking. End date must be later than
start date.

2.0.8 - 2006/03/09

* Only authenticated users can use plonebooking_add_form template

2.0.7 - 2006/02/24

* Add progress bar when deleting or retracting bookings

2.0.6 - 2006/02/13

* Add translations

* Sort category and resources on the calendar view

* Fix a bug on second type of periodicity. It was impossible to create bookings

2.0.5 - 2006/02/08

* Add a progess bar when creating periodic bookings.

2.0.4 - 2006/02/02

* Fix: Booking finishing at the same time a periodicity booking start and its
opposite used to being shown as reserved

2.0.3 - 2006/01/31

* Fix bug : when creating periodic bookings, engine was't looking for existing
booking in the same periods.

2.0.2 - 2006/01/26

* Fixed bug with timezone changes

2.0 - 2006/01/12

* When creating periodic booking display a waiting message for the user

* Display local date and not gmt date

* Use folder_workflow for BookingCenter

* When adding a booking, round minutes to a multiple of 5

* Big refactoring of version 1.0

1.0 - 2005/08/12

* Improve calendar views

* Add periodic bookings feature

* move tool properties (categories, types) to the BookingCenter

* add two properties "default_calendar_view" and "available_calendar_views" on BookingCenter