Event Guide module


Summary
Event guide module will display event guidance and reservations for the event. The modules has functions as follows:
Using Steps
  1. Install this module
  2. XOOPS at [Admin Menu - System - Modules Admin] to install "event guide" module.
    module setup for event guide if you want. [Admin Menu - Event Guide - module setup]
  3. Register New event
  4. Write event guide document and register it. The reservation form can be changed afterwards.
  5. Event reservations
  6. Reservation list and Adminstrators can login with user permissions via the "Adminstration" link.
Functions
Event Registration and Display
  1. Show Summary Listed
  2. Blocks (Date and Title list)
  3. Show all (with reservation form)
  4. When user with Admin permission or event poster - will display administration links.
Event Edit
  1. New Event Registration - allow admin or setup group
  2. Reservations
Admin functions
  1. Event Configuration
  2. Event operations
  3. Notify new event registered users
Event Configuration
Event Guide module setup items as follow:
Itemvaluedescription
Group of Event Post Group (Regsiter Users) Set a group the owner permited to administration for own evnet.
Notify mail to Admin No/Yes/Always Notification mail to admin when Event registerd or updated. No = No notifcation. Yes = Notify except operation user. Always = Notify with operation user.
Admin Group for Notification Yes/No The group is received admin notification mail
Do you need to approve New Event Yes/No Need to approve New Event by site administrator
Display additional items in list field counts (3) Display items entry order additional form
Display list items in a page line counts (50) How many item lines in a page
Display events in top page Event counts (10) Number of listed events in top page
Show Multiple Entry Yes/No When event has multiple entry, show each entris. YES - display each entries. NO - Only show recenet entry.
User requested notification of new event Yes/No YES - Enable notification mail, NO - disable.
Event entry need to LOGIN No/Yes/Both Only login user can be reservation event (Not use email address). When select "Both", email address input field exist only guest user.
Has confirm page Yes/No Display confirm page when reservation submit
Additional item options (none) Additional item optional settings.
  • label_persons=label (label for multiple person reservation)
  • reply_tpl_suffix=suffix (suffix of reply mail template filename)
  • reply_extension=label (label for reply mail template extension)
  • export_charset=UTF-8 (using CSV output coding system)
  • size=60 (text input default size)
  • cols=40 (textarea default columns)
  • rows=5 (textarea default rows)
See "Additional item options" more details.
Close Time Before (min) 60 Event entry close time before setting minits.
Expire Time 1440 (was 1day, 24 hours) Event expired on top page when after event start time in minites.
Persons default value 10 Reservation persons in event post form
Date Foramt D, d M Y Open Event Date(Time) display format. Using PHP date function format.
Use Other moudle plugins Yes/No Internal Control accept entry form other modules
Current entry level mark 0,[Close]
50,[Empty]
100,[Many]
101,[Full]
The mark mean of how many entry in current. Show mark correspond parcentage. (xx,yy mean less than xx% showup yy. And '0,yy' mean out of date mark)
Time Table Labels (none) Set starting time in Settings collection page. e.g.: 08:00,14:00,16:00
Item List in export reservations * Item `name' or `number' seperated comma(,). Astarisk(*) mean left items. e.g.: 3,4,0,2,*
Allow Comments Yes/No Allow Comments for event

Following sets standard comment function in XOOPS

Additional item options
label_persons (label for multiple person reservation)
This option setting for a reservation accept multiple persons. Set item name(label) to input how many.

For example setting as "label_persons=Persons". In additional item like as "Persons,select,1,2,3,4" that make to recommand numeric choice field.

Only value setting in this config, Assume set for this "label_persons=" option. This is compatible before eguide 2.5.
reply_tpl_suffix (suffix of reply mail template filename)
Use for alternative reply mail template. Using filename added setting value for auto reply email. For example:
reply_tpl_suffix=A
mean using replay template language/<lang>/mail_template/{accept|order}A.tpl file. "reply_extension" for indirect by addition items value. In this variable set suffix to direct.
reply_extension (label for reply mail template extension)
This option using for switch reply mail tamplate.
This option setting item name(label) for template file name extension.

For example, setting in preferences "reply_extension=OrderForm", In Additional Items include like "OrderForm,hidden,A" field. This event reservation switch reply mail template file.

In this case(the value as "A") using template file name assume language/<lang>/mail_template/{accept|order}A.tpl and using it.

Additional value for file name, that is store value in reservation. In international using, recommand the value make alpha-numeric only. Because sometime there is encoding problem.
If there is no mail template in additional name, using default mail template.

export_charset (using CSV output coding system)
Default value as export_charset=UTF-8 (that is defined _MD_EXPORT_CHARSET resource)
size (text input default size)
Default value as size=60
cols, rows (textarea default columns/rows)
Default value as cols=40, rows=5
eguide_plugins (set active reservation plugins)
Set reservation control plugins name list. List name with comma(",") when multiple plugin use. When this option set disable module name plugins activate. You want module name plugin activate, include the name in this list.
use_fckeditor (use FCKeditor edit event description)
When this option setting, FCKeditor (HTML WYSIWYG editor) using in event edit page. You need install FCKeditor at XOOPS_URL/common/fckeditor/ folder. When setting value to "Basic", you can use simple toolbar.
bound_time (Bundary time as the last day)
The event start before stting this, display the day before date and more 24 hours (or 12 hours). Setting time format as "HH:MM".

For example, setting "bound_time=03:00", a event start "2009-12-15 01:00" to be display "2009-12-14 25:00". The bound time work correct from 00:01 to 11:59.

reply_subject (Reply mail subject)
from_name (Replay mail from name)
For reply mail by this module, override setting value. Default using define in language resource.
enable_copy (Enable copy funciton event article)
enable_copy=yes Add "New Event" checkbox when edit event article. When checked the checkbox to store that new event.
email_repeat_check (Enable confirm input Email Address)
email_repeat_check=yes When an application for the event, confirm email address to add a field to verify that it matches the address.
need_bind_uid (Force user setting when register reservation)
need_bind_uid=1 Need setup user when resister reservation by moderator/admin.
users_search_columns (Search columns when user selecting)
users_search_columns=uname,email Setup user for register reservation by moderator/admin. Searching/Display columns name list for users table joined by comma(,).
users_search_labels (Searching/Display column display labels)
users_search_columns=Username,EMAIL
enable_past_register=yes
Allow register to event which past closed date by moderator/admin. Default to stop register with display "Finish reservation" message.
Additional fields Format
In Reservation Additonal items set to FORM when used order to make reservation. These additional items are setup with the following formats:
line ::= ["!"]item-name["*"][,type[,argument...]]

type ::= {text|checkbox|radio|textarea|select|hidden|const}
argument ::= [value ["+"] "="] label

examples:
setupDisplayed form
Name*Name*
Name*,size=5Name*
Name*,size=10,value,#comment textName* comment text
Selection,radio,Item1+,Item2,Item3Selection Item1   Item2   Item3  
Selection,checkbox,Item1+,Item2,Item3Selection Item1   Item2   Item3  
Selection,select,Item1,Item2,Item3Selection
Label,const,valueLabel value (The value display and handle to input value)
Label,hidden,value(not display in form - present only input values)
#message textmessage text
Releated reservation forms
Mulitiple persons reservation
You want handle multiple persons reservation on a evnet, you need settings as following:
Redirect After Reservation URL
This is use when custom page display after reservation. That URL include following variables: {X_EID} (event id), {X_SUB} (event extra id), {X_RVID} (reservation id). This variables use handle to get event information. You can use for post processing reservations.
Reservation limit plugins

Event Guide module can use plugins for control reservations. It provide more complex contition for reservations. There is sample "dlimit" plugin that control same user can limited number of reservation in a day. Using this plugin reservation to need login.

This plugin activate set module preferences "Additional item options" add like following.

eguide_plugins=dlimit
max_register_in_day=1
max_register_in_future=2
eguide_plugins
Activate plugins. Comma seperated if multiple.
max_register_in_day
Number of reservation in a day. Default value is 1. No limitation as 0.
max_register_in_future
Number of total reservation in active event. A event to starting time has come when next reservation to be accept. Default value is 0 that is no limitation.
Handling for multiple open event

Event Guide handle the content of same event, open two or more times. This settings to "Repeat Open" in event registration form.

You want more detail settings, you send "Preview" one time. There is expand and edit more detail items.

In addition, the event is registered once to do detailed specification and it sets it on "Edit Open Date" page.

Note to multiple open event editing
Module Update
Module duplicate

eguide 2.4 later module is duplicatable (sorry not yet D3). There is command line utility proguram for duplicate module. "eguide/duplicate.php" is duplicate eguide module how many you want. (This command support only Unix-like system)

Example use this:

    $ cd modules/eguide
    $ php duplicate.php event ticket class
    Duplicate: event
    Duplicate: ticket
    Duplicate: class
  
Changes
2013/05/30 eguide 2.70 released
  • Not display cancel reservation form when past event time.
  • Use <label> tag in checkbox/radio type item.
  • Fix to show email field when guest and both accept mode.
  • Add option variable (enable_past_register), that allow register to event which past closed date
  • Register reservation bind for user account
2011/09/10 eguide 2.64 released
  • Fix notification email register/cancel not work
2010/10/10 eguide 2.63 released
  • Fix replace for month/week name by local language string (2.63a)
  • Add email confirm options (email_repeat_check)
  • Support altsys language manager
  • Fix miscalculate in reservation summary
  • Fix redirect_header out absolute path (for mobile)
2010/05/16 eguide 2.62 released
  • Fix version string (2.62a)
  • Enable localization for month name in event date
  • Fix block function conflict when module duplicated
  • Fix Excel(XML) format malfunction over 40 records
2010/04/04 eguide 2.61 released
  • Show reservation data when cancel confirm
  • Add language/portuguese resouces (thx leco1)
  • Add select option "Both" for "Event entry need to LOGIN" in preferences
  • Remove limitation for excel(XML) format download.
2010/02/27 eguide 2.6 released
  • add list type select in block options
  • change admin.php form to hide some fields
  • fix new event notification email tags not set
  • option variables "reply_tpl_suffix" added
  • redirect make to handle option variables
  • add description for "Reservation limit plugins" in help.html
  • add blocks for expired event
  • add for "dlimit" plugins to limit total reservations (max_register_in_future)
  • Reservation button label to change by action
  • Allow {X_NAME} replace by user varibale
  • add option variable "module_css" for assign module local stylesheet
2009/12/24 eguide 2.56 released
  • fix EVENT_TITLE mail variable setting
  • dlimit plugins support bound_time options
  • blocks support bound_time
  • add enable_copy options
2009/12/20 eguide 2.55 released
  • More "Additional item options"
    • bound_time=01:00 -- Bound time as last day
    • reply_subject=Subject -- Replay email subject
    • from_name=Sender -- Reply from name
  • Email subject redefine with email vars.
  • Reply email variable EVENT_DATE defined
2009/10/04 eguide 2.54 released
  • Time Table Labels apply to event date time selection
  • FCKeditor (use_fckeditor={Basic|Default}) option added
  • fix cancel page for new event mail notification
  • fix in additional item at printable comment with comma
  • event editing start time accept "HH:MM" format
  • reservation control plugins control by option variable
  • fix my reservation page ancker mistake
  • fix block descption edit style mistake
  • fix mutiple date editing template
2009/05/24 eguide 2.53 released
  • Add context value for XOOPS Search module (thx tes)
  • Add description to variable in block template
2009/03/09 eguide 2.52 released
  • Describe more "REFERER errors" in reservation failer.
  • Add detail show reservation. (thx uhouho)
  • Fix repeat opening event mistake datetime. (thx uhouho)
2009/03/09 eguide 2.52 released
  • Describe more "REFERER errors" in reservation failer.
  • Add detail show reservation. (thx uhouho)
  • Fix repeat opening event mistake datetime. (thx uhouho)
2008/10/19 eguide 2.51 released
  • Add {RVID} tags in reply mail template (accept.tpl)
  • Add CSV output coding system options (export_charset)
  • follow altsys 0.6 template/blocks admin
  • Revised Admin Interface by Gigamaster
  • Fix category image field not stored (thx Gigamaster)
  • Fix event active editing not work in admin list (thx Gigamaster)
  • Assign category discription in smarty variable
2008/07/22 eguide 2.5 released
  • Add item options "reply_extension" as switch reply mail template
  • Apply "Additional item options" in defaults
  • Change preferences "Label of persons" to "Additional item options"
  • Not display category select button if there is no categires
  • Add no data language resources for admin page
  • Fix using template set mistake.
2008/02/16 eguide 2.42 released
  • fix checkbox failer
  • Add addtional field input helper (JavaScript)
  • Fix admin menu link
2008/02/11 eguide 2.41 released
  • Fix conflict with pico module
2008/02/05 eguide 2.4 released
  • Categories enhancement (two level, sort order, importer, block)
  • Fix JavaScript check failer
  • Enable confirm page in default
  • Add duplicatable function
  • Fix excel template (remove hard code kanji)
  • Using newer altsys (0.5later) function
  • Arrangement of language resource (Separation main/common)
  • add resource language/spanish (thx Gerardo)
2007/12/31 eguide 2.31 released
  • text field quote(') handle bug fixed
  • add const type
  • variables handle in redirect URL
  • multiple category selecting in index.php (e.g. cat=1,2,3)
  • fix JavaScript mistake (thx souhalt)
  • fix rendering mistake when occurrence errors (thx souhalt)
  • Ignore mail sending status except reservation user
  • Using altsys module when exists
  • Internal Reservation data format changes (refactoring)
  • Fix extra date editing failer when after start time (thx Jens)
  • add breadcrumbs (xoops_breadcrumbs) smarty variable setting
2007/03/03 eguide 2.3 released
  • Add setting notifiy to operation user self.
  • Add update notification to admin with poster
  • fix stop admin mail when disable setting in preference
  • fix notification mail for register users
  • eguide 2.24 released
  • fix compat in PHP5/MySQL5 (mylist.php failer, etc)
  • fix complex value-label behavier item in checkbox/radio
  • update tchinese resources (thanks jax)
  • suppress space(nbsp) when setting value at additional items typed checkbox/radio
2006/10/14 eguide 2.23 released
  • fix month name index typo in japanese/german/tchinese
2006/10/14 eguide 2.21 released
  • fix some language resources
  • add language/tchinese resources (by jimmy9522 at twpug.net)
  • fix poster uname mistake when summary CSV output
2006/08/29 eguide 2.2 released
  • make display simple uname CSV format output
  • add category filter in blocks
  • add filling mark in block when show details
  • new event block shows next event in multiple
  • fix template: not display _MD_RESERV_FORM (as "Reservation Here") when reservation disable
  • add language/german resources (from Jens Havelberg)
2006/08/17 eguide 2.1 released
  • add redirect url setting after reservation
  • revised escape in additional items and extent "prop" attribute (from Craig Taylor)
  • fix template: not display close time when reservation disable
2006/08/13 eguide 2.01 released
  • fix mistake resources
  • fix cancel failer when login user do cancel
2006/08/03 eguide 2.0 released

Changes before 2.0

Nobuhiro Yasutomi <nobuhiro.yasutomi@nifty.ne.jp>
MySite Users http://myht.org/
$Id: help.html,v 1.70 2011/09/10 02:45:21 nobu Exp $