.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "EMBOSS::GUI 3pm"
.TH EMBOSS::GUI 3pm 2024-02-25 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
EMBOSS::GUI \- provide web\-based access to EMBOSS
.SH AUTHOR
.IX Header "AUTHOR"
Luke McCarthy <lukem@gene.pbi.nrc.ca>
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  use EMBOSS::GUI;
\&
\&  $emboss = EMBOSS::GUI\->new();
\&  
\&  $emboss\->intro_page;
\&  $emboss\->about_page;
\&  $emboss\->menu_page;
\&  $emboss\->app_page;
\&  $emboss\->help_page;
\&  $emboss\->default_page;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
EMBOSS::GUI provides a simple web-based interface to the EMBOSS suite of
bioinformatics tools.  The distribution should have included a sample CGI
script that wraps the module appropriately.
.PP
Alternatively, EMBOSS::GUI can be used to gather information about the local
EMBOSS installation.  Public methods for that purpose are described below:
.IP new(%args) 4
.IX Item "new(%args)"
Returns a new EMBOSS::GUI object.
.Sp
\&\f(CW%args\fR is a hash of optional named arguments.  The following arguments are
\&\f(CW%recognized:\fR
.RS 4
.ie n .IP "html => $object" 4
.el .IP "html => \f(CW$object\fR" 4
.IX Item "html => $object"
Specifies an alternative HTML renderer object to use when generating the web
interface.  See EMBOSS::GUI::XHTML for the methods the replacement object must
implement.
.RE
.RS 4
.RE
.IP \fBgo()\fR 4
.IX Item "go()"
Process CGI arguments and display the corresponding page.
.IP \fBintro_page()\fR 4
.IX Item "intro_page()"
Generates an introductory page describing EMBOSS and the GUI.
.IP \fBabout_page()\fR 4
.IX Item "about_page()"
Generates a page describing the local EMBOSS configuration, including the
version and filesystem location of each perl module required by the GUI.
.IP \fBmenu_page()\fR 4
.IX Item "menu_page()"
Generates the main menu page.
.IP \fBapp_page()\fR 4
.IX Item "app_page()"
Generates the application-specific input page or runs an EMBOSS application
and generates the output page.
.IP \fBhelp_page()\fR 4
.IX Item "help_page()"
Generates the application-specific manual page.
.IP \fBoutput_page()\fR 4
.IX Item "output_page()"
Generates the application output page, or a placeholder page if the application is still running.
.IP \fBdefault_page()\fR 4
.IX Item "default_page()"
Generates a default page according to the current configuration.
.IP \fBframeset_page()\fR 4
.IX Item "frameset_page()"
Generates a page that sets up the menu and main content frames.
.IP \fBapps()\fR 4
.IX Item "apps()"
Returns a list of available EMBOSS applications.  Each element of the list is
a reference to an array containing the name and description of an application.
.IP \fBgroups()\fR 4
.IX Item "groups()"
Returns a list of application groups.  Each element of the list is a reference
to an array containing the name of the group and a list of applications
belonging to that group (each application is in turn a reference to an array
as described in \fBapps()\fR above.)  Note that an individual application can appear
in multiple groups.
.IP is_excluded($subject) 4
.IX Item "is_excluded($subject)"
Returns true if the subject is being excluded from public display, false
otherwise.
.Sp
\&\f(CW$subject\fR is the name of an application or application group as it appears in
the output from wossname.
.IP \fBdatabases()\fR 4
.IX Item "databases()"
Returns a list of available databases.  Each element of the list is the name
of a database, suitable for use in a USA.
.SH BUGS
.IX Header "BUGS"
None that I know of...
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2004 Luke McCarthy.  All rights reserved.  This program is free
software.  You may copy or redistribute it under the same terms as Perl itself.