From 13d5ab6f4af827d85a4fb2cdfde29b5004dacaa9 Mon Sep 17 00:00:00 2001 From: Colin Kuskie Date: Thu, 20 Apr 2006 23:12:22 +0000 Subject: [PATCH] template documentation and i18n for EMS --- .../Asset/Wobject/EventManagementSystem.pm | 2 +- .../Help/Asset_EventManagementSystem.pm | 38 +++ .../English/Asset_EventManagementSystem.pm | 259 +++++++++++++++++- 3 files changed, 297 insertions(+), 2 deletions(-) diff --git a/lib/WebGUI/Asset/Wobject/EventManagementSystem.pm b/lib/WebGUI/Asset/Wobject/EventManagementSystem.pm index 1c9c14d25..a58ae9bef 100644 --- a/lib/WebGUI/Asset/Wobject/EventManagementSystem.pm +++ b/lib/WebGUI/Asset/Wobject/EventManagementSystem.pm @@ -2557,7 +2557,7 @@ sub www_search { WebGUI::Form::hidden($self->session,{name => "cfilter_t0", value => $self->session->form->get("cfilter_t0")}); $var{isAdvSearch} = $self->session->form->get('advSearch'); $var{'search.formFooter'} = WebGUI::Form::formFooter($self->session); - $var{'search.formSubmit'} = WebGUI::Form::submit($self->session, {value=>'Filter'}); + $var{'search.formSubmit'} = WebGUI::Form::submit($self->session, {value=>$i18n->get('filter')}); my $searchUrl = $self->getUrl("func=view"); my $formVars = $self->session->form->paramsHashRef(); foreach ($self->session->form->param) { diff --git a/lib/WebGUI/Help/Asset_EventManagementSystem.pm b/lib/WebGUI/Help/Asset_EventManagementSystem.pm index bd5d05203..c8e9722b1 100644 --- a/lib/WebGUI/Help/Asset_EventManagementSystem.pm +++ b/lib/WebGUI/Help/Asset_EventManagementSystem.pm @@ -291,6 +291,44 @@ our $HELP = { ], }, + 'ems view purchase template' => { + title => 'view purchase template help title', + body => 'view purchase template help body', + fields => [ + ], + related => [ + { + tag => 'event management system add/edit', + namespace => 'Asset_EventManagementSystem', + }, + { + tag => 'event management system asset variables', + namespace => 'Asset_EventManagementSystem', + }, + { + tag => 'template language', + namespace => 'Asset_Template', + }, + ], + }, + + + 'ems search template' => { + title => 'search template help title', + body => 'search template help body', + fields => [ + ], + related => [ + { + tag => 'event management system add/edit', + namespace => 'Asset_EventManagementSystem', + }, + { + tag => 'template language', + namespace => 'Asset_Template', + }, + ], + }, }; diff --git a/lib/WebGUI/i18n/English/Asset_EventManagementSystem.pm b/lib/WebGUI/i18n/English/Asset_EventManagementSystem.pm index 90b3d925b..7e4070499 100644 --- a/lib/WebGUI/i18n/English/Asset_EventManagementSystem.pm +++ b/lib/WebGUI/i18n/English/Asset_EventManagementSystem.pm @@ -516,7 +516,7 @@ If the event is full, the url will be blank. the user can manage their purchases.

purchasesLoop
-This loop contains all events that have been approved so that users can register. +This loop contains all events that have been approved so that users can view their purchases.

@@ -538,6 +538,257 @@ An internationalized label to title this screen. lastUpdated => 1145465299, }, + 'view purchase template help title' => { + message => q|EMS View Purchases Template|, + lastUpdated => 1140465899, + }, + + 'view purchase template help body' => { + message => q| +

This template is used to style the screen of the Event Management System where +the users and admins can view or edit a purchase.

+ +

In addition to the template variables below, this template also has access to the +EMS Asset variables.

+ +

purchasesLoop
+This loop contains all events that are included in this purchase. +

+ +
+ +

startDateHuman
+This event's start date and time in a human readable format. +

+ +

endDateHuman
+This event's end date and time in a human readable format. +

+ +

startDate
+This event's start date and time in epoch format. +

+ +

endDateHuman
+This event's end date and time in epoch format. +

+ +

registrationId
+The user's registrationId for this event. +

+ +

title
+The title of this event. +

+ +

description
+The description of this event. +

+ +

price
+The price of this event. +

+ +

templateId
+The template used to style this event if it is to be displayed. +

+ +

returned
+A boolean that will be 1 if this event has been returned by the user. +

+ +

approved
+A boolean that will be 1 if this event has been approved. +

+ +

templateId
+The template used to style this event if it is to be displayed. +

+ +

maximumAttendees
+The number of people allowed to attend this event. +

+ +
+ +

viewPurchaseTitle
+An internationalized label to title this screen. +

+ +

canReturn
+A boolean indicating if the current user may return events in the purchase. +

+ +

transactionId
+The unique identifier for this transaction in the database. +

+ +

canAddEvents
+A boolean indicating if the current user can add events to this purchase. +

+ +

appUrl
+A URL back to the main screen of the Asset. +

+ +|, + lastUpdated => 1145465299, + }, + + 'search template help title' => { + message => q|EMS Search Template|, + lastUpdated => 1140465899, + }, + + 'search template help body' => { + message => q| +

This template is used to style the screen of the Event Management System where +the users and admins can view or edit a purchase.

+ +

basicSearch.formHeader
+Form header for a basic search. +

+ +

advSearch.formHeader
+Form header for an advanced search. +

+ +

isAdvSearch
+Boolean indicating if an advanced search form has been requested. +

+ +

search.formFooter
+Form footer code for either type of search. +

+ +

search.formSubmit
+A button to submit the user's search data. The button will contain the internationalized word "Filter". +

+ +

events_loop
+This loop contains all events that have been approved so that users can register. +

+ +
+ +

event
+The information for one event that has been processed by its own event template. +

+ +

title
+The title of this event. +

+ +

description
+The description of this event. +

+ +

price
+The price of this event. +

+ +

numberRegistered
+The number of people currently registered for this event. +

+ +

maximumAttendees
+The number of people allowed to attend this event. +

+ +

seatsRemaining
+The number of available seats remaining for this event. +

+ +

startDate.human
+The date and time this event starts, in human readable format. +

+ +

endDate.human
+The date and time this event ends, in human readable format. +

+ +

eventIsFull
+A boolean that is true if the there are no available seats remaining in this event. +

+ +

purchase.label
+An internationalized label to display to the user the link for purchasing this event. +If the event is full, the label will be "Sold out". +

+ +

purchase.url
+A URL for the user to register for this event and add it to their shopping cart. +If the event is full, the url will be blank. +

+ +
+ +

checkout.url
+A URL to take the user the screen that displays the contents of their shopping cart. +

+ +

checkout.label
+A label to go with checkout.url. The internationalized word "Checkout". +

+ +

paginateBar
+A bar to help the user page through sets of Events if several pages of Events exist. +

+ +

Pagination variables
+Common pagination template variables. +

+ +

canManageEvents
+A flag to indiciate if the current user is allowed to Manage Events. +

+ +

manageEvents.url
+A URL to take the user to the screen where Events can be managed (i.e. added, approved, deleted) +

+ +

manageEvents.label
+An internationalized label to dispaly to the user the link for managing events. +

+ +

managePurchases.url
+A URL to take the user to the screen where purchases can be managed (i.e. added, approved, deleted) +

+ +

managePurchases.label
+An internationalized label to dispaly to the user the link for managing purchases. +

+ +

noSearchDialog
+A boolean that indicates if the user has requested that no search dialog be presented +by setting the "hide" form variable. +

+ +

addEvent.url
+A URL to take the user to the screen to add a new event. +

+ +

addEvent.label
+An internationalized label to dispaly to the user the link for adding an event. +

+ +

search.filters.options
+Javascript for a search interface for Events based on their properties and metadata. +

+ +

search.data.url
+The URL to this Asset. +

+ +

ems.wobject.dir
+The URL the EventManagementSystem area in the WebGUI Extras directory. +

+ +|, + lastUpdated => 1145465299, + }, + + 'ems asset help title' => { message => q|EMS Asset Template Variables|, lastUpdated => 1140465899, @@ -725,6 +976,12 @@ allows you to edit events, delete events, or change their order.

lastUpdated => 1145402683, }, + 'filter' => { + message => q|Filter|, + lastUpdated => 1145402683, + context => q|Button in search form to limit displayed events based on user criteria|, + }, + }; 1;