oqapi/webgui
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add help docs for add/edit event, manage events and setHelp for both

Browse source 
in the Admin Console.  Straighten out which template variables go
with which template.
This commit is contained in:
Colin Kuskie 2006-02-20 22:43:58 +00:00
parent a991401a6a
commit 7b15e606c6
3 changed files with 194 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

9
lib/WebGUI/Asset/Wobject/EventManagementSystem.pm
View file

@ -395,10 +395,11 @@ sub getSubEventForm {
#
my $f = WebGUI::HTMLForm->new($self->session,-action=>$self->getUrl);
my $i18n = WebGUI::International->new('Asset_EventManagementSystem');
$f->hidden(-name=>"func",-value=>"www_addToCart");
$f->hidden(-name=>"method",-value=>"addSubEvents");
$f->readOnly(-value=>"You may also attend the following sub-events based on the events currently in your shopping cart.<br />");
$f->readOnly(-value=>$i18n->get('allowed sub events'));
$f->readOnly(-value=>"<table width='100%'>");
foreach my $subEvent (@$subEvents) {
while (my $eventData = $subEvent->hashRef) {
@ -630,7 +631,7 @@ sub www_editEvent {
-namespace => "EventManagementSystem_product",
-value => $self->session->form->get("templateId") || $event->{templateId},
-hoverHelp => $i18n->get('add/edit event template description'),
-label => "Event Template" #$i18n->get('add/edit event template')
-label => $i18n->get('add/edit event template')
);
$f->hidden(
@ -647,7 +648,7 @@ sub www_editEvent {
-name => "startDate",
-value => $self->session->form->get("startDate") || $event->{startDate},
-hoverHelp => $i18n->get('add/edit event start date description'),
-label => "Start Date" #$i18n->get('add/edit event start date')
-label => $i18n->get('add/edit event start date')
);
$f->dateTime(
@ -727,6 +728,7 @@ sub www_editEvent {
}
my $output = $f->print;
$self->getAdminConsole->setHelp('add/edit event','Asset_EventManagementSystem');
$self->getAdminConsole->addSubmenuItem($self->getUrl('func=manageEvents'),$i18n->get("manage events"));
my $addEdit = ($pid eq "new" or !$pid) ? $i18n->get('add', 'Wobject') : $i18n->get('edit', 'Wobject');
return $self->getAdminConsole->render($output, $addEdit.' '.$i18n->get('event'));
@ -857,6 +859,7 @@ sub www_manageEvents {
}
$output .= "</table>";
$self->getAdminConsole->setHelp('event management system manage events','Asset_EventManagementSystem');
$self->getAdminConsole->addSubmenuItem($self->getUrl('func=editEvent;pid=new'), $i18n->get('add event'));
return $self->getAdminConsole->render($output, $i18n->get("manage events"));
}

113
lib/WebGUI/Help/Asset_EventManagementSystem.pm
View file

@ -35,7 +35,11 @@ our $HELP = {
],
related => [
{
tag => 'event management system add/edit',
tag => 'event management system manage events',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'event management system template',
namespace => 'Asset_EventManagementSystem',
},
{
@ -49,6 +53,87 @@ our $HELP = {
],
},
'add/edit event' => {
title => 'add/edit event help title',
body => 'add/edit event help body',
fields => [
{
title => 'add/edit event title',
description => 'add/edit event title description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event description',
description => 'add/edit event description description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event price',
description => 'add/edit event price description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event template',
description => 'add/edit event template description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event start date',
description => 'add/edit event start date description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event end date',
description => 'add/edit event end date description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event maximum attendees',
description => 'add/edit event maximum attendees description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event required events',
description => 'add/edit event required events description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event operator',
description => 'add/edit event title description',
namespace => 'Asset_EventManagementSystem',
},
{
title => 'add/edit event what next',
description => 'add/edit event what next description',
namespace => 'Asset_EventManagementSystem',
},
],
related => [
{
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
],
},
'event management system manage events' => {
title => 'manage events',
body => 'manage events help body',
fields => [
],
related => [
{
tag => 'add/edit event',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
],
},
'event management system template' => {
title => 'template help title',
body => 'template help body',
@ -59,6 +144,10 @@ our $HELP = {
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'event management system event template',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
@ -66,6 +155,28 @@ our $HELP = {
],
},
'event management system event template' => {
title => 'event template help title',
body => 'event template help body',
fields => [
],
related => [
{
tag => 'event management system add/edit',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'event management system template',
namespace => 'Asset_EventManagementSystem',
},
{
tag => 'template language',
namespace => 'Asset_Template',
},
],
},
};
1; ##All perl modules must return true

94
lib/WebGUI/i18n/English/Asset_EventManagementSystem.pm
View file

@ -291,6 +291,11 @@ our $I18N = { ##hashref of hashes
context => q|Label to invite the user to purchase this event and add it to their shopping cart.|,
},
'allowed sub events' => {
message => q|You may also attend the following sub-events based on the events currently in your shopping cart.<br />|,
lastUpdated => 1140469381,
},
'template help title' => {
message => q|Event Management System Template|,
lastUpdated => 1140465899,
@ -308,24 +313,8 @@ This loop contains all events that have been approved so that users can register
<blockquote>
<p><b>title</b><br />
The title of this event.
</p>
<p><b>description</b><br />
The description of this event.
</p>
<p><b>price</b><br />
The price of this event.
</p>
<p><b>purchase.url</b><br />
A URL for the user to register for this event and add it to their shopping cart.
</p>
<p><b>purchase.label</b><br />
An internationalized label to dispaly to the user the link for purchasing this event.
<p><b>event</b><br />
The information for one event that has been processed by its own event template.
</p>
</blockquote>
@ -350,6 +339,75 @@ An internationalized label to dispaly to the user the link for managing events.
lastUpdated => 1140465899,
},
'event template help title' => {
message => q|Event Management System Event Template|,
lastUpdated => 1140465899,
},
'event template help body' => {
message => q|
<p>This template is used to display the contents of a single Event to the
user.</p>
<p><b>title</b><br />
The title of this event.
</p>
<p><b>description</b><br />
The description of this event.
</p>
<p><b>price</b><br />
The price of this event.
</p>
<p><b>purchase.url</b><br />
A URL for the user to register for this event and add it to their shopping cart.
</p>
<p><b>purchase.label</b><br />
An internationalized label to dispaly to the user the link for purchasing this event.
</p>
|,
lastUpdated => 1140471404,
},
'add/edit event help title' => {
message => q|Add/Edit Event|,
lastUpdated => 1140469726,
context => q|Title for Add/Edit Event Help|
},
'add/edit event help body' => {
message => q|
<p>In this form you will create an Event for sale on the site.
Each Event is very similar to a cross between a Product in the Product
Manager and an Event in the Events Calendar. You will give the Event
a title, description, price, a template for displaying the event to the user and when
the event starts and ends. There are also several Event Management System specific fields for
defining the maximum number of attendees, and if there are other events which are prerequisites
for this event.</p>
|,
lastUpdated => 1140470450,
context => q|Body for Add/Edit Event Help|
},
'manage events help body' => {
message => q|
<p>As the name implies, this screen allows you to manage the events in this instance
of the Event Management System.</p>
<p>The table of events will provide you with a quick overview of the events in the system,
by title, price and status (approved or pending approval). The icon bar for each event
allows you to edit events, delete events, or change their order.</p>
<p>The link, Add Event, will allow you to add new events.</p>
|,
lastUpdated => 1140475291,
context => q|Body for Add/Edit Event Help|
},
#If the help file documents an Asset, it must include an assetName key
#If the help file documents an Macro, it must include an macroName key
#For all other types, use topicName