Ace::Browser::AceSubs 1.91

Ace::Browser::AceSubs Perl module contains subroutines for AceBrowser.

SYNOPSIS

use Ace;
use Ace::Browser::AceSubs;
use CGI qw(:standard);
use CGI::Cookie;

my $obj = GetAceObject() || AceNotFound();
PrintTop($obj);
print $obj->asHTML;
PrintBottom();

Ace::Browser::AceSubs exports a set of routines that are useful for creating search pages and displays for AceBrowser CGI pages. See http://stein.cshl.org/AcePerl/AceBrowser.

The following subroutines are exported by default:

AceError
AceMissing
AceNotFound
Configuration
DoRedirect
GetAceObject
Object2URL
ObjectLink
OpenDatabase
PrintTop
PrintBottom
Url

The following subroutines are exported if explicitly requested:

AceAddCookie
AceInit
AceHeader
AceMultipleChoices
AceRedirect
DB_Name
Footer
Header
ResolveUrl
Style
Toggle
TypeSelector

To load the default subroutines load the module with:

use Ace::Browser::AceSubs;

To bring in a set of optionally routines, load the module with:

use Ace::Browser::AceSubs qw(AceInit AceRedirect);

To bring in all the default subroutines, plus some of the optional ones:

use Ace::Browser::AceSubs qw(:DEFAULT AceInit AceRedirect);

There are two main types of AceBrowser scripts:

display scripts

These are called with the CGI parameters b and b , corresponding to the name and class of an AceDB object to display. The subroutine GetAceObject() will return the requested object, or undef if the object does not exist.

To retrieve the parameters, use the CGI.pm param() method:

$name = param(name);
$class = param(class);
search scripts

These are not called with any CGI parameters on their first invocation, but can define their own parameter lists by creating fill-out forms. The AceBrowser system remembers the last search performed by a search script in a cookie and regenerates the CGI parameters the next time the user selects that search script.