.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ========== EXT: event ========== :Author: Kasper Skårhøj :Created: 2002-11-01T00:32:00 :Changed: 2011-11-13T15:48:39 :Author: Joachim Ruhs :Email: postmaster@joachim-ruhs.de :Info 3: :Info 4: .. _EXT-event: EXT: event ========== Extension Key: event Copyright 2007, 2008 Joachim Ruhs, This document is published under the Open Content License available from http://www.opencontent.org/opl.shtml The content of this document is related to TYPO3 \- a GNU/GPL CMS/Framework available from www.typo3.com .. _Table-of-Contents: Table of Contents ----------------- **EXT: event 1** **Introduction 1** What does it do? 1 Sponsoring 1 Sponsorship 1 **Screenshots 2** **Installation 6** **Setup a form 7** **Configuration 9** **Reference 9** **FAQ 9** **Appendix 9** Known problems 9 To-Do 9 Changelog 10 .. _Introduction: Introduction ------------ .. _What-does-it-do: What does it do? ^^^^^^^^^^^^^^^^ Event is a frontend plugin to display a booking form for the customer to book an event. The customer is sent an email with an confirmation link. After confirming, the administrator is informed of the booking via email. Because different events have different attributes, the form can be setup with the attribute fields in the TYPO3 backend. In the additional fields you can set the prices for the attributes. In the admin view, the administrator can download a csv-file of the bookings or he can view the actual bookings of an event. .. _What-s-new: What's new ^^^^^^^^^^ New fields are added to the tables, tx\_event\_event.maxparticipants, tx\_event\_event.timeofstart. The event list is now template based. I have inserted the IP-address of the customer to the admin views and the csv-exports. There was also done a bugfix, see changelog of this manual. The extension is in production at `www.neulandwalk.de `_ of the Sportpark Leverkusen. .. _Sponsoring: Sponsoring ^^^^^^^^^^ For further development of the extension, sponsoring is welcome – please contact the author. .. _Sponsorship: Sponsorship ^^^^^^^^^^^ **Thomas Heyse, heysemedia** , `http://www.heyse.de `_ **Mag Helmut Prochart** , `http://www.sitedefinition.at `_ .. _Screenshots: Screenshots ----------- |img-1| **The event selection screen** |img-2| **The input form screen** |img-3| **Second part of the input form** |img-4| **Confirmation mail which is sent to the customer with confirmation link** |img-5| **Administrator email which is sent to the administrator after the customer confirms the confirmation link** |img-6| **Admin page where details of the customers of an event can be shown or a csv export can be started** |img-7| **Admin details** .. _Installation: Installation ------------ Just install the extension like other extensions from the typo3 extension repository TER. Create a page where you want to use the plugin. Put a new content element of the plugin event to this page. In the flexform setup make the necessary changes for your setup. Choose also a startingpoint where the datarecords will be located. Because the extension sends emails, set up correct email addresses for the administrator. Teilnehmerzahl + - this number is added to the count of bookers for advertising purposes only. Konfirmation in [sec] – that's the time the confirmation code is valid. |img-8| Create another page where the administrator page will be located |img-9| |img-10| Make the necessary changes in the flexform setup, especially set the correct starting point for the plugin. If all is done, you we set up an form with additional fields. Additional fields in the form are located in sections. Therefore you need to set up one or more sections first. For this, go to the TYPO3 list module, select the startingpoint page and insert an event section. Now you can set up additional fields in this sections (radio buttons, checkboxes and freetext). Radiobuttons are always required fields in the form. Checkboxes are optional. When all is done, you can test your form. .. _Setup-a-form: Setup a form ------------ In this chapter I will describe how to set up a form with two radiobuttons and 1 checkbox. Go to the TYPO3 list module and select the page where the datarecords will be stored ( that is the startingpoint of the extension). Create a new datarecord event-section. Name him “Strecke”. |img-11| Now you can create an event the same way (in our example “Kenzinger Lauf”). |img-12| We create now some attributes for this event and this section. Go to the TYPO3 list module and create a new data record Attribute. Give him a title, title will be shown in the form. Select the layout type and the event and also the section (“Gruppe”) where the radiobutton have to be located. The same way create a second radiobutton and assign him to the same section. Create a new section for the checkbox. Create the checkbox in same manner. In the list view of TYPO3 you can change the sorting of the attributes for your desires. |img-13| Now view the form and check if everything is ok. .. _Configuration: Configuration ------------- The configuration of the plugin is done in the flexform of the extension – most of them are self explaining. All flexform values can be overwritten by Typoscript code. .. _Reference: Reference --------- Options in the template SETUP: If this options are set in the template setup, they overrule the flexform-settings. *plugin.tx\_event\_pi1* : .. ### BEGIN~OF~TABLE ### .. _adminEmail: adminEmail ^^^^^^^^^^ .. container:: table-row Property adminEmail Data type string Description Email address where the admin emails are sent to Default .. _bookingLink: bookingLink ^^^^^^^^^^^ .. container:: table-row Property bookingLink Data type string Description The text of the booking link Default .. _codeValidity: codeValidity ^^^^^^^^^^^^ .. container:: table-row Property codeValidity Data type int Description The time in seconds of the validity of the confimation link Default 3600 .. _conditionsPid: conditionsPid ^^^^^^^^^^^^^ .. container:: table-row Property conditionsPid Data type int Description The page-id of the form conditions Default .. _counterStart: counterStart ^^^^^^^^^^^^ .. container:: table-row Property counterStart Data type int Description This is the number added to the real bookings of an event Default 0 .. _currency: currency ^^^^^^^^ .. container:: table-row Property currency Data type string Description Html-code of the used currency Default € .. _dateFormat: dateFormat ^^^^^^^^^^ .. container:: table-row Property dateFormat Data type string Description The formatstring for the date Default d.m.Y .. _debug: debug ^^^^^ .. container:: table-row Property debug Data type int Description Enable debug mode especially for the use with cc\_debug Default 0 .. _detailLink: detailLink ^^^^^^^^^^ .. container:: table-row Property detailLink Data type string Description The text of the detail link Default .. _displayMode: displayMode ^^^^^^^^^^^ .. container:: table-row Property displayMode Data type string Description The display mode of the plugin. Values are adminView and formView Default .. _emailSender: emailSender ^^^^^^^^^^^ .. container:: table-row Property emailSender Data type string Description The address of the sender Default .. _emailSubject: emailSubject ^^^^^^^^^^^^ .. container:: table-row Property emailSubject Data type string Description The email subject Default .. _noBookingLink: noBookingLink ^^^^^^^^^^^^^ .. container:: table-row Property noBookingLink Data type string Description The text if event is sold out Default .. _removeExported: removeExported ^^^^^^^^^^^^^^ .. container:: table-row Property removeExported Data type int Description If set, removes exported datarecords from the database Default 0 .. _removeUnused: removeUnused ^^^^^^^^^^^^ .. container:: table-row Property removeUnused Data type int Description If set, removes unused datarecords after the confimation time is exceeded Default 1 .. _requiredField: requiredField ^^^^^^^^^^^^^ .. container:: table-row Property requiredField Data type string Description A comma separated list of the required fields in the form Default .. ###### END~OF~TABLE ###### Example: plugin.tx\_event\_pi1.codeValidity = 300 .. _FAQ: FAQ --- In the admin view I can't see any customer or events. Make sure you have choosen the same starting point as in the form is set. .. _Appendix: Appendix -------- .. _Known-problems: Known problems ^^^^^^^^^^^^^^ - none - if you catch bugs, please report to postmaster@joachim-ruhs.de .. _To-Do: To-Do ^^^^^ Better documentation .. _Changelog: Changelog ^^^^^^^^^ - 2009-09-05, version 0.30, the extension works now with simulate static documents too. New fields added to the tables. - 2008-02-18, version 0.2.1, bugfix, if there were more than one attributes with the same price in a radio button group, only the first attribute was taken into the database. Now the attributes are selected via uid. - 2008-01-30, version 0.1.0, first public version - 2007-12-25, version 0.0.5, |img-14| EXT: event - 11 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. :border: 0 .. :height: 141 .. :id: Grafik1 .. :name: Grafik1 .. :width: 403 .. |img-2| image:: img-2.png .. :align: left .. :border: 0 .. :height: 535 .. :id: Grafik2 .. :name: Grafik2 .. :width: 669 .. |img-3| image:: img-3.png .. :align: left .. :border: 0 .. :height: 544 .. :id: Grafik3 .. :name: Grafik3 .. :width: 669 .. |img-4| image:: img-4.png .. :align: left .. :border: 0 .. :height: 438 .. :id: Grafik4 .. :name: Grafik4 .. :width: 669 .. |img-5| image:: img-5.png .. :align: left .. :border: 0 .. :height: 384 .. :id: Grafik5 .. :name: Grafik5 .. :width: 669 .. |img-6| image:: img-6.png .. :align: left .. :border: 0 .. :height: 73 .. :id: Grafik6 .. :name: Grafik6 .. :width: 194 .. |img-7| image:: img-7.png .. :align: left .. :border: 0 .. :height: 214 .. :id: Grafik7 .. :name: Grafik7 .. :width: 649 .. |img-8| image:: img-8.png .. :align: left .. :border: 0 .. :height: 722 .. :id: Grafik8 .. :name: Grafik8 .. :width: 468 .. |img-9| image:: img-9.png .. :align: left .. :border: 0 .. :height: 47 .. :id: Grafik9 .. :name: Grafik9 .. :width: 221 .. |img-10| image:: img-10.png .. :align: left .. :border: 0 .. :height: 295 .. :id: Grafik10 .. :name: Grafik10 .. :width: 446 .. |img-11| image:: img-11.png .. :align: left .. :border: 0 .. :height: 122 .. :id: Grafik11 .. :name: Grafik11 .. :width: 258 .. |img-12| image:: img-12.png .. :align: left .. :border: 0 .. :height: 370 .. :id: Grafik12 .. :name: Grafik12 .. :width: 461 .. |img-13| image:: img-13.png .. :align: left .. :border: 0 .. :height: 211 .. :id: Grafik13 .. :name: Grafik13 .. :width: 425 .. |img-14| image:: img-14.png .. :align: left .. :border: 0 .. :height: 32 .. :id: Graphic1 .. :name: Graphic1 .. :width: 102